[DOCS] The examples of states.ssh_auth use the parameter "names" but this parameter is never explained in the doc
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
The examples of states.ssh_auth use the parameter "names" but this parameter is never explained in the doc.
Also, if the names parameter is used with a list of keys only the last one is added to the authorized_keys file.
So either the example is wrong or a description is missing.
Suggested Fix
Either rewrite the exmaples or include the names parameter in the state description.
Type of documentation
Salt documentation
Location or format of documentation
https://docs.saltproject.io/en/latest/ref/states/all/salt.states.ssh_auth.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
Start at the Salt states.ssh_auth documentation page linked in the issue and compare the examples with the state description. Verify how the names parameter behaves with multiple keys, then update the examples or description so its use is accurate and explicitly explained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100