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

salt.module.run documentation improvement? #51349

Closed
cr1st1p opened this issue Jan 26, 2019 · 2 comments · Fixed by #52420
Closed

salt.module.run documentation improvement? #51349

cr1st1p opened this issue Jan 26, 2019 · 2 comments · Fixed by #52420
Labels
Documentation
Milestone

Comments

@cr1st1p
Copy link

@cr1st1p cr1st1p commented Jan 26, 2019

Description of Issue/Question

I wanted to run a module's function via module.run (namely systemd.force_reload).
Instead of the expected behavior I got an error related to the name of my state.
After spending some frustrating time, I discovered somehow that the documentation on how to use the module.run functionality forgets to mention that you need to enable the 'new' way of running it, via some 'superseeded' config entry.

Please:

  • move at the TOP of the documentation, the part about 'this is new behavior', because you start the example WITH the new behavior syntax and people might not read the whole page to understand how it should be used and that in fact it does NOT work like.
  • make the part about the 'superseeded'' configuration be PART of the same TOP paragraph and not even more down below.

Thank you.

Setup

(Please provide relevant configs and/or SLS files (Be sure to remove sensitive info).)

Steps to Reproduce Issue

(Include debug logs if possible and relevant.)

Versions Report

(Provided by running salt --versions-report. Please also mention any differences in master/minion versions.)

@cr1st1p cr1st1p changed the title salt.modules.run documentation improvement? salt.module.run documentation improvement? Jan 26, 2019
@dwoz
Copy link
Contributor

@dwoz dwoz commented Jan 27, 2019

@cr1st1p Thank you very much for the pull requests!

@dwoz dwoz added the Documentation label Jan 27, 2019
@dwoz dwoz added this to the Approved milestone Jan 27, 2019
@devurandom
Copy link

@devurandom devurandom commented Mar 6, 2019

Is this related to or a duplicate of #44882?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants