Skip to content

salt.module.run documentation improvement? #51349

@cr1st1p

Description

@cr1st1p

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.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationRelates to Salt documentation

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions