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

virtual modules shadow/service have unaccessible online documentation #49335

Closed
erwindon opened this issue Aug 26, 2018 · 9 comments
Closed

virtual modules shadow/service have unaccessible online documentation #49335

erwindon opened this issue Aug 26, 2018 · 9 comments
Labels
Bug broken, incorrect, or confusing behavior docstring-update string edits Documentation Relates to Salt documentation severity-low 4th level, cosemtic problems, work around exists
Milestone

Comments

@erwindon
Copy link
Contributor

Description of Issue

The documentation for both the virtual module shadow and the execution module shadow have the same page url. Therefore the online documentation for execution module shadow cannot be accessed.
The same happens for virtual module service.
It does not happen for any of the other virtual modules.

Setup

none, existing saltstack.com website only

Steps to Reproduce Issue

Go to the page for virtual module shadow: https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.shadow.html. Now try to see the documentation for execution module shadow by following link shadow and see that it points to the same page again.
The same happens for virtual module service.

My suggestion is to rename execution module shadow to linux_shadow; and to rename execution module service to sysvinit_service.

Versions Report

N/A

@garethgreenaway garethgreenaway added Documentation Relates to Salt documentation Bug broken, incorrect, or confusing behavior P2 Priority 2 severity-low 4th level, cosemtic problems, work around exists P3 Priority 3 and removed P2 Priority 2 labels Aug 27, 2018
@garethgreenaway
Copy link
Contributor

@erwindon Thanks for the report.

@gtmanfred gtmanfred added this to the Approved milestone Aug 30, 2018
@max-arnold
Copy link
Contributor

I wonder if it is possible to write a test or make a change in the build process that will prevent this from happening in the future.

@mchugh19
Copy link
Contributor

Sounds like this would also be helped by implementing the naming convention suggestions from #30533

@johnnybubonic
Copy link

johnnybubonic commented Jan 30, 2019

worth noting this does NOT occur for the "online"(in the classical sense of the word) docs, e.g. salt-call sys.doc shadow or salt '<TGT>' sys.doc shadow - the Linux shadow execution module is shown. i didn't check to see if you're generating the HTML docs from sys.doc's source or vice versa, but if you are, the namespacing issue is not present on sys.doc.

same for the service execution module (is indeed accessible via sys.doc).

@stale
Copy link

stale bot commented Jan 9, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.

@stale stale bot added the stale label Jan 9, 2020
@max-arnold
Copy link
Contributor

Bump

@stale
Copy link

stale bot commented Jan 9, 2020

Thank you for updating this issue. It is no longer marked as stale.

@stale stale bot removed the stale label Jan 9, 2020
@max-arnold
Copy link
Contributor

#53296

@barbaricyawps
Copy link
Contributor

Closing as this was resolved by #53296

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 docstring-update string edits Documentation Relates to Salt documentation severity-low 4th level, cosemtic problems, work around exists
Projects
None yet
Development

No branches or pull requests

8 participants