feat: add how-to for OCM CLI container usage#740
Conversation
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
✅ Deploy Preview for open-component-model ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated a how-to template's "Getting help" links to internal references and added a new how-to doc describing how to use the OCM CLI container image to create and retrieve component versions; also added "nerdctl" to the repo wordlist. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@content_templates/template-how-to.md`:
- Line 120: There's a stray extra closing parenthesis in the Markdown link in
template-how-to.md: replace the fragment `{{< relref "community/community.md"
>}}))` with `{{< relref "community/community.md" >}})` to fix the syntax error
so the link renders correctly; update the content where the link appears (the
line containing `[Community Support]({{< relref "community/community.md" >}}))`)
to remove the extra `)` and run a quick Markdown render check.
In `@content/docs/how-to/container-usage.md`:
- Line 110: Fix the typo in the documentation string "Depending on you OS, the
path to the certificates may be different" by replacing "you OS" with "your OS"
in the sentence (locate the phrase "Depending on you OS" in
content/docs/how-to/container-usage.md and update it to "Depending on your OS,
the path to the certificates may be different"). Ensure only the grammatical
correction is applied and commit the change.
- Line 91: The docs currently reference the container image string
"ghcr.io/open-component-model/cli:latest", which is not reproducible; change
examples to use a specific version tag (e.g.,
"ghcr.io/open-component-model/cli:vX.Y.Z") or add a brief note in the guide
explaining that pre-built images may not be available for OCM v2 and instruct
users to build from source when images are not published; update the example
lines containing ghcr.io/open-component-model/cli:latest and the surrounding
explanatory text in container-usage.md to reflect the chosen approach.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8b279b9c-92e0-4bda-bd05-3393d5240e1a
📒 Files selected for processing (2)
content/docs/how-to/container-usage.mdcontent_templates/template-how-to.md
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
…bsite into add-how-to-container-usage
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
<!-- markdownlint-disable MD041 --> #### What this PR does / why we need it This PR adds a How-To on how to use the OCM CLI container (v2). This will be linked by open-component-model/open-component-model#1893. #### Which issue(s) this PR is related to Part of open-component-model/ocm-project#923 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a new how-to guide for using the OCM CLI container image with prerequisites, step-by-step commands, examples, and registry/authentication notes. * Updated Getting Help links to point to internal documentation and a revised issue tracker URL. * **Chores** * Added "nerdctl" to the project wordlist. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com> 4db70ed
What this PR does / why we need it
This PR adds a How-To on how to use the OCM CLI container (v2). This will be linked by open-component-model/open-component-model#1893.
Which issue(s) this PR is related to
Part of open-component-model/ocm-project#923
Summary by CodeRabbit