Skip to content
This repository was archived by the owner on Apr 13, 2026. It is now read-only.

chore(docs): Add new introduction / how-ocm-works document#765

Merged
morri-son merged 8 commits into
open-component-model:mainfrom
morri-son:add-introduction-doc
Mar 19, 2026
Merged

chore(docs): Add new introduction / how-ocm-works document#765
morri-son merged 8 commits into
open-component-model:mainfrom
morri-son:add-introduction-doc

Conversation

@morri-son

@morri-son morri-son commented Mar 18, 2026

Copy link
Copy Markdown
Contributor

On-behalf-of: Gerald Morrison (SAP) gerald.morrison@sap.com

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/)
  • Explanation / Concept (concepts/)
  • Reference (reference/)
  • Other (infrastructure, config, fixes)

Checklist

Summary by CodeRabbit

  • Documentation

    • Added a comprehensive "How OCM Works" guide covering packing, signing, transport patterns, extensibility, and Kubernetes deployment.
    • Removed the project overview page and shortened a Learning Path sentence.
    • Improved formatting, ordering, and minor wording across overview/benefits content; adjusted metadata weight for one page.
  • Chores

    • Updated repository keyword list (added "terraform").

…ntroduction.

On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com>
Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
@morri-son morri-son added area/documentation Documentation related kind/chore chore, maintenance, etc. labels Mar 18, 2026
@netlify

netlify Bot commented Mar 18, 2026

Copy link
Copy Markdown

Deploy Preview for open-component-model ready!

Name Link
🔨 Latest commit c8c58ff
🔍 Latest deploy log https://app.netlify.com/projects/open-component-model/deploys/69bc08917d1c4c000809e8c0
😎 Deploy Preview https://deploy-preview-765--open-component-model.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Mar 18, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: aa970604-559f-4a03-8f12-0ba26d9bc4d6

📥 Commits

Reviewing files that changed from the base of the PR and between 6e8c1c5 and c8c58ff.

📒 Files selected for processing (1)
  • content/docs/overview/how-ocm-works.md
✅ Files skipped from review due to trivial changes (1)
  • content/docs/overview/how-ocm-works.md

📝 Walkthrough

Walkthrough

Documentation reorganization: removed project.md, trimmed _index.md, added how-ocm-works.md (Pack/Sign/Transport/Deploy), reduced and reformatted benefits.md, and added terraform to .github/config/wordlist.txt. No code or public API changes.

Changes

Cohort / File(s) Summary
Overview Index
content/docs/overview/_index.md
Removed a sentence referencing project structure/About the OCM Project; paragraph now ends after linking to Concepts.
Benefits Page
content/docs/overview/benefits.md
Frontmatter weight changed from 122; content reflowed into shorter lines and minor wording/punctuation tweaks.
Project Overview Removal
content/docs/overview/project.md
Entire page and frontmatter deleted (~20 lines removed).
New Workflow Documentation
content/docs/overview/how-ocm-works.md
Added new page describing OCM end-to-end workflow (Pack, Sign, Transport, Deploy), extensibility, and sovereign-cloud security callout.
Repository Config
.github/config/wordlist.txt
Added keyword terraform (file now shows no trailing newline).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • piotrjanik

Poem

🐰
A tidy path of pages, neat and warm,
Pack, sign, transport — I watch the swarm,
Docs trimmed and reordered, new steps in view,
Terraform whispered in the wordlist too,
Hops of joy — the rabbit cheers for you!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately reflects the main addition (new how-ocm-works document), though it downplays the removal of the outdated project.md file, which is a significant secondary change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@morri-son morri-son linked an issue Mar 18, 2026 that may be closed by this pull request
3 tasks
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 coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 92a14d6 and cd4c21d.

⛔ Files ignored due to path filters (1)
  • content/docs/overview/ocm-uses-cases.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • content/docs/overview/_index.md
  • content/docs/overview/benefits.md
  • content/docs/overview/how-ocm-works.md
  • content/docs/overview/project.md
💤 Files with no reviewable changes (1)
  • content/docs/overview/project.md

Comment thread content/docs/overview/how-ocm-works.md
Comment thread content/docs/overview/how-ocm-works.md Outdated
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 morri-son marked this pull request as ready for review March 19, 2026 13:26
@morri-son morri-son requested a review from a team as a code owner March 19, 2026 13:26

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♻️ Duplicate comments (2)
content/docs/overview/how-ocm-works.md (2)

95-95: ⚠️ Potential issue | 🔴 Critical

Replace 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 | 🔴 Critical

Fix invalid relref shortcode 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

📥 Commits

Reviewing files that changed from the base of the PR and between cd4c21d and 2b386a2.

📒 Files selected for processing (2)
  • .github/config/wordlist.txt
  • content/docs/overview/how-ocm-works.md
✅ Files skipped from review due to trivial changes (1)
  • .github/config/wordlist.txt

fabianburth
fabianburth previously approved these changes Mar 19, 2026
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>
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com>
Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
@morri-son morri-son enabled auto-merge (squash) March 19, 2026 14:31
@morri-son morri-son merged commit d08947d into open-component-model:main Mar 19, 2026
10 checks passed
ocmbot Bot pushed a commit that referenced this pull request Mar 19, 2026
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
@morri-son morri-son deleted the add-introduction-doc branch March 19, 2026 14:47
@coderabbitai coderabbitai Bot mentioned this pull request Mar 20, 2026
7 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Mar 20, 2026
7 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Mar 30, 2026
7 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area/documentation Documentation related kind/chore chore, maintenance, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Website: Create Introduction document

3 participants