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

docs: update migration section to correct version names and defaults#797

Merged
jakobmoellerdev merged 2 commits into
open-component-model:mainfrom
fabianburth:fix/release-blog-post
Apr 7, 2026
Merged

docs: update migration section to correct version names and defaults#797
jakobmoellerdev merged 2 commits into
open-component-model:mainfrom
fabianburth:fix/release-blog-post

Conversation

@fabianburth

Copy link
Copy Markdown
Contributor

What this PR does / why we need it

Update blog post to updated version names and defaults. The current information is outdated.

Which issue(s) this PR is related to

Type of content

  • Tutorial (getting-started/ or tutorials/)
  • How-to Guide (how-to/)
  • Explanation / Concept (concepts/)
  • Reference (reference/)
  • Other (infrastructure, config, fixes)

Checklist

  • I have read and followed the Contributing Guide
  • All commands/code snippets are tested and can be copy-pasted

Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth fabianburth requested a review from a team as a code owner April 7, 2026 07:09
@netlify

netlify Bot commented Apr 7, 2026

Copy link
Copy Markdown

Deploy Preview for open-component-model ready!

Name Link
🔨 Latest commit 681161f
🔍 Latest deploy log https://app.netlify.com/projects/open-component-model/deploys/69d4aefc77ea0b0007bf2d98
😎 Deploy Preview https://deploy-preview-797--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 Apr 7, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a9bf972b-3fb9-4658-bc87-061095e482c1

📥 Commits

Reviewing files that changed from the base of the PR and between 078e487 and 681161f.

📒 Files selected for processing (1)
  • content_versioned/version-legacy/docs/tutorials/best-practices.md
✅ Files skipped from review due to trivial changes (1)
  • content_versioned/version-legacy/docs/tutorials/best-practices.md

📝 Walkthrough

Walkthrough

Updated documentation version labels: v1 docs are explicitly labeled "legacy"; v2 docs label changed from "dev" to "latest" and are specified as the default. Also updated a YAML $schema URL in a best-practices doc and minor text wrapping in the blog post.

Changes

Cohort / File(s) Summary
Documentation Labeling
content/blog/ocm_v2_announcement.md
Replaced "Legacy" wording with explicit v1 docs labeled "legacy"; changed v2 docs label from "dev" to "latest" and marked it as the default. Minor paragraph wrapping adjusted.
YAML schema hint
content_versioned/version-legacy/docs/tutorials/best-practices.md
Updated YAML $schema URL from https://ocm.software/schemas/configuration-schema.yaml to https://ocm.software/latest/schemas/bindings/go/constructor/schema-2020-12.json. No other changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • frewilhelm

Poem

🐰 I hopped through lines to change a name with care,
v1 now "legacy", v2 "latest" everywhere,
A tidy schema swapped in a guide so neat,
Docs hop forward on well-ordered feet — 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating documentation to correct version names and defaults in the migration section.
Description check ✅ Passed The description is related to the changeset, explaining that the blog post and documentation are being updated to reflect corrected version names and defaults.
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

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.

Skarlso
Skarlso previously approved these changes Apr 7, 2026
morri-son
morri-son previously approved these changes Apr 7, 2026
frewilhelm
frewilhelm previously approved these changes Apr 7, 2026
Signed-off-by: Fabian Burth <fabian.burth@sap.com>
@fabianburth fabianburth dismissed stale reviews from frewilhelm, morri-son, and Skarlso via 681161f April 7, 2026 07:15
@jakobmoellerdev jakobmoellerdev merged commit eae9213 into open-component-model:main Apr 7, 2026
10 checks passed
ocmbot Bot pushed a commit that referenced this pull request Apr 7, 2026
…797)

<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it
Update blog post to updated version names and defaults. The current
information is outdated.

#### Which issue(s) this PR is related to
<!--
Usage: `Related to #<issue number>`, or `Related to (paste link of
issue)`.
-->

#### Type of content
<!--
Which section does this PR target? See CONTRIBUTING.md for guidance.
-->
- [ ] Tutorial (`getting-started/` or `tutorials/`)
- [ ] How-to Guide (`how-to/`)
- [ ] Explanation / Concept (`concepts/`)
- [ ] Reference (`reference/`)
- [ ] Other (infrastructure, config, fixes)

#### Checklist

- [ ] I have read and followed the [Contributing
Guide](https://github.com/open-component-model/ocm-website/blob/main/CONTRIBUTING.md)
- [ ] All commands/code snippets are tested and can be copy-pasted

---------

Signed-off-by: Fabian Burth <fabian.burth@sap.com> eae9213
morri-son pushed a commit to jakobmoellerdev/ocm-website that referenced this pull request Apr 10, 2026
…pen-component-model#797)

<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it
Update blog post to updated version names and defaults. The current
information is outdated.

#### Which issue(s) this PR is related to
<!--
Usage: `Related to #<issue number>`, or `Related to (paste link of
issue)`.
-->

#### Type of content
<!--
Which section does this PR target? See CONTRIBUTING.md for guidance.
-->
- [ ] Tutorial (`getting-started/` or `tutorials/`)
- [ ] How-to Guide (`how-to/`)
- [ ] Explanation / Concept (`concepts/`)
- [ ] Reference (`reference/`)
- [ ] Other (infrastructure, config, fixes)

#### Checklist

- [ ] I have read and followed the [Contributing
Guide](https://github.com/open-component-model/ocm-website/blob/main/CONTRIBUTING.md)
- [ ] All commands/code snippets are tested and can be copy-pasted

---------

Signed-off-by: Fabian Burth <fabian.burth@sap.com>
Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants