Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for secrets in CLI #98

Merged
merged 10 commits into from
Feb 1, 2024

Conversation

bryannho
Copy link
Contributor

@bryannho bryannho commented Jan 31, 2024

  • Added Defining environment variables section in cli.md to document support for secrets. Instructs users on how to configure secrets using .env file and deploy the project. Also links to env_vars.md for instructions on how to access and verify secrets from their application
  • Added a note in env_vars.md that directs users to cli.md if they want to configure environment variables there

Related PR: https://github.com/ploomber/cli/pull/33


📚 Documentation preview 📚: https://ploomber-doc--98.org.readthedocs.build/en/98/

@bryannho bryannho marked this pull request as ready for review January 31, 2024 21:02
@bryannho
Copy link
Contributor Author

@edublancas added some documentation on secrets in cli.md. There was already sample code in env_vars.md that checks if a given env var is defined and returns a response, so I just linked to it. The docs build is giving errors when linking to specific sections in other pages, so I just linked to the other page as a whole. Let me know if it's clear enough

doc/user-guide/cli.md Outdated Show resolved Hide resolved
doc/user-guide/cli.md Outdated Show resolved Hide resolved
doc/user-guide/cli.md Outdated Show resolved Hide resolved
doc/user-guide/cli.md Outdated Show resolved Hide resolved
@bryannho bryannho requested a review from edublancas February 1, 2024 00:25
@edublancas edublancas merged commit 194f85c into ploomber:main Feb 1, 2024
1 check passed
@bryannho bryannho deleted the support-secrets-cli branch February 1, 2024 02:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants