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] spm intalltion docs show wrong setup for file_roots #61726

Closed
whytewolf opened this issue Feb 25, 2022 · 5 comments · Fixed by #62944
Closed

[DOCS] spm intalltion docs show wrong setup for file_roots #61726

whytewolf opened this issue Feb 25, 2022 · 5 comments · Fixed by #62944
Assignees
Labels
Documentation Relates to Salt documentation good first issue good for someone new to salt help-wanted Community help is needed to resolve this severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-quick-fix

Comments

@whytewolf
Copy link
Contributor

Description

the docs at https://docs.saltproject.io/en/latest/topics/spm/master.html#update-file-roots show file_roots with numbered lines instead of the list indicator.

file_roots:
  base:
    1. /srv/salt
    2. /srv/spm/salt

Suggested Fix
That should be

file_roots:
  base:
    - /srv/salt
    - /srv/spm/salt

Type of documentation
Salt documentation example

Location or format of documentation
https://docs.saltproject.io/en/latest/topics/spm/master.html#update-file-roots

@whytewolf whytewolf added Documentation Relates to Salt documentation needs-triage labels Feb 25, 2022
@barbaricyawps barbaricyawps added time-estimate-quick-fix good first issue good for someone new to salt help-wanted Community help is needed to resolve this severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around and removed needs-triage labels Feb 28, 2022
@ccrvlh
Copy link

ccrvlh commented Mar 31, 2022

@whytewolf up for grab? I can help.

@whytewolf
Copy link
Contributor Author

@lowercase00 yes please. I almost completely forgot about this issue myself.

@ccrvlh
Copy link

ccrvlh commented Apr 21, 2022

@whytewolf sure, I'll go through some docs issues to try to fix the easy stuff.

@ccrvlh ccrvlh mentioned this issue Apr 23, 2022
3 tasks
@ccrvlh
Copy link

ccrvlh commented Apr 23, 2022

@whytewolf first PR, would be great if you could take a look if the flow was correct: #61979
thanks!

@barbaricyawps
Copy link
Contributor

I think @lowercase00 's PR with this fix was closed because the maintainers asked to remove the changelog fix and didn't. So it was closed because of a lack of a response. I've recreated the fix for this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to Salt documentation good first issue good for someone new to salt help-wanted Community help is needed to resolve this severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-quick-fix
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants