chore(docs): Add new introduction / how-ocm-works document#765
Conversation
…ntroduction. On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
✅ 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 (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughDocumentation reorganization: removed Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
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)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 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>
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
content/docs/overview/benefits.md (1)
59-59: Tighten phrasing for readability.Line 59 can be simplified by replacing “in a transparent way” with “transparently.”
Suggested edit
-The design of OCM makes it easy to add new features, so anyone can suggest, review, and merge improvements in a transparent way. +The design of OCM makes it easy to add new features, so anyone can suggest, review, and merge improvements transparently.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/overview/benefits.md` at line 59, Replace the phrase "in a transparent way" with the single word "transparently" in the sentence that currently reads "The design of OCM makes it easy to add new features, so anyone can suggest, review, and merge improvements in a transparent way." to tighten phrasing and improve readability; locate this exact sentence (containing "in a transparent way") in benefits.md and update it to end with "transparently."
🤖 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/overview/how-ocm-works.md`:
- Line 103: Remove the invalid placeholder line that begins with '//' and the
malformed emphasis/link referencing "Signing" (the placeholder on line 103 in
how-ocm-works.md) because it breaks markdown linting; either delete that line or
replace it with a proper markdown link/reference (e.g., a valid relref or an
HTML comment <!-- ... -->) and ensure the file ends with exactly one trailing
newline to satisfy MD047.
- Line 46: The markdown link uses an invalid Hugo relref shortcode "(--- relref
"signing-and-verification-concept.md" ---)"; replace that fragment in the line
that reads 'Read more about [how signing works](--- relref
"signing-and-verification-concept.md" ---).' with the correct Hugo relref
shortcode format so the link resolves (use the Hugo relref shortcode syntax
around "signing-and-verification-concept.md" instead of the parentheses-wrapped
"(--- ... ---)").
---
Nitpick comments:
In `@content/docs/overview/benefits.md`:
- Line 59: Replace the phrase "in a transparent way" with the single word
"transparently" in the sentence that currently reads "The design of OCM makes it
easy to add new features, so anyone can suggest, review, and merge improvements
in a transparent way." to tighten phrasing and improve readability; locate this
exact sentence (containing "in a transparent way") in benefits.md and update it
to end with "transparently."
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 24ff620b-8a19-4917-872a-cec2b21831e7
⛔ Files ignored due to path filters (1)
content/docs/overview/ocm-uses-cases.pngis excluded by!**/*.png
📒 Files selected for processing (4)
content/docs/overview/_index.mdcontent/docs/overview/benefits.mdcontent/docs/overview/how-ocm-works.mdcontent/docs/overview/project.md
💤 Files with no reviewable changes (1)
- content/docs/overview/project.md
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.
♻️ Duplicate comments (2)
content/docs/overview/how-ocm-works.md (2)
95-95:⚠️ Potential issue | 🔴 CriticalReplace malformed Signing bullet that breaks markdown lint.
Line 95 has invalid link/emphasis syntax and is the root cause of the MD037 pipeline failure.
Proposed fix
-- **[Signing] -- relref signing-and-verification-concept.md" ** — cryptographic integrity, explained. +- **[Signing]({{< relref "signing-and-verification-concept.md" >}})** — cryptographic integrity, explained.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/overview/how-ocm-works.md` at line 95, The bullet at "Signing" has unbalanced emphasis and a malformed relref link causing MD037 failures; replace the broken token with a properly formatted link and balanced emphasis by using the relref target "signing-and-verification-concept.md" and ensuring the surrounding asterisks pair correctly (e.g., make the text either bold or plain and insert a correct relref link for "signing-and-verification-concept.md"), so the line reads with valid markdown and the MD037 linter passes.
46-46:⚠️ Potential issue | 🔴 CriticalFix invalid
relrefshortcode syntax.Line 46 uses
(--- relref ... ---), which is not valid Hugo shortcode syntax and won’t resolve.Proposed fix
-Read more about [how signing works](--- relref "signing-and-verification-concept.md" ---). +Read more about [how signing works]({{< relref "signing-and-verification-concept.md" >}}).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/overview/how-ocm-works.md` at line 46, The markdown contains an invalid Hugo shortcode in the link text: replace the broken snippet Read more about [how signing works](--- relref "signing-and-verification-concept.md" ---). with a proper Hugo relref usage for the target document (use the Hugo relref shortcode for "signing-and-verification-concept.md" inside the link so the link resolves correctly), updating the line in content/docs/overview/how-ocm-works.md where that broken relref appears.
🤖 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/overview/how-ocm-works.md`:
- Line 95: The bullet at "Signing" has unbalanced emphasis and a malformed
relref link causing MD037 failures; replace the broken token with a properly
formatted link and balanced emphasis by using the relref target
"signing-and-verification-concept.md" and ensuring the surrounding asterisks
pair correctly (e.g., make the text either bold or plain and insert a correct
relref link for "signing-and-verification-concept.md"), so the line reads with
valid markdown and the MD037 linter passes.
- Line 46: The markdown contains an invalid Hugo shortcode in the link text:
replace the broken snippet Read more about [how signing works](--- relref
"signing-and-verification-concept.md" ---). with a proper Hugo relref usage for
the target document (use the Hugo relref shortcode for
"signing-and-verification-concept.md" inside the link so the link resolves
correctly), updating the line in content/docs/overview/how-ocm-works.md where
that broken relref appears.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8c88d91a-5bb9-4063-9239-b3bf3e0945a5
📒 Files selected for processing (2)
.github/config/wordlist.txtcontent/docs/overview/how-ocm-works.md
✅ Files skipped from review due to trivial changes (1)
- .github/config/wordlist.txt
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> <!-- markdownlint-disable MD041 --> #### What this PR does / why we need it - Add a new introduction document for the `overview` section. - Introduce word wraps for the benefits.md as lines were super-long - Remove old projects.md and referenced png as it not up-to-date anymore now that we have a monorepo. #### Type of content - [ ] Tutorial (`getting-started/` or `tutorials/`) - [ ] How-to Guide (`how-to/`) - [x] Explanation / Concept (`concepts/`) - [ ] Reference (`reference/`) - [ ] Other (infrastructure, config, fixes) #### Checklist - [x] I have read and followed the [Contributing Guide](https://github.com/open-component-model/ocm-website/blob/main/CONTRIBUTING.md) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a comprehensive guide on the complete OCM workflow: packing, signing, transport patterns, and Kubernetes-based deployment. * Removed the project overview page and trimmed an instructional sentence from the Learning Path. * Improved formatting, readability, and ordering across several overview pages; minor wording clarifications. * **Chores** * Updated repository keyword list (added "terraform"). <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> d08947d
On-behalf-of: Gerald Morrison (SAP) gerald.morrison@sap.com
What this PR does / why we need it
overviewsection.Type of content
getting-started/ortutorials/)how-to/)concepts/)reference/)Checklist
Summary by CodeRabbit
Documentation
Chores