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

chore: update resource api and remove duplicated guide#792

Merged
morri-son merged 4 commits into
open-component-model:mainfrom
frewilhelm:update-resource-interval
Mar 30, 2026
Merged

chore: update resource api and remove duplicated guide#792
morri-son merged 4 commits into
open-component-model:mainfrom
frewilhelm:update-resource-interval

Conversation

@frewilhelm

Copy link
Copy Markdown
Contributor

What this PR does / why we need it

Upate resource API interval and skipVerify. Found a duplicated guide in How-To and Tutorials about configuring credentials for the ocm-k8s-toolkit. I kept the How-To because the guide itself is pretty short

Which issue(s) this PR is related to

Related to open-component-model/open-component-model#2116

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: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
@netlify

netlify Bot commented Mar 30, 2026

Copy link
Copy Markdown

Deploy Preview for open-component-model ready!

Name Link
🔨 Latest commit c806c39
🔍 Latest deploy log https://app.netlify.com/projects/open-component-model/deploys/69ca43ba5d56300008038548
😎 Deploy Preview https://deploy-preview-792--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 30, 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: 10adc5fb-5a5b-4378-88ef-aca779b569c6

📥 Commits

Reviewing files that changed from the base of the PR and between 1acd725 and c806c39.

📒 Files selected for processing (8)
  • content/blog/2026-03-16-ocm-controllers-differences.md
  • content/docs/concepts/credential-system.md
  • content/docs/concepts/ocm-controllers.md
  • content/docs/getting-started/deploy-helm-chart.md
  • content/docs/how-to/deploy-manifests-with-deployer.md
  • content/docs/tutorials/deploy-helm-chart-bootstrap.md
  • content_versioned/version-legacy/docs/getting-started/deploy-helm-chart.md
  • content_versioned/version-legacy/docs/tutorials/deploy-helm-chart-bootstrap.md
💤 Files with no reviewable changes (2)
  • content_versioned/version-legacy/docs/getting-started/deploy-helm-chart.md
  • content_versioned/version-legacy/docs/tutorials/deploy-helm-chart-bootstrap.md
✅ Files skipped from review due to trivial changes (2)
  • content/docs/concepts/ocm-controllers.md
  • content/docs/concepts/credential-system.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • content/blog/2026-03-16-ocm-controllers-differences.md
  • content/docs/tutorials/deploy-helm-chart-bootstrap.md

📝 Walkthrough

Walkthrough

Updated documentation: removed the “Credentials for OCM Controllers” tutorial, replaced in-document links to the new how-to path docs/how-to/configure-credentials-ocm-controllers.md, and removed several interval fields from YAML examples across multiple docs and versioned copies.

Changes

Cohort / File(s) Summary
Deleted tutorial
content/docs/tutorials/configure-credentials-for-controllers.md
Removed the entire credentials tutorial page and its front-matter.
Credentials link updates
content/docs/concepts/credential-system.md, content/docs/concepts/ocm-controllers.md, content/docs/getting-started/deploy-helm-chart.md, content/docs/how-to/deploy-manifests-with-deployer.md, content/docs/tutorials/deploy-helm-chart-bootstrap.md, content_versioned/.../docs/getting-started/deploy-helm-chart.md, content_versioned/.../docs/tutorials/deploy-helm-chart-bootstrap.md, content/blog/2026-03-16-ocm-controllers-differences.md
Replaced references pointing at /docs/tutorials/configure-credentials-for-controllers.md with docs/how-to/configure-credentials-ocm-controllers.md (link target updated in multiple places).
YAML interval removals
content/docs/getting-started/deploy-helm-chart.md, content/docs/how-to/deploy-manifests-with-deployer.md, content/docs/tutorials/deploy-helm-chart-bootstrap.md, content_versioned/.../docs/getting-started/deploy-helm-chart.md, content_versioned/.../docs/tutorials/deploy-helm-chart-bootstrap.md, content/blog/2026-03-16-ocm-controllers-differences.md
Removed interval fields from Resource / additionalStatusFields example YAML snippets in several docs and versioned copies; other example intervals left unchanged.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested labels

area/documentation, kind/chore

Suggested reviewers

  • morri-son
  • matthiasbruns

Poem

🐰 I hopped through docs both old and new,
Links retied and intervals few.
A tutorial vanished from the glade,
Replaced by how-to paths well laid.
Hooray — the docs now springtime-fresh and true! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: updating the resource API (interval and skipVerify) and removing a duplicated guide for credentials configuration.
Description check ✅ Passed The description is related to the changeset, explaining the updates to resource API fields and removal of the duplicated credentials guide from Tutorials in favor of the How-To version.
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.

@frewilhelm

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Mar 30, 2026

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@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: 1

🤖 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/concepts/credential-system.md`:
- Line 93: Update the broken relref target in the link labeled "Tutorial:
Credentials for OCM Controllers" by replacing the nonexistent filename
configure-credentials-for-controllers.md with the actual guide filename
configure-credentials-ocm-controllers.md so the relref points to the correct
internal document.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4b525197-3cce-4712-b45d-9d026d8aefb3

📥 Commits

Reviewing files that changed from the base of the PR and between e1f2e22 and 1acd725.

📒 Files selected for processing (7)
  • content/blog/2026-03-16-ocm-controllers-differences.md
  • content/docs/concepts/credential-system.md
  • content/docs/concepts/ocm-controllers.md
  • content/docs/getting-started/deploy-helm-chart.md
  • content/docs/how-to/deploy-manifests-with-deployer.md
  • content/docs/tutorials/configure-credentials-for-controllers.md
  • content/docs/tutorials/deploy-helm-chart-bootstrap.md
💤 Files with no reviewable changes (3)
  • content/blog/2026-03-16-ocm-controllers-differences.md
  • content/docs/how-to/deploy-manifests-with-deployer.md
  • content/docs/tutorials/configure-credentials-for-controllers.md

Comment thread content/docs/concepts/credential-system.md Outdated
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
@frewilhelm frewilhelm marked this pull request as ready for review March 30, 2026 09:34
@frewilhelm frewilhelm requested a review from a team as a code owner March 30, 2026 09:34
@frewilhelm

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Mar 30, 2026

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@morri-son morri-son merged commit ea2485c into open-component-model:main Mar 30, 2026
10 checks passed
ocmbot Bot pushed a commit that referenced this pull request Mar 30, 2026
<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it

Upate resource API `interval` and `skipVerify`. Found a duplicated guide
in `How-To` and `Tutorials` about configuring credentials for the
ocm-k8s-toolkit. I kept the How-To because the guide itself is pretty
short

#### Which issue(s) this PR is related to

Related to
open-component-model/open-component-model#2116

#### 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/`)
- [x] 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)
- [x] All commands/code snippets are tested and can be copy-pasted

---------

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com> ea2485c
@frewilhelm frewilhelm deleted the update-resource-interval branch March 30, 2026 11:43
@coderabbitai coderabbitai Bot mentioned this pull request Mar 30, 2026
7 tasks
morri-son pushed a commit to jakobmoellerdev/ocm-website that referenced this pull request Apr 10, 2026
…t-model#792)

<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it

Upate resource API `interval` and `skipVerify`. Found a duplicated guide
in `How-To` and `Tutorials` about configuring credentials for the
ocm-k8s-toolkit. I kept the How-To because the guide itself is pretty
short

#### Which issue(s) this PR is related to

Related to
open-component-model/open-component-model#2116

#### 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/`)
- [x] 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)
- [x] All commands/code snippets are tested and can be copy-pasted

---------

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@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.

2 participants