Skip to content

docs: add pattern metadata documentation and guidelines#704

Open
gaurav-nelson wants to merge 1 commit into
validatedpatterns:mainfrom
gaurav-nelson:pattern-metadata-docs
Open

docs: add pattern metadata documentation and guidelines#704
gaurav-nelson wants to merge 1 commit into
validatedpatterns:mainfrom
gaurav-nelson:pattern-metadata-docs

Conversation

@gaurav-nelson

Copy link
Copy Markdown
Collaborator

For https://redhat.atlassian.net/browse/MBP-1138

Added documentation explaining the metadata and linked it to existing sections.

@openshift-ci openshift-ci Bot added the size/L label Jul 2, 2026
@openshift-ci openshift-ci Bot requested review from dminnear-rh and mhjacks July 2, 2026 00:35
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 2, 2026

Copy link
Copy Markdown

🤖 Mon Jul 06 12:02:50 - The preview is ready at:
https://704--patternsdocs-pr.netlify.app

@gaurav-nelson gaurav-nelson force-pushed the pattern-metadata-docs branch from a28ac2f to 73d3cb5 Compare July 2, 2026 00:56
@openshift-ci openshift-ci Bot added size/XL and removed size/L labels Jul 2, 2026
Comment thread content/contribute/pattern-metadata-schema-reference.adoc Outdated
Comment thread content/contribute/pattern-metadata-ui-catalog.adoc Outdated

| `name`, `catalogKey`
| Install, uninstall, and secrets management navigation
|===

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No idea what this catalogKey is?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI picked it up from https://github.com/validatedpatterns/patterns-operator/blob/main/console/src/types.ts#L61

I've removed it from the docs.

@gaurav-nelson gaurav-nelson force-pushed the pattern-metadata-docs branch from 73d3cb5 to 3bc4fe2 Compare July 6, 2026 12:00
@gaurav-nelson gaurav-nelson requested a review from mbaldessari July 8, 2026 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants