[DOCS] salt-key man + docs page inconsistent with --help
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
Since https://github.com/saltstack/salt/commit/77b7364ade6b91dc68ef7972232fd608faa3d32d
the salt-key CLI has been updated to support --include-accepted, --include-rejected, and --include-denied flags for accept/reject seemingly intending to supplant --include-all. However, the docs and man page do not have any references to these added flags.
Suggested Fix
The man page and doc page should document the CLI as it exists in the version it relates to (presumably by adding the new flags and noting --include-all's deprecation).
Type of documentation
man page and docs page
Location or format of documentation
man salt-key
https://docs.saltproject.io/en/master/ref/cli/salt-key.html
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
Compare the man salt-key page and the salt-key documentation at https://docs.saltproject.io/en/master/ref/cli/salt-key.html with the CLI's --help output. Document --include-accepted, --include-rejected, and --include-denied, and note the deprecation of --include-all where appropriate. Done means both documentation locations match the supported CLI options.
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
- 35/100