[DOCS] state_top_saltenv documention is inaccurate in regard to when it applies
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
This option has no default value. Set it to an environment name to ensure that only the top file from that environment is considered during a highstate.
The docs here are wrong. The "ensure that only the top file from that environment is considered" is only applicable if saltenv is not specified by the minion.
Suggested Fix
Update the docs to indicate that it will only apply if the minion does not have a saltenv configured. I believe this setting is more accurately described as a saltenv fallback, as it behaves very similar to if saltenv was configured.
Location or format of documentation
https://docs.saltproject.io/en/latest/ref/configuration/master.html#state-top-saltenv
https://docs.saltproject.io/en/latest/ref/configuration/minion.html#state-top-saltenv
Additional context
I actually like the way the option currently works. I do /not/ believe it should be changed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the state.py lines linked in the issue to confirm when state_top_saltenv applies. Update the state_top_saltenv sections in the master and minion configuration documentation to describe it as a saltenv fallback when no minion saltenv is configured. Done means both pages accurately document the current behavior without changing the option.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100