[BUG][DOCUMENTATION] Prevent new config opts being added to Salt without minimum reqs (ex. docs, VALID_OPTS, etc.) #59908
Labels
Bug
broken, incorrect, or confusing behavior
Documentation
Relates to Salt documentation
severity-high
2nd top severity, seen by most users, causes major problems
time-estimate-sprint
Milestone
Is your feature request related to a problem? Please describe.
pre-commit
needs to monitor thesalt/config/__init__.py
(and theconf/*
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 forsalt
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
opt
to Salt configs:VALID_OPTS
DEFAULT_*_OPTS
pre-commit
needs to monitor thesalt/config/__init__.py
(and theconf/*
files, and the conf rst files)salt/config/__init__.py
that differs from what is currently there, we need to verify that:conf/minion
and/orconf/master
?.rst
equivelants, like doc/ref/configuration/minion.rst and/or doc/ref/configuration/master.rst?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:
opts
that are implemented in non-standard ways, so incredibly hard to audit what availableopts
there arefips_mode
, via [freeze] fips_mode config option #59833)The text was updated successfully, but these errors were encountered: