docs: add new internals pages for secret, variable and env creation + cli docs for secret and variables

[Allan2000-Git]

User description

Description

This PR adds new pages under the Internals section to support the creation of:

1. Secrets
2. Variables
3. Environments

This PR also adds cli docs for secrets & variables

Fixes #1196

Dependencies

N/A

Future Improvements

N/A

Mentions

@rajdip-b

Screenshots of relevant screens

N/A

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

---

PR Type

Documentation

---

Description

• Add comprehensive CLI documentation for secret and variable commands

• Create detailed internals guides for secrets, variables, and environments

• Enhance getting started guide with links to comprehensive documentation

• Document all supported functionalities and best practices for each feature

---

Diagram Walkthrough

flowchart LR
  CLI["CLI Commands<br/>secret & variable"]
  Internals["Internals Guides<br/>secrets, variables,<br/>environments"]
  GettingStarted["Getting Started<br/>Guide Updates"]
  Users["Users"]
  
  Users -- "Learn CLI usage" --> CLI
  Users -- "Understand concepts" --> Internals
  Users -- "Quick links" --> GettingStarted
  GettingStarted -- "References" --> Internals

Loading

File Walkthrough

Relevant files

Documentation

secret.md Complete CLI documentation for secret command                        docs/cli/secret.md New file documenting all secret command subcommands (create, delete, disable, enable, list, revisions, rollback, update) Includes usage syntax, arguments, options, and practical examples for each subcommand Covers secret management operations like rotation, environment-specific handling, and versioning +335/-0  variable.md Complete CLI documentation for variable command                    docs/cli/variable.md New file documenting all variable command subcommands (create, delete, disable, enable, list, revisions, rollback, update) Includes usage syntax, arguments, options, and practical examples for each subcommand Covers variable management operations including versioning and environment-specific handling +317/-0  secrets.md Comprehensive internals guide for secrets management          docs/internals/secrets.md New comprehensive guide explaining what secrets are and their key characteristics Documents 10 supported functionalities including creation, retrieval, updates, version management, rotation, and security features Includes best practices for naming, environment management, access control, and security Provides troubleshooting guidance and links to related documentation +277/-0  variables.md Comprehensive internals guide for variables management      docs/internals/variables.md New comprehensive guide explaining what variables are and their key characteristics Documents 8 supported functionalities including creation, retrieval, updates, version management, and integration features Includes best practices for naming, environment management, access control, and configuration Provides troubleshooting guidance and links to related documentation +236/-0  environments.md Comprehensive internals guide for environments management docs/internals/environments.md New comprehensive guide explaining what environments are and their key characteristics Documents 8 supported functionalities including creation, management, access control, configuration, integration, monitoring, lifecycle management, and backup/recovery Includes best practices for naming conventions, organization, access control, and security Provides troubleshooting guidance and links to related documentation +254/-0  adding-your-first-secret-and-variable.md Add documentation links to getting started guide                  docs/getting-started/adding-your-first-secret-and-variable.md Add informational callout linking to comprehensive Environments documentation after project creation section Add informational callout linking to comprehensive Secrets documentation after secret creation section Add informational callout linking to comprehensive Variables documentation after variable creation section Enhances user experience by providing easy access to detailed documentation at relevant points +6/-0

---

[codiumai-pr-agent-free]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🟢	🎫 #1196 🟢 Create a section in the docs explaining how to create and manage environments in Keyshade Fix the issue where "How to create environments?" option points to a page that only explains secrets and variables
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
⚪	No custom compliance provided Follow the guide to enable custom compliance check.
Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	✅ Correct unit for rotation duration Suggestion Impact: The commit directly implemented the suggestion by changing the documentation to correctly state that the rotation duration is in hours, not days, and adding clarification about what the hour values correspond to in days code diff: -The duration in days after which the value of the secret should be rotated. Accepted values are `24`, `168`, `720`, `8760` and `never`. Defaults to `never`. +The duration in hours after which the value of the secret should be rotated. Accepted values are `24` (1 day), `168` (7 days), `720` (30 days), `8760` (365 days) and `never`. Defaults to `never`. Correct the unit for the --rotate-after option from "days" to "hours" in the documentation. Clarify that the accepted values correspond to hours in 1, 7, 30, and 365 days. docs/cli/secret.md [52-54] #### `-r, --rotate-after <string>` -The duration in days after which the value of the secret should be rotated. Accepted values are `24`, `168`, `720`, `8760` and `never`. Defaults to `never`. +The duration in hours after which the value of the secret should be rotated. Accepted values are `24` (1 day), `168` (7 days), `720` (30 days), `8760` (365 days) and `never`. Defaults to `never`. [Suggestion processed] Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies a factual error in the documentation where the unit for rotate-after is stated as days instead of hours, which could lead to user confusion and misconfiguration.	Low
	Remove broken links to documentation Remove the broken link to ../cli/environment.md in docs/internals/environments.md. The target file does not exist in the PR, and the link would result in a "404 Not Found" error. docs/internals/environments.md [114] -For detailed CLI commands, see the [CLI Environment Commands](../cli/environment.md) documentation. +For detailed CLI commands, see the CLI documentation for environments. Apply / Chat Suggestion importance[1-10]: 4 __ Why: The suggestion correctly identifies multiple broken links to a non-existent file (environment.md), which would degrade the user experience. Fixing this improves the quality of the documentation.	Low
General	✅ Align example with naming conventions Suggestion Impact: The commit directly implemented the suggestion by changing the example command from using 'My Secret' to 'MY_NEW_SECRET', aligning with the recommended naming convention code diff: -keyshade secret update secret-1 --name "My Secret" --note "This is a secret" +keyshade secret update secret-1 --name "MY_NEW_SECRET" --note "This is a secret" Update the example for updating a secret's name to use the UPPERCASE_WITH_UNDERSCORES convention, as recommended in the best practices documentation. Change "My Secret" to "MY_NEW_SECRET". docs/cli/secret.md [327-328] # Update secret's name and note -keyshade secret update secret-1 --name "My Secret" --note "This is a secret" +keyshade secret update secret-1 --name "MY_NEW_SECRET" --note "This is a secret" [Suggestion processed] Suggestion importance[1-10]: 5 __ Why: The suggestion correctly points out that an example command contradicts the naming conventions documented elsewhere in the PR. Aligning the example improves consistency and reinforces best practices for users.	Low
Update

[rajdip-b]

🎉 This PR is included in version 2.40.1-stage.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[rajdip-b]

🎉 This PR is included in version 2.41.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀