docs: add pattern metadata documentation and guidelines#704
Open
gaurav-nelson wants to merge 1 commit into
Open
docs: add pattern metadata documentation and guidelines#704gaurav-nelson wants to merge 1 commit into
gaurav-nelson wants to merge 1 commit into
Conversation
|
🤖 Mon Jul 06 12:02:50 - The preview is ready at: |
gaurav-nelson
force-pushed
the
pattern-metadata-docs
branch
from
a28ac2f to
73d3cb5
Compare
mbaldessari
requested changes
Jul 2, 2026
|
|
||
| | `name`, `catalogKey` | ||
| | Install, uninstall, and secrets management navigation | ||
| |=== |
Contributor
There was a problem hiding this comment.
No idea what this catalogKey is?
Collaborator
Author
There was a problem hiding this comment.
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
force-pushed
the
pattern-metadata-docs
branch
from
73d3cb5 to
3bc4fe2
Compare
beekhof
reviewed
Jul 9, 2026
| [id="cluster-sizing-fields"] | ||
| == Cluster sizing fields | ||
|
|
||
| The `requirements` section defines tested {rh-ocp} cluster configurations. |
Collaborator
There was a problem hiding this comment.
I think we need some additional text here. Why did we test with these numbers, and what do they mean for someone trying to run the pattern. Is the pattern guaranteed to work with these values? (answer: no)
beekhof
reviewed
Jul 9, 2026
Comment on lines
+228
to
+238
| requirements: | ||
| hub: | ||
| compute: | ||
| aws: | ||
| replicas: 3 | ||
| type: m5.2xlarge | ||
| controlPlane: | ||
| aws: | ||
| replicas: 3 | ||
| type: m5.xlarge | ||
| ---- |
Collaborator
There was a problem hiding this comment.
why the second block of almost the same text?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
For https://redhat.atlassian.net/browse/MBP-1138
Added documentation explaining the metadata and linked it to existing sections.