chore: Update getting started guides to new diataxis layout and structure#733
Merged
morri-son merged 16 commits intoopen-component-model:mainfrom Mar 5, 2026
Conversation
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
…to) and remove unwanted .clineignore On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
morri-son
added
area/documentation
✅ Deploy Preview for open-component-model ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
1 task
Closed
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
piotrjanik
reviewed
Mar 3, 2026
piotrjanik
reviewed
Mar 3, 2026
content/docs/how-to/download-resources-from-component-versions.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Piotr Janik <piotrjanik@nautilia.pl> Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com>
12 tasks
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
morri-son
force-pushed
the
update-guides-for-getting-started-focussed
branch
from
f747993 to
3927bdf
Compare
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
|
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:
📝 WalkthroughWalkthroughThis PR reorganizes and expands multiple getting-started guides, removes signing/verification docs from that section and moves the download-resources guide to how-to, adds Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Browser as Browser (page)
participant Script as Mermaid Loader Script
participant Mermaid as Mermaid ESM Module
participant OS as Theme Source (data-bs-theme / system)
Browser->>Script: page load (contains mermaid blocks)
Script->>Mermaid: import mermaid (ESM)
Script->>Script: compute theme (check data-bs-theme / OS)
Script->>Browser: annotate mermaid blocks with data-mermaid-source
Script->>Mermaid: init & run mermaid with theme
Mermaid-->>Browser: render SVGs
Note over OS, Browser: User/system theme changes
OS-->>Browser: update data-bs-theme
Browser->>Script: MutationObserver detects theme change
Script->>Browser: restore data-mermaid-source into blocks
Script->>Mermaid: re-init & run mermaid with new theme
Mermaid-->>Browser: re-render SVGs
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 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 |
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
content/docs/getting-started/ocm-cli-installation.md (1)
84-85:⚠️ Potential issue | 🟡 MinorGrammar error: "might tested" should be "might be tested".
📝 Suggested fix
-- Windows-specific logic (such as path detection and normalization) might tested via simulated +- Windows-specific logic (such as path detection and normalization) might be tested via simulated OS behavior on non-Windows runners.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/getting-started/ocm-cli-installation.md` around lines 84 - 85, Replace the grammatical error in the sentence "Windows-specific logic (such as path detection and normalization) might tested via simulated OS behavior on non-Windows runners." by inserting the missing "be" so it reads "Windows-specific logic (such as path detection and normalization) might be tested via simulated OS behavior on non-Windows runners."; update the exact sentence in the documentation to correct the grammar.
🧹 Nitpick comments (2)
content/docs/getting-started/create-component-version.md (1)
114-118: Inconsistent input type:filevsfile/v1.Line 82 correctly uses
type: file/v1, but this example usestype: file. Based on past review feedback,file/v1is the preferred non-deprecated form. Consider using consistent typing throughout the document.📝 Suggested fix
resources: - name: config type: blob input: - type: file + type: file/v1 path: ./config.yaml🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/getting-started/create-component-version.md` around lines 114 - 118, The example uses an inconsistent input type: under the `type: blob` example the `input` currently declares `type: file`; update that `input.type` to `file/v1` to match the preferred non-deprecated form used elsewhere (e.g., the earlier `type: file/v1` example) so all examples use consistent `file/v1` typing.layouts/_default/baseof.html (1)
48-65: SetstartOnLoad: falseto explicitly control when Mermaid renders.With
startOnLoad: true, Mermaid automatically renders diagrams on page load. Callingmermaid.run()manually afterward can cause double rendering and conflicts. UsestartOnLoad: falseto disable auto-render, then explicitly control rendering withmermaid.run()after eachinitialize()call (including on theme changes).♻️ Suggested fix
mermaid.initialize({ - startOnLoad: true, + startOnLoad: false, theme: getMermaidTheme() }); + mermaid.run(); // Re-render on theme change const observer = new MutationObserver((mutations) => { mutations.forEach((mutation) => { if (mutation.attributeName === 'data-bs-theme') { document.querySelectorAll('.mermaid').forEach((el) => { const source = el.getAttribute('data-mermaid-source'); if (source) { el.removeAttribute('data-processed'); el.innerHTML = source; } }); mermaid.initialize({ startOnLoad: false, theme: getMermaidTheme() }); mermaid.run(); } }); });🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@layouts/_default/baseof.html` around lines 48 - 65, Change Mermaid initialization to disable auto-rendering by setting startOnLoad: false in mermaid.initialize calls (the one at top and the one inside the MutationObserver reaction). Specifically, update the mermaid.initialize({ startOnLoad: ..., theme: getMermaidTheme() }) calls so startOnLoad is false, then continue to call mermaid.run() explicitly after each mermaid.initialize() (the initial mermaid.initialize and the one inside the MutationObserver callback that listens for data-bs-theme changes) so diagrams render only once and avoid double-rendering.
🤖 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/docs/getting-started/deploy-helm-chart.md`:
- Line 266: There's a typo in the documentation string "Fluxs" — update the
sentence that begins "We configure the Helm chart using Fluxs HelmRelease
'values' field." to use the proper possessive form "Flux's" so it reads "We
configure the Helm chart using Flux's HelmRelease 'values' field." Ensure the
apostrophe is included exactly as shown.
- Around line 120-121: The URL uses a hardcoded GitHub username (morri-son);
update the instruction to avoid a fixed user by replacing the link with a
template or navigation instruction such as: tell users to go to their GitHub
profile Packages tab (e.g. https://github.com/<your-username>?tab=packages) or
instruct them to open "Your profile → Packages" and then select the package
`component-descriptors/ocm.software/ocm-k8s-toolkit/simple` to change visibility
to public so the package name remains referenced but the username is not
hardcoded.
In `@content/docs/getting-started/ocm-cli-installation.md`:
- Around line 45-53: Update the documentation to remove the contradictory
installation paths by clearly describing both installation methods: explain that
"task cli:install" installs the CLI to /usr/local/bin (and may require sudo),
while the built binary from "task cli:build" can be placed in $GOPATH/bin if the
user prefers; replace the current single sentence about $GOPATH/bin with two
short sentences reflecting these options and include the PATH-export example
only for the $GOPATH/bin case (keeping references to the task names "task
cli:build" and "task cli:install" so readers can locate the relevant steps).
In `@content/docs/getting-started/setup-controller-environment.md`:
- Around line 186-187: Remove the stray backtick character immediately following
the closing </details> tag so it doesn't render as visible text; locate the
occurrence of "</details>`" in the document and delete the trailing backtick,
leaving the proper closing tag alone.
In `@content/docs/how-to/download-resources-from-component-versions.md`:
- Around line 170-189: The example shows an inconsistency between the downloaded
chart name and the tar output: the download step references the podinfo chart
but the `tar tvf helmchart.tgz` listing shows files under `echoserver/`; update
the documentation so the chart name is consistent by either changing the
download command to fetch `echoserver` (so the `tar tvf helmchart.tgz` output
remains correct) or replacing the tar listing to show `podinfo/` entries to
match the existing download command; ensure the unique references (`podinfo`,
`echoserver`, and the `tar tvf helmchart.tgz` command) are updated together.
- Around line 85-89: The shell snippet showing the ocm download resource command
has inconsistent leading spaces (the second line has two spaces and the third
line has one), so normalize indentation for readability and safe copy-paste:
make the command start with no leading space for the first line "ocm download
resource ghcr.io/open-component-model//ocm.software/demos/podinfo:6.8.0 \\" and
align the continuation flags and options (e.g., "--identity name=chart \\" and
"--output helmchart.tgz") with two spaces each, so all continuation lines have
consistent indentation.
- Around line 68-78: The example output in the docs is inconsistent with the
shown command: the ocm download command uses --output myfile.txt but the log
example shows output=helmchart.tgz; update the example log line to
output=myfile.txt so it matches the command (update the text block containing
time=2025-08-14T13:03:54.372+02:00 level=INFO msg="resource downloaded
successfully" output=... accordingly).
---
Outside diff comments:
In `@content/docs/getting-started/ocm-cli-installation.md`:
- Around line 84-85: Replace the grammatical error in the sentence
"Windows-specific logic (such as path detection and normalization) might tested
via simulated OS behavior on non-Windows runners." by inserting the missing "be"
so it reads "Windows-specific logic (such as path detection and normalization)
might be tested via simulated OS behavior on non-Windows runners."; update the
exact sentence in the documentation to correct the grammar.
---
Nitpick comments:
In `@content/docs/getting-started/create-component-version.md`:
- Around line 114-118: The example uses an inconsistent input type: under the
`type: blob` example the `input` currently declares `type: file`; update that
`input.type` to `file/v1` to match the preferred non-deprecated form used
elsewhere (e.g., the earlier `type: file/v1` example) so all examples use
consistent `file/v1` typing.
In `@layouts/_default/baseof.html`:
- Around line 48-65: Change Mermaid initialization to disable auto-rendering by
setting startOnLoad: false in mermaid.initialize calls (the one at top and the
one inside the MutationObserver reaction). Specifically, update the
mermaid.initialize({ startOnLoad: ..., theme: getMermaidTheme() }) calls so
startOnLoad is false, then continue to call mermaid.run() explicitly after each
mermaid.initialize() (the initial mermaid.initialize and the one inside the
MutationObserver callback that listens for data-bs-theme changes) so diagrams
render only once and avoid double-rendering.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 80a6f027-2319-4f53-ba93-a7d74b5b80fc
📒 Files selected for processing (11)
.gitignorecontent/_index.mdcontent/docs/getting-started/create-component-version.mdcontent/docs/getting-started/deploy-helm-chart.mdcontent/docs/getting-started/download-resources-from-component-versions.mdcontent/docs/getting-started/ocm-cli-installation.mdcontent/docs/getting-started/setup-controller-environment.mdcontent/docs/getting-started/sign-component-version.mdcontent/docs/getting-started/verify-component-version.mdcontent/docs/how-to/download-resources-from-component-versions.mdlayouts/_default/baseof.html
💤 Files with no reviewable changes (3)
- content/docs/getting-started/verify-component-version.md
- content/docs/getting-started/sign-component-version.md
- content/docs/getting-started/download-resources-from-component-versions.md
content/docs/how-to/download-resources-from-component-versions.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
♻️ Duplicate comments (2)
content/docs/getting-started/setup-controller-environment.md (1)
186-186:⚠️ Potential issue | 🟡 MinorRemove stray backtick after closing
</details>tag (Line 186).The extra backtick renders as unintended visible text.
Suggested fix
-</details>` +</details>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/getting-started/setup-controller-environment.md` at line 186, Remove the stray backtick that follows the closing HTML details tag by deleting the trailing backtick character after the "</details>" token so the line ends with a clean closing tag (i.e., change "</details>`" to "</details>"); locate the occurrence of the exact string "</details>`" in the content and remove only the backtick to avoid altering surrounding markup or content.content/docs/getting-started/ocm-cli-installation.md (1)
45-53:⚠️ Potential issue | 🟡 MinorFix contradictory install path instructions (Line 46 vs Line 49).
Line 46 says
task cli:installinstalls to/usr/local/bin, but Line 49 says the CLI is installed to$GOPATH/bin. These should be presented as two distinct options, not a single outcome." token so theSuggested doc fix
task cli:build # builds to cli/tmp/bin/ocm task cli:install # installs to /usr/local/bin (requires sudo)-The CLI is installed to your
$GOPATH/bindirectory. Ensure this is in yourPATH:
+If you usetask cli:install, the CLI is installed to/usr/local/bin.
+
+If you instead place the built binary in your$GOPATH/bin, ensure that path is in yourPATH:export PATH="$PATH:$(go env GOPATH)/bin"</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@content/docs/getting-started/ocm-cli-installation.mdaround lines 45 - 53,
The docs currently present conflicting install locations; update the text around
the "task cli:build" / "task cli:install" block to present two distinct
installation options: state that "task cli:install" installs the CLI to
/usr/local/bin (may require sudo) and separately note that if users place the
built binary in$GOPATH/bin they must add $ (go env GOPATH)/bin to their PATH;
adjust the paragraph that references $GOPATH/bin and the PATH export so it
clearly describes this as an alternative to running task cli:install rather than
the single outcome.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In@content/docs/getting-started/ocm-cli-installation.md:
- Around line 45-53: The docs currently present conflicting install locations;
update the text around the "task cli:build" / "task cli:install" block to
present two distinct installation options: state that "task cli:install"
installs the CLI to /usr/local/bin (may require sudo) and separately note that
if users place the built binary in$GOPATH/bin they must add $ (go env
GOPATH)/bin to their PATH; adjust the paragraph that references $GOPATH/bin and
the PATH export so it clearly describes this as an alternative to running task
cli:install rather than the single outcome.In
@content/docs/getting-started/setup-controller-environment.md:
- Line 186: Remove the stray backtick that follows the closing HTML details tag
by deleting the trailing backtick character after the "
line ends with a clean closing tag (i.e., change "" to "</details>"); locate the occurrence of the exact string "</details>" in the content and
remove only the backtick to avoid altering surrounding markup or content.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro **Run ID**: `93041a2f-c2ec-4c6f-b87c-e874e05f52e9` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 7c4fdeac8ae4a36daae35f4d9d5137b68c463428 and 57c350aa546027efdf35ac83abfc23c019a2c754. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `content/docs/getting-started/ocm-cli-installation.md` * `content/docs/getting-started/setup-controller-environment.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
content/docs/getting-started/ocm-cli-installation.md (1)
79-80:⚠️ Potential issue | 🟡 MinorFix grammar error.
Missing auxiliary verb "be" in the sentence.
📝 Proposed fix
-- Windows-specific logic (such as path detection and normalization) might tested via simulated +- Windows-specific logic (such as path detection and normalization) might be tested via simulated OS behavior on non-Windows runners.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/getting-started/ocm-cli-installation.md` around lines 79 - 80, Update the sentence "Windows-specific logic (such as path detection and normalization) might tested via simulated OS behavior on non-Windows runners." to include the missing auxiliary verb by changing "might tested" to "might be tested" so it reads "Windows-specific logic (such as path detection and normalization) might be tested via simulated OS behavior on non-Windows runners."
🧹 Nitpick comments (1)
content/docs/getting-started/deploy-helm-chart.md (1)
365-383: Consider using collapsible details for consistency.Earlier sections wrap command outputs in collapsible
<details>blocks (e.g., lines 87-93, 113-118, 136-141), but here the output is shown directly with an "Output:" label. For consistency, consider wrapping these outputs in collapsible sections as well.♻️ Optional consistency improvement
-Output: - -```text -NAME READY UP-TO-DATE AVAILABLE AGE -simple-podinfo 1/1 1 1 3m -``` +<details> +<summary>You should see this output</summary> + +```text +NAME READY UP-TO-DATE AVAILABLE AGE +simple-podinfo 1/1 1 1 3m +``` +</details> Verify the custom message you configured in the HelmRelease values is showing up in the application: ```shell kubectl get pods -l app.kubernetes.io/name=simple-podinfo \ -o jsonpath='{.items[0].spec.containers[0].env[?(@.name=="PODINFO_UI_MESSAGE")].value}'-Output:
-
text -Deployed with OCM! -
+Details
+You should see this output
+
+text +Deployed with OCM! +
+</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@content/docs/getting-started/deploy-helm-chart.mdaround lines 365 - 383,
The doc shows two command outputs directly with an "Output:" label instead of
using the collapsibleDetails
blocks used elsewhere; update the section
containing the pod list and the PODINFO_UI_MESSAGE output to wrap each output in
ablock with a short summary (e.g., "You should see this output") and
place the correspondingtextblock inside the details, replacing the plain
"Output:" label; locate the outputs near the kubectl invocation and the earlier
pod table examples to find and replace the direct output blocks accordingly.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Inline comments:
In@content/docs/getting-started/deploy-helm-chart.md:
- Line 421: The sentence in the link line "Tutorial: Deploy a Helm Chart (with
Bootstrap)" ends with the fragment "using a GitOps"; update that markdown line
to complete the sentence (for example: change "using a GitOps" to "using a
GitOps workflow for continuous deployment" or "using GitOps practices") so the
description reads grammatically complete and conveys the intended meaning.- Around line 120-121: The bare URL
"https://github.com/?tab=packages" in the sentence that begins
"To make your component public in GitHub Container Registry..." should be
wrapped in Markdown link syntax; replace the plain URL with a markdown link like
https://github.com/?tab=packages
so the linter no longer flags it and the link is properly formatted in the
paragraph that references thepackagestab and the
component-descriptors/ocm.software/ocm-k8s-toolkit/simplepackage.
Outside diff comments:
In@content/docs/getting-started/ocm-cli-installation.md:
- Around line 79-80: Update the sentence "Windows-specific logic (such as path
detection and normalization) might tested via simulated OS behavior on
non-Windows runners." to include the missing auxiliary verb by changing "might
tested" to "might be tested" so it reads "Windows-specific logic (such as path
detection and normalization) might be tested via simulated OS behavior on
non-Windows runners."
Nitpick comments:
In@content/docs/getting-started/deploy-helm-chart.md:
- Around line 365-383: The doc shows two command outputs directly with an
"Output:" label instead of using the collapsibleblocks used
elsewhere; update the section containing the pod list and the PODINFO_UI_MESSAGE
output to wrap each output in ablock with a short summary (e.g., "You
should see this output") and place the correspondingtextblock inside the
details, replacing the plain "Output:" label; locate the outputs near the
kubectl invocation and the earlier pod table examples to find and replace the
direct output blocks accordingly.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro **Run ID**: `402fa57c-675e-4d8b-ae62-b9d1481a7152` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between a381aeb7a1c26be8294a1194ccbcfb0657cf8630 and f57907466498d4390fc0403bbb8ec2d226f36555. </details> <details> <summary>📒 Files selected for processing (3)</summary> * `content/docs/getting-started/deploy-helm-chart.md` * `content/docs/getting-started/ocm-cli-installation.md` * `content/docs/how-to/download-resources-from-component-versions.md` </details> <details> <summary>🚧 Files skipped from review as they are similar to previous changes (1)</summary> * content/docs/how-to/download-resources-from-component-versions.md </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
There was a problem hiding this comment.
♻️ Duplicate comments (1)
content/docs/getting-started/deploy-helm-chart.md (1)
120-121:⚠️ Potential issue | 🟡 MinorUse a proper Markdown link for the GitHub packages URL.
This still reads like a raw URL in code style and is less usable than a link (and may trigger markdown lint depending on rules).
🔗 Suggested fix
-To make your component public in GitHub Container Registry, go to the `packages` tab in your GitHub repository `https://github.com/<your-namespace>?tab=packages`, +To make your component public in GitHub Container Registry, go to the [packages tab in your GitHub profile](https://github.com/<your-namespace>?tab=packages), select the package `component-descriptors/ocm.software/ocm-k8s-toolkit/simple`, and under "Package settings" change the visibility to `public`.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/getting-started/deploy-helm-chart.md` around lines 120 - 121, Replace the inline code-styled raw URL `https://github.com/<your-namespace>?tab=packages` with a proper Markdown link and remove the backticks around it so it renders as a clickable link; update the sentence that references the package `component-descriptors/ocm.software/ocm-k8s-toolkit/simple` to use clear link text pointing to the same URL (e.g., "GitHub packages for your repository") while keeping the package name inline as plain text for clarity.
🧹 Nitpick comments (1)
content/docs/getting-started/setup-controller-environment.md (1)
130-132: Prefer simpler wording in deployer description.Small readability tweak: replace “is able to apply” with “can apply”.
✏️ Suggested wording change
-We use [Flux](https://fluxcd.io/) as deployer. In theory, you could use any other deployer -that is able to apply a deployable resource to a Kubernetes cluster, +We use [Flux](https://fluxcd.io/) as deployer. In theory, you could use any other deployer +that can apply a deployable resource to a Kubernetes cluster, for instance [Argo CD](https://argo-cd.readthedocs.io/en/stable/).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/getting-started/setup-controller-environment.md` around lines 130 - 132, Replace the phrase "is able to apply" with the simpler "can apply" in the sentence that reads "that is able to apply a deployable resource to a Kubernetes cluster" (the sentence mentioning Flux and Argo CD) so it becomes "that can apply a deployable resource to a Kubernetes cluster"; keep the rest of the sentence unchanged for clarity.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@content/docs/getting-started/deploy-helm-chart.md`:
- Around line 120-121: Replace the inline code-styled raw URL
`https://github.com/<your-namespace>?tab=packages` with a proper Markdown link
and remove the backticks around it so it renders as a clickable link; update the
sentence that references the package
`component-descriptors/ocm.software/ocm-k8s-toolkit/simple` to use clear link
text pointing to the same URL (e.g., "GitHub packages for your repository")
while keeping the package name inline as plain text for clarity.
---
Nitpick comments:
In `@content/docs/getting-started/setup-controller-environment.md`:
- Around line 130-132: Replace the phrase "is able to apply" with the simpler
"can apply" in the sentence that reads "that is able to apply a deployable
resource to a Kubernetes cluster" (the sentence mentioning Flux and Argo CD) so
it becomes "that can apply a deployable resource to a Kubernetes cluster"; keep
the rest of the sentence unchanged for clarity.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8773780b-34ec-47e0-a9cd-b5bb580991b1
📒 Files selected for processing (2)
content/docs/getting-started/deploy-helm-chart.mdcontent/docs/getting-started/setup-controller-environment.md
piotrjanik
reviewed
Mar 4, 2026
piotrjanik
previously approved these changes
Mar 5, 2026
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
piotrjanik
approved these changes
Mar 5, 2026
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 was referenced Mar 5, 2026
This was referenced Mar 17, 2026
This was referenced Mar 26, 2026
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
3 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
This PR superseeds #703
Summary by CodeRabbit
Documentation
New Features
Chores