[BUG][DOCUMENTATION] Prevent new config opts being added to Salt without minimum reqs (ex. docs, VALID_OPTS, etc.)
@MKLeb is already working on this.
Since May 23, 2023.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Is your feature request related to a problem? Please describe.
pre-commit needs to monitor the salt/config/__init__.py (and the conf/* files, and the conf rst files) for new opts/options added to Salt. There have been new options added at a pace faster than they've been documented. As a result, we have a mix of over 100 undocumented and underdocumented options for salt configs.
Before we start documenting everything that is undocumented/underdocumented, we need to prevent any new options from being added that aren't documented properly.
Describe the solution you'd like
- Create a document with proper guidance on adding a new
optto Salt configs:VALID_OPTSDEFAULT_*_OPTS- etc.
pre-commitneeds to monitor thesalt/config/__init__.py(and theconf/*files, and the conf rst files)- Whenever a new opt appears in
salt/config/__init__.pythat differs from what is currently there, we need to verify that:- Is the option properly documented in the
conf/minionand/orconf/master? - Is the same option properly documented in the
.rstequivelants, like doc/ref/configuration/minion.rst and/or doc/ref/configuration/master.rst?
- Is the option properly documented in the
Describe alternatives you've considered
I'm not quite sure what alternative paths there would be that could assist in preventing these from continuously growing the backlog.
Additional context
This is directly related to an EPIC issue and the PRs/issues linked within it: #58112
Please Note
Should require no SEP. I wasn't sure what type of issue this should be. This could be a mixture of bug, documentation, and feature request:
- bug:
optsthat are implemented in non-standard ways, so incredibly hard to audit what availableoptsthere are - documentation: There are ~100 undocumented/underdocumented options, as pointed out by #58112
- feature: We don't have any test automation in place to ensure we aren't adding more opts to our tech debt in the issue #58112 (such as a recent opt added,
fips_mode, via #59833)
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.
Assessment
This issue has not been assessed yet.