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

Messed up module documentation #52000

Closed
OrangeDog opened this issue Mar 6, 2019 · 7 comments
Closed

Messed up module documentation #52000

OrangeDog opened this issue Mar 6, 2019 · 7 comments
Assignees
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation fixed-pls-verify fix is linked, bug author to confirm fix P1 Priority 1 severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around
Milestone

Comments

@OrangeDog
Copy link
Contributor

https://docs.saltstack.com/en/2018.3/ref/modules/all/salt.modules.service.html

There are 6 modules (group, kernelpkg, pkg, service, shadow, user) duplicated at the top of the list, and half the service modules have been renamed (launchctl, smf, systemd, upstart) so the links don't work.

screenshot

@twangboy
Copy link
Contributor

twangboy commented Mar 6, 2019

@jacobhammons @newwebash ^^^

@newwebash
Copy link
Contributor

I'm tagging @KChandrashekhar and @Ch3LL since they're more familiar with the open Salt docs and processes than I am.

@Ch3LL
Copy link
Contributor

Ch3LL commented Mar 6, 2019

i can definitely fix up the services issue, but I'm not quit sure what you mean by "There are 6 modules (group, kernelpkg, pkg, service, shadow, user) duplicated at the top of the list," I think you are referencing the virtual models? That should stay as we are documenting which of these modules are virtual modules

@Ch3LL Ch3LL added Documentation Relates to Salt documentation Bug broken, incorrect, or confusing behavior severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around P1 Priority 1 labels Mar 6, 2019
@Ch3LL Ch3LL self-assigned this Mar 6, 2019
@garethgreenaway garethgreenaway added this to the Approved milestone Mar 7, 2019
@OrangeDog
Copy link
Contributor Author

OrangeDog commented Mar 14, 2019

@Ch3LL I mean they're both listed on their own at the top of the list, and again in their correct alphabetical position. If it's deliberate that they're listed separately there should be some sort of divider, and possibly no duplicate in the rest of the list.

@Ch3LL
Copy link
Contributor

Ch3LL commented Mar 18, 2019

image

I believe you are referring to these virtual modules? In my opinion there is a clear division here.

@OrangeDog
Copy link
Contributor Author

@Ch3LL see my screenshot.
There is no division in the sidebar that appears on every page.

@sagetherage sagetherage added the fixed-pls-verify fix is linked, bug author to confirm fix label Apr 24, 2020
@sagetherage
Copy link
Contributor

fixed with port to master -- will be released in sodium

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation fixed-pls-verify fix is linked, bug author to confirm fix P1 Priority 1 severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around
Projects
None yet
Development

No branches or pull requests

6 participants