saltstack / saltstack/salt

[BUG][DOCUMENTATION] Prevent new config opts being added to Salt without minimum reqs (ex. docs, VALID_OPTS, etc.)

Open
#59,908 0 comments 1 reaction 1 assignee View on GitHub

@MKLeb is already working on this.

Since May 23, 2023.

bug documentation severity-high time-estimate-sprint
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

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: opts that are implemented in non-standard ways, so incredibly hard to audit what available opts there 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.