Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ScriptAutomate opened this issue Mar 26, 2021 · 0 comments
Assignees
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

Comments

@ScriptAutomate
Copy link
Contributor

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:

@ScriptAutomate ScriptAutomate added Feature new functionality including changes to functionality and code refactors, etc. needs-triage Documentation Relates to Salt documentation labels Mar 26, 2021
@ScriptAutomate ScriptAutomate added Bug broken, incorrect, or confusing behavior and removed Feature new functionality including changes to functionality and code refactors, etc. labels Mar 26, 2021
@ScriptAutomate ScriptAutomate changed the title [FEATURE REQUEST] Prevent new config opts being added to Salt without minimum reqs (ex. docs, VALID_OPTS, etc.) [BUG][DOCUMENTATION] Prevent new config opts being added to Salt without minimum reqs (ex. docs, VALID_OPTS, etc.) Mar 26, 2021
@sagetherage sagetherage added this to the Approved milestone Mar 29, 2021
@sagetherage sagetherage added severity-high 2nd top severity, seen by most users, causes major problems and removed needs-triage labels Mar 29, 2021
@sagetherage sagetherage added the Phosphorus v3005.0 Release code name and version label Jun 18, 2021
@sagetherage sagetherage modified the milestones: Approved, Phosphorus Jun 18, 2021
@barbaricyawps barbaricyawps removed their assignment Jan 24, 2022
@Ch3LL Ch3LL removed the Phosphorus v3005.0 Release code name and version label Mar 30, 2022
@MKLeb MKLeb self-assigned this May 23, 2023
@MKLeb MKLeb modified the milestones: Sulfur v3006.4, Argon v3008 Sep 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

7 participants