chore: sync update installation instructions for helm install#745
Conversation
✅ Deploy Preview for open-component-model ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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 (2)
📝 WalkthroughWalkthroughReplaced Helm chart references for installing OCM controllers from 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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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_versioned/version-legacy/docs/getting-started/setup-controller.md`:
- Around line 85-91: The helm install example uses the literal token
"<pre-release>" which shells treat as input redirection; update the helm install
example (the line beginning with "helm install ocm-k8s-toolkit
oci://.../controller/chart:<pre-release>") to use a copy-paste safe placeholder
or concrete tag (for example HELM_CHART_VERSION or a sample tag like v0.0.0-pre)
and document that users should replace that variable with the desired chart
version; ensure the placeholder does not include angle brackets so pasting into
a shell won't trigger redirection.
In `@content/docs/getting-started/setup-controller-environment.md`:
- Around line 214-221: The Helm install command uses an unquoted placeholder
"<pre-release>" which Bash treats as a redirection operator; update the command
in the docs so the OCI URL is quoted or the placeholder is replaced by a
shell-safe variable (e.g., use
"oci://ghcr.io/open-component-model/kubernetes/controller/chart:<pre-release>"
or a variable like ${VERSION} with a concrete example such as v0.1.0-rc.1) to
prevent shell parsing errors when users copy-paste the helm install command.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: abb82570-b354-4f32-8402-416ae712e20d
📒 Files selected for processing (2)
content/docs/getting-started/setup-controller-environment.mdcontent_versioned/version-legacy/docs/getting-started/setup-controller.md
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
b0df504 to
27f2bf0
Compare
<!-- markdownlint-disable MD041 --> #### What this PR does / why we need it The location of the helm chart changed. This PR updates the location. Related to open-component-model/open-component-model#1931 which should be reviewed and merged first. Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com> d350bc4
What this PR does / why we need it
The location of the helm chart changed. This PR updates the location.
Related to open-component-model/open-component-model#1931 which should be reviewed and merged first.
Summary by CodeRabbit