Introduce common reference section #483
Merged
Conversation
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
- Create index page for CRDs with title and description. - Add detailed documentation for ComponentVersion CRD including examples and specifications. - Create index page for OCM Controller with title and description. - Document the architecture of the OCM Controller, detailing its functions and sub-controllers. - Create reference index page for OCM CLI and OCM Controller documentation. On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
✅ Deploy Preview for open-component-model ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…ation commands, and update links in the documentation generation scripts to reflect the new structure under /docs/reference/ocm-cli. This includes the removal of files related to common transport archives, component archives, component versions, and verification processes, as well as adjustments to the mapping of commands to their respective documentation URLs. On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
- Introduced a comprehensive architecture document for the OCM Kubernetes Controllers, detailing their functions, components, and interactions. - Created a new section for Custom Resource Definitions (CRDs) with an overview and examples. - Added detailed documentation for the ComponentVersion CRD, including specifications, examples, and debugging information. On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
…gle layout templates On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
- Created documentation for the `ocm sign` command, including subcommands for signing component versions and hashes. - Added detailed options and usage examples for the `ocm sign componentversions` and `ocm sign hash` commands. - Introduced the `ocm transfer` command documentation, covering the transfer of OCI artifacts, common transport archives, and component versions. - Documented options and examples for `ocm transfer artifacts`, `ocm transfer commontransportarchive`, and `ocm transfer componentversions`. - Added verification command documentation with a focus on verifying component version signatures using the `ocm verify` command. - Included detailed descriptions, options, and examples for `ocm verify componentversions`. On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
…ation On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
2 tasks
…rence-section On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
…rence-section On-behalf-of: Gerald Morrison (SAP) <[email protected]> Signed-off-by: Gerald Morrison (SAP) <[email protected]>
|
@jakobmoellerdev, the PR can be reviewed. I resolved all conflicts after the latest changes. The PR can be checked in the Netlify deploy view. The changes to the Gh action "Update CLI docs" can only be correctly tested, once a new PR after the next v12 release is done and triggers the action. |
|
Looks alright. I run the code generation and locally also run the website. Looks alright. |
Skarlso
approved these changes
Jul 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this PR does / why we need it
Replace dedicated reference sections and merge into one with sub-folders