micado-scale / micado-scale/docs
Update documentation to include --vault usage with micado up CLI
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
Currently, the documentation does not explain how to use the --vault flag when deploying MiCADO via the CLI using micado up.
Request:
Please update the documentation to include:
A brief explanation of what the --vault flag does.
When and why a user would use --vault (e.g., for injecting secrets securely).
Any required preconditions (e.g., Vault must already be set up and running).
A CLI example showing how to run the deployment with the --vault flag.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the documentation entry point for the micado up CLI and search for existing Vault guidance. Add an explanation of --vault, when and why to use it, required Vault setup, and a deployment example; done means all four requested points are documented clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100