[DOC]: Salt CLI doc is outdated
Open
Nobody has claimed this yet.
Confirmed
doc-rework
documentation
severity-low
time-estimate-sprint
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
As I looked for the --failhard option in the Salt CLI docs I noticed it is totally outdated.
I believe the --failhard option is available for a long time. Expectation is to have the same output from the salt --help command in the docs as well.
Contributor guide
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
Start with the Salt CLI documentation linked in the issue and run salt --help to compare the current output with the published options. Update the CLI docs so they include options such as --failhard and match the command output, then verify the documented list against salt --help.
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
- Clearly specified
- Newbie friendliness
- 38/100