Skip to content

chore(docs): Add installation guides to README.md#1996

Merged
frewilhelm merged 5 commits into
open-component-model:mainfrom
frewilhelm:adj-readme
Mar 17, 2026
Merged

chore(docs): Add installation guides to README.md#1996
frewilhelm merged 5 commits into
open-component-model:mainfrom
frewilhelm:adj-readme

Conversation

@frewilhelm

@frewilhelm frewilhelm commented Mar 16, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

What this PR does / why we need it

The current README.md did not get much love recently. This PR updates some sections and adds installation guides for the CLI and controllers

Which issue(s) this PR fixes

Fixes open-component-model/ocm-project#924

Summary by CodeRabbit

  • Documentation
    • Enhanced README formatting with improved line-wrapping and paragraph restructuring for better readability.
    • Updated introductory text with adjusted phrasing, capitalization, and line breaks for clarity.
    • Reorganized documentation structure with refined heading hierarchy.
    • Adjusted contributing and licensing references for consistent inline wrapping and link formatting.

@github-actions github-actions Bot added the kind/chore chore, maintenance, etc. label Mar 16, 2026
@coderabbitai

coderabbitai Bot commented Mar 16, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

README.md documentation restructured with updated heading hierarchy, improved line wrapping, and formatting adjustments. Headings converted from H2 to H3 level for certain sections, new top-level sections added, and introductory text rewording applied throughout for consistency.

Changes

Cohort / File(s) Summary
Documentation Structure & Formatting
README.md		 Heading hierarchy restructured (CLI section changed from H2 to H3), new top-level sections introduced (K8s Toolkit, Language Bindings), introductory text rewording with adjusted line breaks, improved line wrapping for paragraph formatting, and updated link/reference formatting throughout.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

  • jakobmoellerdev
  • morri-son
  • piotrjanik

Poem

A rabbit hops through markdown lines,
Fixing breaks and design signs,
Headers hop from two to three,
Formatting flows with jubilee! 🐰✨

🚥 Pre-merge checks | ✅ 2 | ❌ 3

❌ Failed checks (3 warnings)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title states 'Add installation guides to README.md' but the summary shows primarily formatting and structural changes with no substantive installation guide content added. Update the title to accurately reflect the changes, such as 'chore(docs): Update README.md formatting and structure' if installation guides were not substantially added.
Linked Issues check ⚠️ Warning The PR addresses issue #924 but incompletely: while README.md was updated, the summary shows no evidence of substantive installation guides, Helm chart documentation, or mention of Flux/KRO requirements as specifically requested. Add substantive installation guide sections covering Helm chart setup, cluster application steps, and required dependencies (Flux, KRO) as outlined in issue #924.
Out of Scope Changes check ⚠️ Warning The PR includes various structural and formatting changes to README.md such as heading level changes and section reorganization that extend beyond the installation guide scope requested in issue #924. Separate the formatting and structural changes from the core installation guide work, or clearly justify how each change supports the installation guide objectives.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

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

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

@github-actions github-actions Bot added the size/s Small label Mar 16, 2026
morri-son
morri-son previously approved these changes Mar 16, 2026
View reviewed changes
@morri-son morri-son dismissed their stale review March 16, 2026 14:23

still in draft

@frewilhelm
add installation guides
b15c391 
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
@frewilhelm
add more context to OCM k8s toolkit
65364bb 
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
@frewilhelm
minor style and typo fixes
a48a5f3 
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
@frewilhelm frewilhelm marked this pull request as ready for review March 16, 2026 14:50
@frewilhelm frewilhelm requested a review from a team as a code owner March 16, 2026 14:50
piotrjanik
piotrjanik reviewed Mar 17, 2026
View reviewed changes
Comment thread README.md
piotrjanik
piotrjanik approved these changes Mar 17, 2026
View reviewed changes

@piotrjanik piotrjanik left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, Good enough. For sure we're missign here brew install and it would be nice to update cli's image tag after each release.

@frewilhelm frewilhelm enabled auto-merge (squash) March 17, 2026 12:04
@frewilhelm frewilhelm merged commit 16489e1 into open-component-model:main Mar 17, 2026
18 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 12, 2026
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@piotrjanik piotrjanik piotrjanik approved these changes

@morri-son morri-son morri-son approved these changes

Assignees

No one assigned

Labels

kind/chore chore, maintenance, etc. size/s Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

CLI and Controller Installation Instructions

3 participants

@frewilhelm @piotrjanik @morri-son