docs(website): align type notation to UpperCamelCase by morri-son · Pull Request #2244 · open-component-model/open-component-model

morri-son · 2026-04-10T13:22:44Z

Summary

Update input type names (Dir/v1, File/v1, Helm/v1, UTF8/v1) and access type names (OCIImage, OCIImageLayer) across website documentation to use UpperCamelCase as the canonical form
Lowercase forms are documented as backward-compatible aliases
13 files changed across content/docs/ and content_templates/

What's unchanged (by design)

localBlob references — deferred to a later PR
helmChart — this is an artifact type, not an access/input type
ociArtifactDigest/v1 — algorithm name, not a type alias
--upload-as ociArtifact CLI flag values — CLI flag semantics unchanged
content_versioned/version-legacy/ — historical docs left as-is

Walkthrough

This PR updates documentation YAML examples across the website to standardize type identifiers to UpperCamelCase and versioned forms (e.g., ociArtifact → OCIImage/v1, file/file/v1 → File/v1, dir/v1 → Dir/v1, helm/v1 → Helm/v1, utf8/v1 → UTF8/v1).

Changes

Cohort / File(s)	Summary
OCI Access Type updates `website/content/docs/concepts/component-identity.md`, `website/content/docs/concepts/signing-and-verification-concept.md`, `website/content/docs/how-to/container-image-usage.md`, `website/content/docs/how-to/download-resources-from-component-versions.md`, `website/content/docs/how-to/deploy-helm-chart.md`, `website/content/docs/tutorials/deploy-helm-chart-bootstrap.md`, `website/content/docs/how-to/transfer-helm-charts.md`	Replaced `ociArtifact` / `ociArtifact/v1` with `OCIImage/v1` in component/resource/access examples and output snippets; imageReference and digest fields unchanged.
Input Type capitalization/versioning `website/content/docs/getting-started/create-component-version.md`, `website/content/docs/getting-started/deploy-manifests-with-deployer.md`, `website/content/docs/reference/input-and-access-types.md`, `website/content/docs/tutorials/advanced-component-constructor.md`, `website/content/docs/tutorials/configure-resolvers.md`, `website/content/docs/tutorials/deploy-helm-chart-bootstrap.md`, `website/content_templates/template-tutorial.md`	Normalized input types to UpperCamelCase versioned identifiers: `file`/`file/v1` → `File/v1`, `dir`/`dir/v1` → `Dir/v1`, `helm`/`helm/v1` → `Helm/v1`, `utf8` → `UTF8/v1` across YAML snippets and reference docs.
Combined examples & how-tos `website/content/docs/getting-started/create-component-version.md`, `website/content/docs/how-to/transfer-helm-charts.md`, `website/content/docs/tutorials/deploy-helm-chart-bootstrap.md`	Applied both access-type (`OCIImage/v1`) and input-type (`File/v1`, `Helm/v1`, etc.) updates in constructor, transfer, and component-version example snippets to keep examples consistent.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

feat: register UpperCamelCase as primary type for input types (skip localBlob so far) #2057: Aligning code-level type identifiers to UpperCamelCase and registering lowercase aliases, directly corresponding to these doc updates.

Suggested labels

component/ocm-website

Suggested reviewers

morri-son
Skarlso
jakobmoellerdev

Poem

🐰 I hopped through docs with nimble feet,
Changing ociArtifact to OCIImage/v1 neat,
file now dresses as File/v1 so fine,
helm wears Helm/v1 — a tidy line,
Snippets refreshed, the site looks divine.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: updating type notation to use UpperCamelCase across documentation examples.
Description check	✅ Passed	The description is clearly related to the changeset, providing a comprehensive summary of the updates to type notation and explicitly listing unchanged items by design.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ 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.}

netlify · 2026-04-10T13:23:21Z

✅ Deploy Preview for ocm-website ready!

Name	Link
🔨 Latest commit	`b26fe16`
🔍 Latest deploy log	https://app.netlify.com/projects/ocm-website/deploys/69eb1ddf762a18000808c538
😎 Deploy Preview	https://deploy-preview-2244--ocm-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

morri-son · 2026-04-10T14:50:48Z

@coderabbitai review

coderabbitai · 2026-04-10T14:50:57Z

✅ 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.

…ocalBlob so far) (#2057) On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com>  ## Summary Register UpperCamelCase forms as the primary (default) serialization type for all input types, consistent with the existing convention used by access OCIImage/v1, Helm/v1 etc. ## Changes: - Input types: File/v1 (was file/v1), Dir/v1 (was dir/v1), UTF8/v1 (was utf8/v1), Helm/v1 (was helm/v1) **The localBlob/v1 access type IS NOT touched in the PR.**, but already prepared (including updating all tests using the new types) in [this branch](https://github.com/morri-son/open-component-model/tree/align-type-notation-for-acces-and-input). Lowercase forms remain registered as backward-compatible aliases so existing component descriptors and constructors continue to work. Adds named constants (Type, LegacyType) to each spec package following the pattern already established by access type packages. Also adds Type constants for OCIImage, OCIImageLayer, and Helm access types where hardcoded strings were previously used in schema registrations. ## Which issue(s) this PR fixes Usage: Fixes open-component-model/ocm-project#962 ## Dependencies Tests for type casing have been split off to PR #2071 to get the CI test not failing. ## Related - ocm-spec: open-component-model/ocm-spec#141 - ocm v1: open-component-model/ocm#1881 - ocm-website: #2244 ## Verification - [x] I have tested the changes locally by running `ocm` --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

…ocalBlob so far) (open-component-model#2057) On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com>  ## Summary Register UpperCamelCase forms as the primary (default) serialization type for all input types, consistent with the existing convention used by access OCIImage/v1, Helm/v1 etc. ## Changes: - Input types: File/v1 (was file/v1), Dir/v1 (was dir/v1), UTF8/v1 (was utf8/v1), Helm/v1 (was helm/v1) **The localBlob/v1 access type IS NOT touched in the PR.**, but already prepared (including updating all tests using the new types) in [this branch](https://github.com/morri-son/open-component-model/tree/align-type-notation-for-acces-and-input). Lowercase forms remain registered as backward-compatible aliases so existing component descriptors and constructors continue to work. Adds named constants (Type, LegacyType) to each spec package following the pattern already established by access type packages. Also adds Type constants for OCIImage, OCIImageLayer, and Helm access types where hardcoded strings were previously used in schema registrations. ## Which issue(s) this PR fixes Usage: Fixes open-component-model/ocm-project#962 ## Dependencies Tests for type casing have been split off to PR open-component-model#2071 to get the CI test not failing. ## Related - ocm-spec: open-component-model/ocm-spec#141 - ocm v1: open-component-model/ocm#1881 - ocm-website: open-component-model#2244 ## Verification - [x] I have tested the changes locally by running `ocm` --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> 7756429

Update input type names (Dir/v1, File/v1, Helm/v1, UTF8/v1) and access type names (OCIImage/v1, OCIImageLayer/v1) across website documentation to use UpperCamelCase as the canonical form. Lowercase forms are retained as backward-compatible aliases. - localBlob references are left untouched (deferred to a later PR) - helmChart artifact type references are left untouched (not an access type) - ociArtifactDigest algorithm names are left untouched Ref: open-component-model/ocm-project#962 Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

Co-authored-by: Frederic Wilhelm <fre.wilhelm@gmail.com> Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com>

## Summary - Update input type names (`Dir/v1`, `File/v1`, `Helm/v1`, `UTF8/v1`) and access type names (`OCIImage`, `OCIImageLayer`) across website documentation to use UpperCamelCase as the canonical form - Lowercase forms are documented as backward-compatible aliases - 13 files changed across `content/docs/` and `content_templates/` ## What's unchanged (by design) - `localBlob` references — deferred to a later PR - `helmChart` — this is an artifact type, not an access/input type - `ociArtifactDigest/v1` — algorithm name, not a type alias - `--upload-as ociArtifact` CLI flag values — CLI flag semantics unchanged - `content_versioned/version-legacy/` — historical docs left as-is ## Related - Tracks: open-component-model/ocm-project#962 - Depends on: #2057 (bindings UpperCamelCase defaults) - Companion: open-component-model/ocm-spec#141 (spec docs) Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> 2e601ca

## 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>

## 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

morri-son requested a review from a team as a code owner April 10, 2026 13:22

github-actions Bot added area/documentation Documentation related size/m Medium labels Apr 10, 2026

morri-son mentioned this pull request Apr 10, 2026

feat: register UpperCamelCase as primary type for input types (skip localBlob so far) #2057

Merged

1 task

morri-son added kind/chore chore, maintenance, etc. area/documentation Documentation related and removed area/documentation Documentation related labels Apr 10, 2026

piotrjanik reviewed Apr 13, 2026

View reviewed changes

Comment thread website/content/docs/how-to/download-resources-from-component-versions.md Outdated

morri-son linked an issue Apr 17, 2026 that may be closed by this pull request

align type notation for access and input open-component-model/ocm-project#962

Closed

7 tasks

morri-son mentioned this pull request Apr 17, 2026

docs(website): rename types to UpperCamelCase #2327

Merged

matthiasbruns previously approved these changes Apr 20, 2026

View reviewed changes

morri-son enabled auto-merge (squash) April 22, 2026 13:41

morri-son disabled auto-merge April 22, 2026 13:42

morri-son dismissed matthiasbruns’s stale review via 47e7407 April 22, 2026 13:46

morri-son force-pushed the website-upper-camel-case-types branch from 9294897 to 47e7407 Compare April 22, 2026 13:46

morri-son enabled auto-merge (squash) April 22, 2026 13:47

frewilhelm reviewed Apr 22, 2026

View reviewed changes

Comment thread website/content/docs/reference/input-and-access-types.md Outdated

morri-son and others added 3 commits April 22, 2026 16:23

Update website/content/docs/reference/input-and-access-types.md

5f0629c

Co-authored-by: Frederic Wilhelm <fre.wilhelm@gmail.com> Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com>

Merge branch 'main' into website-upper-camel-case-types

f3bbcdc

Merge branch 'main' into website-upper-camel-case-types

ed7b14a

matthiasbruns approved these changes Apr 22, 2026

View reviewed changes

frewilhelm approved these changes Apr 23, 2026

View reviewed changes

Merge branch 'main' into website-upper-camel-case-types

b26fe16

morri-son merged commit 2e601ca into open-component-model:main Apr 24, 2026
25 checks passed

coderabbitai Bot mentioned this pull request May 6, 2026

docs: add tutorial for native OCI image stores #2272

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(website): align type notation to UpperCamelCase#2244

docs(website): align type notation to UpperCamelCase#2244
morri-son merged 5 commits into
open-component-model:mainfrom
morri-son:website-upper-camel-case-types

morri-son commented Apr 10, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Apr 10, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

❌ Failed checks (1 warning)

Uh oh!

netlify Bot commented Apr 10, 2026 •

edited

Loading

Uh oh!

morri-son commented Apr 10, 2026

Uh oh!

coderabbitai Bot commented Apr 10, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

morri-son commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What's unchanged (by design)

Related

Uh oh!

coderabbitai Bot commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

❌ Failed checks (1 warning)

Uh oh!

netlify Bot commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for ocm-website ready!

Uh oh!

morri-son commented Apr 10, 2026

Uh oh!

coderabbitai Bot commented Apr 10, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

morri-son commented Apr 10, 2026 •

edited

Loading

coderabbitai Bot commented Apr 10, 2026 •

edited

Loading

netlify Bot commented Apr 10, 2026 •

edited

Loading