search

saltstack / salt

Software to automate the management and configuration of any infrastructure or application at scale. Get access to the Salt software package repository here:
https://repo.saltproject.io/
Apache License 2.0
14.1k stars 5.47k forks source link

[DOCS] salt.states.service.running confusing discrepencies #60784

Open sharkbruhaha opened 3 years ago

sharkbruhaha commented 3 years ago

Description Unclear on what options available in state.service https://docs.saltproject.io/en/latest/ref/states/all/salt.states.service.html#salt.states.service.running

In the example in the top, there is a "reload" option for service.running, but then in the running section it is not shown as an option. What on the page is correct and what is outdated/wrong?

Suggested Fix Update doc to show whatever is current.

Type of documentation Salt State documentation: salt.states.service.running https://docs.saltproject.io/en/latest/ref/states/all/salt.states.service.html#salt.states.service.running

Location or format of documentation https://docs.saltproject.io/en/latest/ref/states/all/salt.states.service.html#salt.states.service.running

OrangeDog commented 3 years ago

The reload parameter is part of the mod_watch function, which are passed via the same state parameter list, regardless of what the actual state function is.

Parameters for this function should be set by the watching service. (i.e. service.running)

So nothing on the page is wrong, it's just confusing.