Skip to content

[Change Proposal] Add docs_structure_enforced flag in _dev/build/build.yml #920

Open
@haetamoudi

Description

@haetamoudi

Ad part of the docs improvement project, we have created a new README structure template to be used for integrations.

To ensure consistency, we want to verify that new integration READMEs follow this structure.

Scope:
This validation will apply only to new integrations for now. Existing integrations will be updated gradually.

To avoid breaking existing integrations, the validation will only be enforced for selected ones. This will be controlled via a flag in the _dev/build/build.yml file.

The flag is named: docs_structure_enforced

Default value: false

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussIssue needs discussion

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions