docs(website): rename types to UpperCamelCase#2327
Merged
morri-son merged 10 commits intoApr 29, 2026
Merged
Conversation
✅ Deploy Preview for ocm-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughDocumentation updates standardize the local blob access type name from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
7 tasks
Contributor
|
There is something wrong with the commit history here. 🤔 Can you please rebase off of a clean branch? |
Skarlso
reviewed
Apr 22, 2026
Contributor
|
What I'm missing is the registration of the UpperCase name. 🤔 Where is that PR? |
frewilhelm
reviewed
Apr 22, 2026
matthiasbruns
left a comment
Contributor
There was a problem hiding this comment.
this pr looks mixed up and renames a lot of other types - I do not think this is a huge problem, just clean up the title & description and close duplicated PRs
Update all localBlob/v1 references to LocalBlob/v1 across website documentation. Also fix unversioned localBlob in signing concept doc and remove unnecessary Helm/v1 deprecation callout. The --upload-as localBlob CLI flag stays lowercase (enum value, not a type name). Legacy content_versioned/ docs are intentionally left unchanged. Ref: open-component-model/ocm-project#962 Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
32d2394 to
a9c15ed
Compare
Contributor
Author
|
@matthiasbruns |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@website/content/docs/how-to/download-resources-from-component-versions.md`:
- Line 220: Replace the incorrectly-cased access type example "LocalBlob/v1"
with the registered access type name "localBlob/v1" in the documentation example
so copy-paste matches the descriptor constants; update the example string
wherever "LocalBlob/v1" appears (e.g., the example showing access type in the
component version download docs) to use the exact registered symbol
"localBlob/v1".
In `@website/content/docs/reference/input-and-access-types.md`:
- Around line 153-156: The doc incorrectly labels `LocalBlob/v1` as canonical
and `localBlob` as legacy; update the text so `localBlob` (and `localBlob/v1`)
are shown as the canonical/registered form and `LocalBlob/v1` as the
legacy/alias, adjusting the heading and descriptive sentence for the
`LocalBlob/v1` block and the related occurrence around the other noted location
(line ~171) to reflect that `localBlob` is canonical/registered and
`LocalBlob/v1` is legacy.
🪄 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: e041faa9-dc3f-4b1b-9c72-07f1518a8936
📒 Files selected for processing (6)
website/content/docs/concepts/component-identity.mdwebsite/content/docs/concepts/signing-and-verification-concept.mdwebsite/content/docs/getting-started/create-component-version.mdwebsite/content/docs/how-to/download-resources-from-component-versions.mdwebsite/content/docs/reference/input-and-access-types.mdwebsite/content/docs/tutorials/advanced-component-constructor.md
matthiasbruns
previously approved these changes
Apr 24, 2026
Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
Skarlso
reviewed
Apr 27, 2026
Skarlso
reviewed
Apr 27, 2026
Co-authored-by: Gergely Bräutigam <skarlso777@gmail.com> Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com>
Skarlso
requested changes
Apr 28, 2026
Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
Skarlso
approved these changes
Apr 28, 2026
frewilhelm
approved these changes
Apr 28, 2026
matthiasbruns
approved these changes
Apr 28, 2026
ocmbot Bot
pushed a commit
that referenced
this pull request
Apr 29, 2026
## Summary - Rename all `localBlob/v1` references to `LocalBlob/v1` across website documentation (6 files) - Fix unversioned `localBlob` → `LocalBlob/v1` in signing concept doc - Add "Legacy alias: `localBlob`" note in the reference doc (consistent with `OCIImageLayer/v1` and `Helm/v1` style) - Remove unnecessary `Helm/v1` deprecation callout (no other type has one) ## What's unchanged (by design) - `--upload-as localBlob` CLI flag — this is an enum value, not a type name - `content_versioned/` legacy docs — intentionally frozen (same approach as #2244) ## Dependencies - **Depends on:** #2244 — this PR is rebased on top of `website-upper-camel-case-types` and should be merged after #2244 ## Related - Part of open-component-model/ocm-project#962 - Related code PRs: #2323 (descriptor), #2324 (constructor), #2325 (cli), #2326 (controller) --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> b742838
7 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
localBlob/v1references toLocalBlob/v1across website documentation (6 files)localBlob→LocalBlob/v1in signing concept doclocalBlob" note in the reference doc (consistent withOCIImageLayer/v1andHelm/v1style)Helm/v1deprecation callout (no other type has one)What's unchanged (by design)
--upload-as localBlobCLI flag — this is an enum value, not a type namecontent_versioned/legacy docs — intentionally frozen (same approach as docs(website): align type notation to UpperCamelCase #2244)Dependencies
website-upper-camel-case-typesand should be merged after docs(website): align type notation to UpperCamelCase #2244Related
typenotation for access and input ocm-project#962