Skip to content

Ensure all components have at least one sample configuration #14097

@mx-psi

Description

@mx-psi

This is a documentation requirement for alpha and above components.

Steps to do this:

  1. Add an optional field on metadata.yaml that has the example configuration (possibly on a separate field). Make sure to:
    1. Render this field in the README of the component.
    2. Generate a test to ensure the example is valid.
  2. Add this to all components (or to 'higher priority' components)
  3. Mark this field as required (possibly with an allowlist if we are focusing only on 'high priority' components).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions