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

[DOCS] The examples of states.ssh_auth use the parameter "names" but this parameter is never explained in the doc #61587

Open
iils-jschmidt opened this issue Feb 7, 2022 · 2 comments
Labels
doc-param-missing parameters are missing in the docs Documentation Relates to Salt documentation severity-high 2nd top severity, seen by most users, causes major problems time-estimate-sprint

Comments

@iils-jschmidt
Copy link

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

@iils-jschmidt iils-jschmidt added Documentation Relates to Salt documentation needs-triage labels Feb 7, 2022
@welcome
Copy link

welcome bot commented Feb 7, 2022

Hi there! Welcome to the Salt Community! Thank you for making your first contribution. We have a lengthy process for issues and PRs. Someone from the Core Team will follow up as soon as possible. In the meantime, here’s some information that may help as you continue your Salt journey.
Please be sure to review our Code of Conduct. Also, check out some of our community resources including:

There are lots of ways to get involved in our community. Every month, there are around a dozen opportunities to meet with other contributors and the Salt Core team and collaborate in real time. The best way to keep track is by subscribing to the Salt Community Events Calendar.
If you have additional questions, email us at saltproject@vmware.com. We’re glad you’ve joined our community and look forward to doing awesome things with you!

@whytewolf
Copy link
Collaborator

this is one of those things that needs to be better documented in the docs.

- names is actually a higher level function more akin to requisites. the documentation for it is at https://docs.saltproject.io/en/latest/ref/states/highstate.html#names-declaration

@barbaricyawps barbaricyawps added doc-param-missing parameters are missing in the docs severity-high 2nd top severity, seen by most users, causes major problems time-estimate-sprint and removed needs-triage labels Feb 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-param-missing parameters are missing in the docs Documentation Relates to Salt documentation severity-high 2nd top severity, seen by most users, causes major problems time-estimate-sprint
Projects
None yet
Development

No branches or pull requests

4 participants