feat: reworked add cv#703
Closed
jakobmoellerdev wants to merge 1 commit intoopen-component-model:mainfrom
Closed
Conversation
- Add theme-aware Mermaid rendering with dynamic updates on theme changes - Reworked add cv to be more approachable Signed-off-by: Jakob Möller <contact@jakob-moeller.com>
✅ Deploy Preview for open-component-model ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
7 tasks
Contributor
|
looks great! Also the extension of the baseof.html makes absolutely no sense sense. I took over all new style and structure tips into the new templates we created with #713 and #714. There are some issue with relative links that should get a replacement by relref and a minor conflict. Besides that, 👍🏻👍🏻👍🏻 |
1 task
12 tasks
morri-son
reviewed
Feb 20, 2026
| ``` | ||
|
|
||
| The command [`ocm add component-version`]({{< relref "ocm_add_component-version.md" >}}) directly creates a component version from a `component-constructor.yaml` file and stores it in a local CTF archive. | ||
| Component versions are created using a `component-constructor.yaml` file that describes components and their artifacts. The OCM CLI builds these into a [Common Transport Format (CTF)](https://github.com/open-component-model/ocm-spec/blob/main/doc/04-extensions/03-storage-backends/ctf.md) archive, which can then be transferred to any OCI registry |
Contributor
There was a problem hiding this comment.
Suggested change
| Component versions are created using a `component-constructor.yaml` file that describes components and their artifacts. The OCM CLI builds these into a [Common Transport Format (CTF)](https://github.com/open-component-model/ocm-spec/blob/main/doc/04-extensions/03-storage-backends/ctf.md) archive, which can then be transferred to any OCI registry | |
| Component versions are created using a `component-constructor.yaml` file that describes components and their artifacts. The OCM CLI builds these into a local [Common Transport Format (CTF)](https://github.com/open-component-model/ocm-spec/blob/main/doc/04-extensions/03-storage-backends/ctf.md) archive, which can then be transferred to any OCI registry |
morri-son
reviewed
Feb 20, 2026
| OCM supports various ways to include resource artifacts in your components via `resources`. | ||
|
|
||
| A resource is described either by its access information to a remote repository or by locally provided resources. | ||
| **Use `input` to embed content directly, or `access` to reference external artifacts.** |
Contributor
There was a problem hiding this comment.
Suggested change
| **Use `input` to embed content directly, or `access` to reference external artifacts.** | |
| Use **`input`** to embed content directly, or **`access`** to reference external artifacts. |
morri-son
reviewed
Feb 20, 2026
| OCM uses a double-slash (`//`) notation to separate the repository from the component path: | ||
|
|
||
| To list all versions of a component, only specify the component name and skip the version. Let us view all versions of the component with the name `ocm.software/demos/podinfo`, which is stored in the the OCM repository `ghcr.io/open-component-model`: | ||
| - **Local CTF**: `./transport-archive//github.com/acme.org/helloworld:1.0.0` |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Local CTF**: `./transport-archive//github.com/acme.org/helloworld:1.0.0` | |
| - Local Archive (CTF): `./transport-archive//github.com/acme.org/helloworld:1.0.0` |
morri-son
reviewed
Feb 20, 2026
|
|
||
| To list all versions of a component, only specify the component name and skip the version. Let us view all versions of the component with the name `ocm.software/demos/podinfo`, which is stored in the the OCM repository `ghcr.io/open-component-model`: | ||
| - **Local CTF**: `./transport-archive//github.com/acme.org/helloworld:1.0.0` | ||
| - **Remote OCI Registry**: `ghcr.io/open-component-model/ocm//ocm.software/ocmcli:0.17.0` |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Remote OCI Registry**: `ghcr.io/open-component-model/ocm//ocm.software/ocmcli:0.17.0` | |
| - Remote Registry (OCI): `ghcr.io/open-component-model/ocm//ocm.software/ocmcli:0.17.0` |
morri-son
reviewed
Feb 20, 2026
Comment on lines
+460
to
+471
| {{< card-grid >}} | ||
| {{< link-card | ||
| title="Sign Component Versions" | ||
| description="Add cryptographic signatures for authenticity." | ||
| href="../sign-component-version" | ||
| >}} | ||
| {{< link-card | ||
| title="Download Resources" | ||
| description="Extract resources from component versions." | ||
| href="../download-resources-from-component-versions" | ||
| >}} | ||
| {{< /card-grid >}} |
Contributor
There was a problem hiding this comment.
We should check how a "next steps" section should be formatted, as this card grid is exactly the same the doks scheme uses for the prev/next page view. Maybe a standard list fits better?
morri-son
pushed a commit
to morri-son/ocm-website
that referenced
this pull request
Feb 22, 2026
…e "download resources" doc to how-to section On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
This was referenced Feb 22, 2026
Contributor
|
superseeded by #733 |
morri-son
added a commit
that referenced
this pull request
Mar 5, 2026
…ture (#733) <!-- markdownlint-disable MD041 --> #### What this PR does / why we need it - Rework getting started guides following the example from #703 . - Move "download resources" doc from getting-started to how-to section. - Delete sign and verify component from the getting started (will be reworked into how-tos as part of open-component-model/ocm-project#886 - Enhance baseof.html layout to allow mermaid diagrams in our docs. This PR superseeds #703 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Major rework of getting-started guides into stepwise tutorials with expanded examples, troubleshooting, estimated times; several older signing/verification pages removed and a consolidated "Download Resources" how‑to added. * **New Features** * Mermaid diagram rendering improved with theme auto-detection (light/dark) and dynamic re-rendering on theme changes. * **Chores** * Site layout and navigation adjusted; repository ignore patterns updated to include a new ignore file. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Piotr Janik <piotrjanik@nautilia.pl>
ocmbot bot
pushed a commit
that referenced
this pull request
Mar 5, 2026
…ture (#733) <!-- markdownlint-disable MD041 --> #### What this PR does / why we need it - Rework getting started guides following the example from #703 . - Move "download resources" doc from getting-started to how-to section. - Delete sign and verify component from the getting started (will be reworked into how-tos as part of open-component-model/ocm-project#886 - Enhance baseof.html layout to allow mermaid diagrams in our docs. This PR superseeds #703 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Major rework of getting-started guides into stepwise tutorials with expanded examples, troubleshooting, estimated times; several older signing/verification pages removed and a consolidated "Download Resources" how‑to added. * **New Features** * Mermaid diagram rendering improved with theme auto-detection (light/dark) and dynamic re-rendering on theme changes. * **Chores** * Site layout and navigation adjusted; repository ignore patterns updated to include a new ignore file. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Piotr Janik <piotrjanik@nautilia.pl> 08179b0
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
2 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.
What this PR does / why we need it
While im currently reworking the website documentation I really struggled to follow the most basic guide we have. Thats why I set out to rework it into a "guide" approach that is much more easy to digest (at least imo) and has more collapsible sections that hide unneeded information if people dont want to dive deeper. It also adds Add theme-aware Mermaid rendering with dynamic updates on theme changes.
Which issue(s) this PR is related to
Part of smaller docs reworks that I didnt want to push as part of diataxis rework in open-component-model/ocm-project#841