Contribute to Validated Patterns
Find out how you can contribute to the Validated Patterns project.
Metadata and documentation pattern-metadata.yaml feeds validatedpatterns.io cluster sizing pages through an automated sync workflow. Keep the metadata file aligned with Hugo frontmatter on pattern landing pages so public website content and generated sizing tables stay consistent.
Schema and field reference Use this reference when you author pattern-metadata.yaml at the repository root or inspect normalized catalog files. The JSON schema defines required and optional fields for catalog format, and the field tables describe how to set identity, links, cluster sizing, and related values in source files.
Example metadata files These examples show pattern-metadata.yaml as you author it in a pattern repository (source format). For field definitions, see Schema and field reference.
Validation and troubleshooting Validate pattern-metadata.yaml before you publish a pattern so the UI catalog and documentation sync workflows accept your changes.
Contributing to patterns To contribute, add the upstream repository as an additional remote and work on a branch other than the main branch.
Testing artifacts To be represented in the CI dashboard, testers can create a publicly available JSON file (for example, in an AWS bucket) that records the result of the latest test for each combination of pattern, platform, and Red Hat OpenShift Container Platform version.
