Add docs_structure_enforced to validation.yml #924
+58
−2
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Initial discussion
RFC
What does this PR do?
This PR enable setting the
docs_structure_enabled
parameter in thevalidation.yml
Why is it important?
If set, this will be sure to enforce the docs structure of the readme files. It will verify the documentation files contain a predefined set of titles.
docs_structure_enabled
contains:Checklist
test/packages
that prove my change is effective.spec/changelog.yml
.Related issues
Implementation of changes in elastic-package elastic/elastic-package#2716