Skip to content

Add docs_structure_enforced to validation.yml #924

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

haetamoudi
Copy link

@haetamoudi haetamoudi commented Jul 9, 2025

Initial discussion
RFC

What does this PR do?

This PR enable setting the docs_structure_enabled parameter in the validation.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:

  • version: version of template that will be used
  • skip: list of title that will be ignored from the validation

Checklist

Related issues

Implementation of changes in elastic-package elastic/elastic-package#2716

@haetamoudi
Copy link
Author

test integrations

@elastic-vault-github-plugin-prod

Created or updated PR in integrations repository to test this version. Check elastic/integrations#14474

@haetamoudi
Copy link
Author

test integrations

@elastic-vault-github-plugin-prod

Created or updated PR in integrations repository to test this version. Check elastic/integrations#14474

@haetamoudi haetamoudi changed the title [WIP] add entry to validation Add docs_structure_enforced to validation.yml Jul 15, 2025
@elasticmachine
Copy link

💚 Build Succeeded

History

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants