From b7f0f7903b756b68b11d5559673a56dfb677f889 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Mon, 19 Aug 2024 12:26:37 +0200 Subject: [PATCH 01/37] enable: markdown lint + check: links + spelling --- .github/config/markdown-link-check.json | 6 + .github/config/markdownignore | 0 .github/config/markdownlint.yml | 4 + .github/config/spellcheck.yml | 22 ++ .github/config/wordlist.txt | 290 ++++++++++++++++++++++++ .github/workflows/verify-md.yml | 44 ++++ 6 files changed, 366 insertions(+) create mode 100644 .github/config/markdown-link-check.json create mode 100644 .github/config/markdownignore create mode 100644 .github/config/markdownlint.yml create mode 100644 .github/config/spellcheck.yml create mode 100644 .github/config/wordlist.txt create mode 100644 .github/workflows/verify-md.yml diff --git a/.github/config/markdown-link-check.json b/.github/config/markdown-link-check.json new file mode 100644 index 00000000..68b57bd1 --- /dev/null +++ b/.github/config/markdown-link-check.json @@ -0,0 +1,6 @@ +{ "replacementPatterns": [ + { "pattern": "^/", "replacement": "{{BASEURL}}/" } + ], + "ignorePatterns": [ + ] +} diff --git a/.github/config/markdownignore b/.github/config/markdownignore new file mode 100644 index 00000000..e69de29b diff --git a/.github/config/markdownlint.yml b/.github/config/markdownlint.yml new file mode 100644 index 00000000..b0e18773 --- /dev/null +++ b/.github/config/markdownlint.yml @@ -0,0 +1,4 @@ +default: true + +MD013: false #Line length - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md013 +MD033: false #Inline HTML - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md033 diff --git a/.github/config/spellcheck.yml b/.github/config/spellcheck.yml new file mode 100644 index 00000000..62ffd670 --- /dev/null +++ b/.github/config/spellcheck.yml @@ -0,0 +1,22 @@ +matrix: + - name: Markdown + aspell: + lang: en + ignore-case: true + mode: markdown + dictionary: + wordlists: + - .github/config/wordlist.txt + encoding: utf-8 + pipeline: + - pyspelling.filters.markdown: + markdown_extensions: + - pymdownx.superfences + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre + sources: + - '**/*.md' + default_encoding: utf-8 diff --git a/.github/config/wordlist.txt b/.github/config/wordlist.txt new file mode 100644 index 00000000..c58e624f --- /dev/null +++ b/.github/config/wordlist.txt @@ -0,0 +1,290 @@ +accessmethod +accessmethoddescriptor +accessmethods +actiondescriptor +additionalresource +addversion +adr +aggregative +aml +anchore +api +archlinux +artifactid +aur +auth +autoconfigure +aws +backend +backends +basename +bindata +blobaccess +blobhandler +bool +boolean +buildx +cas +cli +cliconfig +clis +closable +closeable +cmds +cncf +codeql +commontransportarchive +componentaccess +componentaccessimpl +componentarchive +componentreferences +componentversionaccess +componentversionaccessimpl +componentversions +compvers +config +configfile +configs +consumerid +containerd +crd +creationtime +credentialrequest +credentialsspec +crossplatform +crypto +ctf +ctfs +ctx +cvs +deepcopy +defs +dependabot +deployscript +deserializable +deserialization +deserialize +deserialized +dest +digesters +directorytree +dirtree +dns +dockerconfig +downloadconstraint +downloader +downloaderdescriptor +downloaders +downloadhandlers +dry-run +dup +dups +dynaml +echoserver +entrypoint +executables +executoroptions +executorspecification +extensibility +filepath +filesystem +filesytem +finalizer +finalizers +foldername +forwardspec +gapped +gav +getinexpensivecontentversionidentity +getresourcesbyname +getter +ghcr +github +gitignore +gitops +globalaccess +globals +gocritic +gofmt +golang +golangci +gomega +goreleaser +gosec +goutils +groupid +gzip +handleoutput +hashers +hashicorp +hashicorpvault +helmchart +helmchartrepository +helmdemo +helmexecutor +helminstaller +helmrepository +hoc +homebrew +hostname +hostpath +html +http +https +iaas +imagemapping +inlined +installable +instantiation +io +ioutils +iterable +json +jsonschema +keyless +keypair +keyring +kubebuilder +kubeconfig +kubernetes +labelmergespecification +lifecycle +linter +linters +lister +listers +localizations +logconfig +logrus +lookups +macos +makefile +makefiles +mandelsoft +mapocirepoattr +matcher +matchers +mavenartifact +mavenpackage +mavenrepository +mediatype +mimetype +mimetypes +multiarch +mutex +mvn +mvnrepository +namespace +namespaces +newcomponentaccess +newcomponentversionaccess +newrepository +newrepositoryspec +npm +npmjs +npmrc +npmregistry +oauth +oci +ociartifact +ocireg +ociregistry +ocm +ocmbot +ocmcli +ocmconfig +oncefunc +oo +oras +os +outputspecification +packagespec +parameterization +pendingdeprecationwarning +pflag +podinfo +podman +pre +preconfigure +preconfigured +predefine +programmatically +prs +pss +pubsub +readme +readonly +refcount +relativeocireference +releaser +repo +repocpi +repositoryimpl +repositoryspec +resendbuffer +resolvers +resourcereference +routings +routingslips +rsa +rsakeypair +runtime +sbod +sbom +sdk +semver +sequent +serializable +sha +signingserver +sigstore +simplemapmerge +sonatype +spdx +srcrefs +stderr +stdin +stdout +storable +struct +subchart +subcharts +subst +tempfile +templated +templater +templaters +templating +tgz +tls +todo +toi +toiexecutor +toolset +transportarchive +typehandler +typename +unmodifiable +untrusted +updatevendorhash +uploader +uploaderdescriptor +uploaders +uploadhandlers +url +urls +utf +util +utils +valuemergehandler +valuemergehandlerdescriptor +valueset +versionedtypedobjects +walkthrough +wget +withocm +xml +yaml +yitsushi +yml +yyyy diff --git a/.github/workflows/verify-md.yml b/.github/workflows/verify-md.yml new file mode 100644 index 00000000..f6dc5f1d --- /dev/null +++ b/.github/workflows/verify-md.yml @@ -0,0 +1,44 @@ +name: Markdown + +on: + pull_request: + branches: + - main + paths: + - '**/*.md' + +jobs: + markdown-lint: + runs-on: ubuntu-latest + name: Lint Markdown + steps: + - uses: actions/checkout@v4 + - name: Markdown Linting + uses: nosborn/github-action-markdown-cli@v3 + with: + files: . + dot: true + config_file: .github/config/markdownlint.yml + ignore_path: .github/config/markdownignore + verify-links: + name: Verify links + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Markdown verify links + uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + use-quiet-mode: yes + use-verbose-mode: no + config-file: .github/config/markdown-link-check.json + spellcheck: + name: Spellcheck + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Spellcheck + uses: rojopolis/spellcheck-github-actions@v0 + with: + config_path: .github/config/spellcheck.yml + task_name: Markdown + From 795d80b6af3d930a16aa5a96b95de05f775a1b01 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Mon, 19 Aug 2024 14:41:39 +0200 Subject: [PATCH 02/37] this is obviosly just a copy paste from Doks repo... nothing related to OCM --- SECURITY.md | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 4ad3369f..00000000 --- a/SECURITY.md +++ /dev/null @@ -1,7 +0,0 @@ -# Reporting Security Issues - -The Doks team and community take security issues in Doks seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions. - -To report a security issue, email [security@getdoks.org](mailto:security@getdoks.org) and include the word "SECURITY" in the subject line. - -We'll endeavor to respond quickly, and will keep you updated throughout the process. From 445eaf51a868a8aa3fd367c65661e2bb825d2707 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Mon, 19 Aug 2024 15:49:55 +0200 Subject: [PATCH 03/37] renaming the steps for more clarity --- .github/workflows/publish-site.yaml | 63 ++++++++++++++++------------- 1 file changed, 34 insertions(+), 29 deletions(-) diff --git a/.github/workflows/publish-site.yaml b/.github/workflows/publish-site.yaml index a58c4d86..72b97200 100644 --- a/.github/workflows/publish-site.yaml +++ b/.github/workflows/publish-site.yaml @@ -3,14 +3,14 @@ name: Publish Site on: workflow_dispatch: push: - branches: [ main ] + branches: [main] env: OUTPUT_DIR: site-docs/ jobs: - setup-clone: - name: Setup, Build, Publish, and Deploy + publish-site: + name: Publish Site runs-on: ubuntu-latest permissions: @@ -19,38 +19,43 @@ jobs: pull-requests: 'write' steps: - - uses: actions/checkout@v4 - - - uses: actions/setup-node@v4 - with: - cache: 'npm' - node-version: 20 - - - name: Setup Hugo - uses: peaceiris/actions-hugo@v3 - with: + - uses: actions/checkout@v4 + name: Checkout + + - uses: actions/setup-node@v4 + name: Setup Node.js + with: + cache: 'npm' + node-version: 20 + + - name: Setup Hugo + uses: peaceiris/actions-hugo@v3 + with: hugo-version: 'latest' - - run: npm install + - run: npm install + name: Install Dependencies - - run: npm run build + - run: npm run build + name: Build Site - - name: Generate Schema - uses: actions/setup-python@v5 - with: - python-version: '3.11' + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: '3.11' - - run: | - python3 -m pip install json-schema-for-humans - generate-schema-doc --config-file generate-schema.yaml static/schemas/component-descriptor-v2 schema-v2.html - generate-schema-doc --config-file generate-schema.yaml static/schemas/component-descriptor-v3alpha1 schema-v3alpha1.html + - run: | + python3 -m pip install json-schema-for-humans + generate-schema-doc --config-file generate-schema.yaml static/schemas/component-descriptor-v2 schema-v2.html + generate-schema-doc --config-file generate-schema.yaml static/schemas/component-descriptor-v3alpha1 schema-v3alpha1.html + name: Generate Schema - - name: Copy Schema - run: | - cp schema-v2.html schema-v3alpha1.html schema_doc.css schema_doc.min.js public/docs/overview/specification + - name: Copy Schema + run: | + cp schema-v2.html schema-v3alpha1.html schema_doc.css schema_doc.min.js public/docs/overview/specification - - name: Deploy - uses: peaceiris/actions-gh-pages@v4 - with: + - name: Publish as GitHub Pages + uses: peaceiris/actions-gh-pages@v4 + with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public From 97bd6887a03398582d6781b85f44e47f255ae1f5 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Mon, 19 Aug 2024 15:50:29 +0200 Subject: [PATCH 04/37] fix links --- content/docs/controller/installation.md | 2 +- content/docs/roadmap/roadmap.md | 2 +- content/docs/tutorials/best-practices-with-ocm.md | 4 ++-- ...ild-deploy-software-via-helm-charts-with-ocm-101.md | 10 +++++----- .../complex-component-structure-deployment.md | 2 +- .../air-gapped-gitops-with-ocm-and-flux.md | 6 +++--- .../deploying-applications-with-ocm-and-gitops.md | 6 +++--- .../gitops-driven-configuration-of-ocm-applications.md | 4 ++-- content/mpas/core_concepts.md | 2 +- content/mpas/getting_started.md | 4 ++-- 10 files changed, 21 insertions(+), 21 deletions(-) diff --git a/content/docs/controller/installation.md b/content/docs/controller/installation.md index 8ed6f6fe..de16fb1e 100644 --- a/content/docs/controller/installation.md +++ b/content/docs/controller/installation.md @@ -11,7 +11,7 @@ toc: true ## ocm-controller -The `ocm-controller` can be installed using the [OCM CLI](/docs/overview/installation): +The `ocm-controller` can be installed using the [OCM CLI](/docs/getting-started/installing-the-ocm-cli): ```bash ocm controller install diff --git a/content/docs/roadmap/roadmap.md b/content/docs/roadmap/roadmap.md index 4697e280..ee333c74 100644 --- a/content/docs/roadmap/roadmap.md +++ b/content/docs/roadmap/roadmap.md @@ -14,4 +14,4 @@ sidebar: You can checkout the [Project Roadmap on GitHub](https://github.com/orgs/open-component-model/projects/10/views/5) which is based on issues and PRs from the [OCM project repository](https://github.com/open-component-model/ocm-project). -![roadmap](images/roadmap_Q2-2024.png) +![roadmap](/images/roadmap_Q2-2024.png) diff --git a/content/docs/tutorials/best-practices-with-ocm.md b/content/docs/tutorials/best-practices-with-ocm.md index 8575b170..df784dd5 100644 --- a/content/docs/tutorials/best-practices-with-ocm.md +++ b/content/docs/tutorials/best-practices-with-ocm.md @@ -29,7 +29,7 @@ This chapter contains guidelines for common scenarios how to work with the Open The Open Component Model (OCM) provides a public schema to validate and offer auto-completion of component constructor files used to create component descriptors. -This schema is available at [https://ocm.software/schemas/configuration-schema.yaml](https://ocm.software/schemas/configuration-schema.yaml). +This schema is available at [https://ocm.software/schemas/configuration-schema.yaml](/schemas/configuration-schema.yaml). To use this schema in your IDE, you can add the following line to your component constructor file: @@ -88,7 +88,7 @@ OCM component versions generated by the build. This archive can then be used by the build-system to do whatever is required to make the content accessible by others. -The composition of such archives is described in the [Getting Started](/docs/getting-started/getting-started-with-ocm/prerequisites) section. +The composition of such archives is described in the [Getting Started](/docs/getting-started/getting-started-with-ocm/prerequisites/) section. To secure further processes, a *certified build-system* could even sign the content with its build system certificate to enable followup-processes to verify that involved component diff --git a/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md b/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md index ac284c5a..855eebd7 100644 --- a/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md +++ b/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md @@ -13,7 +13,7 @@ toc: true ## Introduction Let's illustrate a very simple "Hello World" example application and show how to leverage OCM to build an application component containing a Helm Chart and an OCI Image and deploy it to a local `kind` k8s cluster. -The topics `ocm` [`localization`](https://ocm.software/docs/tutorials/deployment-scenario-using-an-aggregated-component/#localization) and [`configuration`](https://ocm.software/docs/tutorials/deployment-scenario-using-an-aggregated-component/#configuration) are NOT part of this very simple example, but is covered in other tutorials. +The topics `ocm` [`localization`](/docs/tutorials/deployment-scenario-using-an-aggregated-component/#localization) and [`configuration`](/docs/tutorials/deployment-scenario-using-an-aggregated-component/#configuration) are NOT part of this very simple example, but is covered in other tutorials. As base we use the `podinfo` application from Stefan Prodan's [Github repo](https://github.com/stefanprodan/podinfo). All files can be found [here](https://github.com/open-component-model/ocm-examples/tree/main/components). @@ -130,7 +130,7 @@ components: Some frequently changing parameters have been extracted as variables. The OCM CLI uses templating to fill them with values. The templating mechanism is described -[here](https://ocm.software/docs/tutorials/best-practices/#templating-the-resources). For this example +[here](/docs/tutorials/best-practices/#templating-the-resources). For this example we use the default template engine type `subst`. Note the differences between the various components: @@ -216,7 +216,7 @@ and should never be changed. Navigate to the overview of your OCI repository, which should list the following items: -![alt text](images/github-packages-ocm-hello-world.png) +![alt text](/images/github-packages-ocm-hello-world.png) ## Deploying the OCM Software Artifact @@ -605,7 +605,7 @@ Forwarding from [::1]:9898 -> 9898 Handling connection for 9898 ``` -![alt text](images/guide-helm-charts-hello-world.png) +![alt text](/images/guide-helm-charts-hello-world.png) ```shell kubectl port-forward service/podinfo-helm-chart-local-tgz -n default 9898:9898 @@ -614,4 +614,4 @@ Forwarding from [::1]:9898 -> 9898 Handling connection for 9898 ``` -![alt text](images/guide-helm-charts-hello-world-2.png) +![alt text](/images/guide-helm-charts-hello-world-2.png) diff --git a/content/docs/tutorials/complex-component-structure-deployment.md b/content/docs/tutorials/complex-component-structure-deployment.md index 3524a59c..e1020430 100644 --- a/content/docs/tutorials/complex-component-structure-deployment.md +++ b/content/docs/tutorials/complex-component-structure-deployment.md @@ -46,7 +46,7 @@ references, you could collect all artifacts belonging to this product version. ## Prerequisites -We assume that you have already read the guides in the [Getting Started](https://ocm.software/docs/getting-started/getting-started-with-ocm/prerequisites/) section, as this guide discusses a more +We assume that you have already read the guides in the [Getting Started](/docs/getting-started/getting-started-with-ocm/prerequisites/) section, as this guide discusses a more complex scenario using plain Localizations and Configurations without the use of [Unpacker](https://github.com/open-component-model/unpacker-controller). ## Constructing the Component diff --git a/content/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-and-flux.md b/content/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-and-flux.md index 3094f26e..8aa8d7d8 100644 --- a/content/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-and-flux.md +++ b/content/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-and-flux.md @@ -16,7 +16,7 @@ In this guide, we will show you how the tools provided by OCM make it possible t Air-gapped can mean different things depending on the context. For this guide, we'll assume it means your deployment artifacts are stored in a private registry protected by the security controls at your organization. Your applications only have access to this private registry and little to no public internet access. -We'll take the same `podinfo` component that we deployed in the [Deploy Applications with OCM & GitOps](https://ocm.software/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-gitops/) guide but this time we will use the OCM CLI to transfer the component to our own registry. The application will then be deployed from this "private" registry. This, of course, mimics a real-world air-gap scenario. In practice, there could be many layers of security between the two registries; however, the mechanics are ultimately the same. +We'll take the same `podinfo` component that we deployed in the [Deploy Applications with OCM & GitOps](/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-gitops/) guide but this time we will use the OCM CLI to transfer the component to our own registry. The application will then be deployed from this "private" registry. This, of course, mimics a real-world air-gap scenario. In practice, there could be many layers of security between the two registries; however, the mechanics are ultimately the same. ## Table of Contents @@ -122,7 +122,7 @@ We can see that the image reference now points to an image stored in our air-gap Now that our component has been successfully transferred, let's deploy it using GitOps. -We assume you have completed the [Deploy Applications with OCM & GitOps](https://ocm.software/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-gitops/) guide and will use that repository as the starting point for our air-gapped deployment. +We assume you have completed the [Deploy Applications with OCM & GitOps](/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-gitops/) guide and will use that repository as the starting point for our air-gapped deployment. Because our air-gapped OCM repository is private, we need to provide credentials. This will enable the `ocm-controller` to retrieve components from the repository. @@ -259,7 +259,7 @@ LAST SEEN TYPE REASON OBJECT MESSAGE 5m44s Warning Failed pod/podinfo-7b7d874bf8-xv75x Error: ImagePullBackOff ``` -Check out our [GitOps Driven Configuration of OCM Applications](https://ocm.software/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications) guide to see how we can use the `ocm-controller` to configure our application at runtime and solve exactly this kind of problem! +Check out our [GitOps Driven Configuration of OCM Applications](/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications) guide to see how we can use the `ocm-controller` to configure our application at runtime and solve exactly this kind of problem! ### Conclusion diff --git a/content/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-and-gitops.md b/content/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-and-gitops.md index c5bd35d7..5c06333d 100644 --- a/content/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-and-gitops.md +++ b/content/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-and-gitops.md @@ -22,7 +22,7 @@ Here's a diagram showing what we'll be building: As you can see, we'll add some manifests to a git repository that will be deployed by Flux. These will, in turn, deploy a resource from an OCM repository, in this case, a `Deployment` of the `podinfo` microservice. -If you'd like to learn how to build a component, then check out our [Getting Started guide](https://ocm.software/docs/getting-started/getting-started-with-ocm/prerequisites). +If you'd like to learn how to build a component, then check out our [Getting Started guide](/docs/getting-started/getting-started-with-ocm/prerequisites). ## Table of Contents @@ -211,5 +211,5 @@ That's it! That's how easy it is to get started using the Open Component Model a If you want to know more about working with OCM and GitOps, check out these guides: -- [Air-gapped GitOps with OCM & Flux](https://ocm.software/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-flux/) -- [GitOps Driven Configuration of OCM Applications](https://ocm.software/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications/) +- [Air-gapped GitOps with OCM & Flux](/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-flux/) +- [GitOps Driven Configuration of OCM Applications](/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications/) diff --git a/content/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications.md b/content/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications.md index fd8e87fa..1e4153c4 100644 --- a/content/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications.md +++ b/content/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications.md @@ -16,8 +16,8 @@ This guide is the final part of our series exploring OCM, the `ocm-controller`, Check out the previous guides if you haven't already: -- [Deploy Applications with OCM & GitOps](https://ocm.software/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-and-gitops) -- [Air-gapped GitOps with OCM & Flux](https://ocm.software/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-and-flux) +- [Deploy Applications with OCM & GitOps](/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-gitops/) +- [Air-gapped GitOps with OCM & Flux](/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-flux/) In this guide we will pick-up where we left off in the air-gapped example. diff --git a/content/mpas/core_concepts.md b/content/mpas/core_concepts.md index 581e47b6..13f03f05 100644 --- a/content/mpas/core_concepts.md +++ b/content/mpas/core_concepts.md @@ -19,7 +19,7 @@ see [Architecture](https://github.com/open-component-model/MPAS/tree/main/docs/c A Product is a package of software that can be deployed to target environments such as Kubernetes clusters, virtual machines or bare-metal devices. -Products are made available to the `MPAS` system as [OCM Components](https://github.com/open-component-model/ocm-spec/blob/main/doc/introduction/component_versions.md#component-versions) via a `Subscription`. +Products are made available to the `MPAS` system as [OCM Components](https://github.com/open-component-model/ocm-spec/blob/main/doc/01-model/01-model.md#components-and-component-versions) via a `Subscription`. Multiple instances of a Product may be installed that refer to the same Subscription. A `ProductDeployment` is a Kubernetes Custom Resource that represents a product to diff --git a/content/mpas/getting_started.md b/content/mpas/getting_started.md index 445b39a6..315cca8c 100644 --- a/content/mpas/getting_started.md +++ b/content/mpas/getting_started.md @@ -35,7 +35,7 @@ To install the MPAS CLI using `brew`: brew install open-component-model/tap/mpas ``` -For other installation methods, see the [installation guide](/mpas/overview/installation/). +For other installation methods, see the [installation guide](/mpas/installation/). ## Bootstrap MPAS @@ -118,7 +118,7 @@ cd mpas-bootstrap ### Deploy podinfo application The [podinfo application](https://github.com/stefanprodan/podinfo) has been packaged -as an OCM component and can be retrieved from [Github](ghcr.io/open-component-model/podinfo). +as an OCM component and can be retrieved from [Github](https://ghcr.io/open-component-model/podinfo). 1. Create a secret containing your GitHub credentials that will be used by MPAS to create your project repository. From ffb8839a9ad5c0412f09f750d6dad8bdb4442852 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Mon, 19 Aug 2024 16:01:08 +0200 Subject: [PATCH 05/37] fix some typos --- content/docs/tutorials/best-practices-with-ocm.md | 2 +- .../build-deploy-software-via-helm-charts-with-ocm-101.md | 2 +- .../docs/tutorials/complex-component-structure-deployment.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/docs/tutorials/best-practices-with-ocm.md b/content/docs/tutorials/best-practices-with-ocm.md index df784dd5..9324e380 100644 --- a/content/docs/tutorials/best-practices-with-ocm.md +++ b/content/docs/tutorials/best-practices-with-ocm.md @@ -101,7 +101,7 @@ versions are provided by accepted and well-known processes. At the time of writing this guide Docker is not able to build multi-architecture (multi-arch / multi-platform) images natively. Instead, the `buildx` plugin is used. However, this implies building and pushing images in one step to a remote container registry as the local Docker image store does not -support multi-arch images (for additional information, see the [Multi-arch build and images, the simple way](https://www.docker.com/blog/multi-arch-build-and-images-the-simple-way) blogpost) +support multi-arch images (for additional information, see the [Multi-arch build and images, the simple way](https://www.docker.com/blog/multi-arch-build-and-images-the-simple-way) blog post) The OCM CLI has some built-in support for dealing with multi-arch images during the component version composition ([`ocm add resources`](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_add_resources.md)). diff --git a/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md b/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md index 855eebd7..3d696cb1 100644 --- a/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md +++ b/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md @@ -190,7 +190,7 @@ configuration of credentials for the OCM CLI): ocm transfer ctf -f ``` -Using the `--copy-resources` flag the OCM CLI will copy also copy all referenced resourcres to the OCI registry, making the resources part of the OCM component version, creating a self-contained component version. +Using the `--copy-resources` flag the OCM CLI will copy also copy all referenced resources to the OCI registry, making the resources part of the OCM component version, creating a self-contained component version. ```shell ocm transfer ctf --copy-resources --enforce --overwrite ./ocm-hello-world OCIRegistry::ghcr.io/stb1337/ocm-hello-world-v1 diff --git a/content/docs/tutorials/complex-component-structure-deployment.md b/content/docs/tutorials/complex-component-structure-deployment.md index e1020430..458590e0 100644 --- a/content/docs/tutorials/complex-component-structure-deployment.md +++ b/content/docs/tutorials/complex-component-structure-deployment.md @@ -275,7 +275,7 @@ tree . 2 directories, 19 files ``` -These blobs contain the resources we described when modelling our podinfo application. If we `cat `a random blob we get +These blobs contain the resources we described when modelling our podinfo application. If we `cat` a random blob we get something like this: ```sh From 66875a7174db245c2d64996858827b0fcd54551a Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Mon, 19 Aug 2024 16:04:03 +0200 Subject: [PATCH 06/37] fix some linter issues --- content/docs/tutorials/best-practices-with-ocm.md | 14 ++++++++------ ...deploy-software-via-helm-charts-with-ocm-101.md | 2 +- .../complex-component-structure-deployment.md | 3 +-- content/mpas/core_concepts.md | 1 - content/mpas/getting_started.md | 2 +- hugo_stats.json | 11 +++++++---- 6 files changed, 18 insertions(+), 15 deletions(-) diff --git a/content/docs/tutorials/best-practices-with-ocm.md b/content/docs/tutorials/best-practices-with-ocm.md index 9324e380..7219f911 100644 --- a/content/docs/tutorials/best-practices-with-ocm.md +++ b/content/docs/tutorials/best-practices-with-ocm.md @@ -266,11 +266,11 @@ eu.gcr.io/acme/simpleserver 0.1.0-linux-amd64 08641d64f612 About a minute In the next step we create a component archive and a transport archive ```shell -$ PROVIDER=acme -$ COMPONENT=github.com/$(PROVIDER)/simpleserver -$ VERSION=0.1.0 -$ mkdir gen -$ ocm create ca ${COMPONENT} ${VERSION} --provider ${PROVIDER} --file gen/ca +PROVIDER=acme +COMPONENT=github.com/$(PROVIDER)/simpleserver +VERSION=0.1.0 +mkdir gen +ocm create ca ${COMPONENT} ${VERSION} --provider ${PROVIDER} --file gen/ca ``` Create the file `resources.yaml`. Note the variants in the image input and the type `dockermulti`: @@ -417,6 +417,7 @@ x index.json } } ``` + You can create a common transport archive from the component archive. @@ -632,7 +633,7 @@ declared in the Makefile. Use either an environment variable or an argument when Example: ```shell -$ PROVIDER=foo make ca +PROVIDER=foo make ca ``` ### Templating the Resources @@ -755,6 +756,7 @@ NGINX_CHART_VERSION: 4.4.2 ``` auto-generated from a build script: + ```yaml VERSION: 0.23.1 COMMIT: 5f03021059c7dbe760ac820a014a8a84166ef8b4 diff --git a/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md b/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md index 3d696cb1..6e86aafc 100644 --- a/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md +++ b/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md @@ -96,7 +96,7 @@ components: access: type: ociArtifact imageReference: ghcr.io/stefanprodan/charts/podinfo:${PODINFO_VERSION} - # Helm Chart in Helm repository + # Helm Chart in Helm repository - name: helm-chart-external-helm-repo type: helmChart version: ${PODINFO_VERSION} diff --git a/content/docs/tutorials/complex-component-structure-deployment.md b/content/docs/tutorials/complex-component-structure-deployment.md index 458590e0..46039f92 100644 --- a/content/docs/tutorials/complex-component-structure-deployment.md +++ b/content/docs/tutorials/complex-component-structure-deployment.md @@ -990,7 +990,7 @@ The **helm-controller** and **notification-controller** aren't relevant. The `ComponentVersion` object contains information about what components have been reconciled. We talked about that earlier at [Component Version](#componentversion). The `Status` section contains any errors that could have -occurred when reconciling information. +occurred when reconciling information. **ComponentDescriptor**: @@ -1094,7 +1094,6 @@ kubectl port-forward service/registry -n ocm-system 5000:5000 Then, verify that the connection is working by running a `catalog` command: - ```sh crane catalog http://127.0.0.1:5000 ``` diff --git a/content/mpas/core_concepts.md b/content/mpas/core_concepts.md index 13f03f05..4e6d3979 100644 --- a/content/mpas/core_concepts.md +++ b/content/mpas/core_concepts.md @@ -38,7 +38,6 @@ A `ProductDeploymentPipeline` is a Kubernetes Custom Resource that defines a res that needs to be deployed as part of the `ProductDeployment`. The `ProductDeploymentPipeline` is reconciled by the `MPAS Product Controller` as part of the `ProductDeployment` deployment. - ## Project A `Project` is a Kubernetes Custom Resource that is used to manage the lifecycle of diff --git a/content/mpas/getting_started.md b/content/mpas/getting_started.md index 315cca8c..58e44499 100644 --- a/content/mpas/getting_started.md +++ b/content/mpas/getting_started.md @@ -50,7 +50,7 @@ export GITHUB_USER= export MY_EMAIL= ``` -### Bootstrap MPAS +### Bootstrap To bootstrap MPAS to your Kubernetes cluster, run the following command. If nothing is specified it will use the KUBECONFIG specified in the user's environment. It is also possible to specify a dedicated config using the --kubeconfig option. diff --git a/hugo_stats.json b/hugo_stats.json index 34bc8379..57e75cc1 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -303,11 +303,12 @@ "backend-1", "bash", "binary", + "bootstrap", "bootstrap-for-an-air-gapped-environment", "bootstrap-for-gitea", "bootstrap-for-github", "bootstrap-mpas", - "bootstrap-mpas-1", + "build-and-run-it-yourself", "building-from-source", "building-multi-architecture-images", "building-the-application-component-using-ocm", @@ -418,7 +419,6 @@ "examples", "executor-image-contract", "executorspecification", - "expand", "export-the-bootstrap-components-bundle", "export-your-github-access-token", "extensibility", @@ -455,9 +455,13 @@ "input-specification", "input-types", "inspect-component-descriptor", + "install-from-aur-arch-linux-user-repository", "install-the-mpas-cli", "install-the-ocm-command-line-interface-cli", "install-using-binaries", + "install-using-docker--podman", + "install-using-homebrew", + "install-using-nix-with-flakeshttpsnixoswikiwikiflakes", "installation-process", "interval", "introduction", @@ -507,7 +511,6 @@ "query", "reconciled-version", "redis", - "references", "replicated-repository-url", "replication-controller", "report-a-vulnerability", @@ -564,10 +567,10 @@ "upload-the-component-versions", "url", "usage", + "use-public-schema-for-validation-and-auto-completion-of-component-descriptors", "user-config-vs-executor-config", "using-a-resources-file", "using-basic-authentication", - "using-binaries", "using-makefiles", "using-the-docker-configuration-file", "utf-8", From fdd245d7fe07f8fb050027fa86f511718359cd24 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Mon, 19 Aug 2024 16:04:15 +0200 Subject: [PATCH 07/37] obsolete --- content/docs/tutorials/test_images.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 content/docs/tutorials/test_images.md diff --git a/content/docs/tutorials/test_images.md b/content/docs/tutorials/test_images.md deleted file mode 100644 index fbca9528..00000000 --- a/content/docs/tutorials/test_images.md +++ /dev/null @@ -1 +0,0 @@ -![helloworld](images/roadmap_Q2-2024.png) \ No newline at end of file From 6d05d9d08b9e2af53a6f9348515e7dfe3bcfa6e8 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Wed, 21 Aug 2024 15:54:23 +0200 Subject: [PATCH 08/37] uses: untitaker/hyperlink@v0 --- .github/workflows/verify-md.yml | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/.github/workflows/verify-md.yml b/.github/workflows/verify-md.yml index f6dc5f1d..0d26ac92 100644 --- a/.github/workflows/verify-md.yml +++ b/.github/workflows/verify-md.yml @@ -21,16 +21,27 @@ jobs: config_file: .github/config/markdownlint.yml ignore_path: .github/config/markdownignore verify-links: - name: Verify links + name: Verify HTML links runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - name: Markdown verify links - uses: gaurav-nelson/github-action-markdown-link-check@v1 + - name: Setup Node.js + uses: actions/setup-node@v4 with: - use-quiet-mode: yes - use-verbose-mode: no - config-file: .github/config/markdown-link-check.json + cache: 'npm' + node-version: 20 + - name: Setup Hugo + uses: peaceiris/actions-hugo@v3 + with: + hugo-version: 'latest' + - name: Install Dependencies + run: npm install + - name: Build Site + run: npm run build + - name: Verify HTML links + uses: untitaker/hyperlink@v0 + with: + args: public/ --sources content/ spellcheck: name: Spellcheck runs-on: ubuntu-latest @@ -41,4 +52,3 @@ jobs: with: config_path: .github/config/spellcheck.yml task_name: Markdown - From a7e6c6070eea72b09bbfeac2ca0928e5175fd1ec Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Wed, 21 Aug 2024 16:10:58 +0200 Subject: [PATCH 09/37] bump node, npm, pnpm --- netlify.toml | 4 ++-- package.json | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/netlify.toml b/netlify.toml index 6fa3cf58..4ebcd10f 100644 --- a/netlify.toml +++ b/netlify.toml @@ -3,8 +3,8 @@ functions = "functions" [build.environment] - NODE_VERSION = "16.16.0" - NPM_VERSION = "8.11.0" + NODE_VERSION = "20.16.0" + NPM_VERSION = "10.8.1" [context.production] command = "npm run build" diff --git a/package.json b/package.json index fb1fce85..806427a8 100644 --- a/package.json +++ b/package.json @@ -44,8 +44,8 @@ "semver": "^7.5.4" }, "engines": { - "node": ">=18.14.1", - "pnpm": ">=8.10.0" + "node": ">=20.16.0", + "pnpm": ">=9.7.1" }, - "packageManager": "pnpm@8.12.0" + "packageManager": "pnpm@9.7.1" } \ No newline at end of file From 51e89d118262602c035674d96e47204a2e0d2397 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Wed, 21 Aug 2024 16:12:06 +0200 Subject: [PATCH 10/37] "license": "Apache-2.0" --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 806427a8..359570fa 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "version": "0.0.0", "description": "OCM website", "author": "open-component-model", - "license": "MIT", + "license": "Apache-2.0", "scripts": { "dev": "exec-bin node_modules/.bin/hugo/hugo server --bind=0.0.0.0 --disableFastRender --baseURL=http://localhost --noHTTPCache", "dev:drafts": "exec-bin node_modules/.bin/hugo/hugo server --bind=0.0.0.0 --disableFastRender --baseURL=http://localhost --noHTTPCache --buildDrafts", From 0653b54b63f2afc39f42f643323c01527882e657 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Wed, 21 Aug 2024 16:35:59 +0200 Subject: [PATCH 11/37] md lint --- content/mpas/bootstrap.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/mpas/bootstrap.md b/content/mpas/bootstrap.md index eb7dac20..22d2f30d 100644 --- a/content/mpas/bootstrap.md +++ b/content/mpas/bootstrap.md @@ -145,7 +145,6 @@ mpas bootstrap gitea \ --dev ``` - ## Bootstrap for an air-gapped environment If you want to bootstrap `MPAS` for a repository in an air-gapped environment, only Gitea From 4c27f60959d494ebe0090124ca8f064383908b07 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Wed, 21 Aug 2024 17:24:55 +0200 Subject: [PATCH 12/37] link DCO --- content/docs/contribution/contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/contribution/contributing.md b/content/docs/contribution/contributing.md index d1164ba6..521ab5f7 100644 --- a/content/docs/contribution/contributing.md +++ b/content/docs/contribution/contributing.md @@ -16,9 +16,9 @@ Thank you for taking the time to contribute to OCM. ## DCO -By contributing to this project you agree to the Developer Certificate of Origin ([DCO](DCO)). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. +By contributing to this project you agree to the Developer Certificate of Origin ([DCO](https://raw.githubusercontent.com/open-component-model/.github/HEAD/DCO)). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. -We require all commits to be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). By signing off with your signature, you certify that you wrote the patch or otherwise have the right to contribute the material by the rules of the [DCO](DCO): +We require all commits to be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). By signing off with your signature, you certify that you wrote the patch or otherwise have the right to contribute the material by the rules of the [DCO](https://raw.githubusercontent.com/open-component-model/.github/HEAD/DCO): `Signed-off-by: Jane Doe ` From 7e0a3c88384f56e15d4c72ee26048e13ac7f3b38 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Wed, 21 Aug 2024 17:25:29 +0200 Subject: [PATCH 13/37] typo --- content/docs/contribution/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/contribution/contributing.md b/content/docs/contribution/contributing.md index 521ab5f7..88462783 100644 --- a/content/docs/contribution/contributing.md +++ b/content/docs/contribution/contributing.md @@ -48,7 +48,7 @@ We welcome all types of contributions, including: For more involved feature or enhancement requests, please see the section on how to submit an [ADR](#adrs). -You may find it helpful to start a new thread in the [`ocm` Discussion Board](https://github.com/open-component-model/ocm/discussions) for questions, help requests, feature requests, or any other type of discussion about OCM. A maintaine will reach out to you as soon as possible. +You may find it helpful to start a new thread in the [`ocm` Discussion Board](https://github.com/open-component-model/ocm/discussions) for questions, help requests, feature requests, or any other type of discussion about OCM. A maintainer will reach out to you as soon as possible. ### Find an Issue From 0caddb606e64c5a9ff8fc671f0592cbc8a7b1fea Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Wed, 21 Aug 2024 17:25:38 +0200 Subject: [PATCH 14/37] linting --- content/docs/contribution/contributing.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/docs/contribution/contributing.md b/content/docs/contribution/contributing.md index 88462783..d127b29f 100644 --- a/content/docs/contribution/contributing.md +++ b/content/docs/contribution/contributing.md @@ -35,6 +35,7 @@ If you wish to propose or discuss a more involved feature or change to any of th ## Ways to Contribute We welcome all types of contributions, including: + - New features - Bug reports/fixes - Reviewing/updating documentation @@ -78,6 +79,7 @@ Ready to contribute? Read and follow the sections below to get your contribution - [Bonus] Backfill tests/documentation to make the world a better place. ### Pull Request Process + 1. **Create PR.** Please refer to the [Pull Request Checklist](#pull-request-checklist) before marking a PR as ready to be reviewed. 2. **Triage.** A maintainer will triage the Pull Request by adding the appropriate label for the issue. 3. **Assign reviews.** A maintainer will be assigned to review the changes in the Pull Request. From fe5fab1f0e9645700206bf74cfe7fa0a04d7a362 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Wed, 21 Aug 2024 17:31:29 +0200 Subject: [PATCH 15/37] links --- content/docs/contribution/contributing.md | 4 ++-- content/docs/examples/secure-software-delivery.md | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/content/docs/contribution/contributing.md b/content/docs/contribution/contributing.md index d127b29f..04055d2b 100644 --- a/content/docs/contribution/contributing.md +++ b/content/docs/contribution/contributing.md @@ -16,9 +16,9 @@ Thank you for taking the time to contribute to OCM. ## DCO -By contributing to this project you agree to the Developer Certificate of Origin ([DCO](https://raw.githubusercontent.com/open-component-model/.github/HEAD/DCO)). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. +By contributing to this project you agree to the Developer Certificate of Origin ([DCO](https://raw.githubusercontent.com/open-component-model/.github/main/DCO)). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. -We require all commits to be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). By signing off with your signature, you certify that you wrote the patch or otherwise have the right to contribute the material by the rules of the [DCO](https://raw.githubusercontent.com/open-component-model/.github/HEAD/DCO): +We require all commits to be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). By signing off with your signature, you certify that you wrote the patch or otherwise have the right to contribute the material by the rules of the [DCO](https://raw.githubusercontent.com/open-component-model/.github/main/DCO): `Signed-off-by: Jane Doe ` diff --git a/content/docs/examples/secure-software-delivery.md b/content/docs/examples/secure-software-delivery.md index 6017ba94..c92bf370 100644 --- a/content/docs/examples/secure-software-delivery.md +++ b/content/docs/examples/secure-software-delivery.md @@ -21,6 +21,7 @@ This walkthrough deploys a full end-to-end pipeline demonstrating how OCM and Fl The demo environment consists of Gitea, Tekton, Flux and the OCM controller. Two Gitea organizations are created: + - [software-provider](https://gitea.ocm.dev/software-provider) - [software-consumer](https://gitea.ocm.dev/software-consumer) @@ -154,5 +155,5 @@ OCM follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/m ## Licensing Copyright 2024 SE or an SAP affiliate company and Open Component Model contributors. -Please see our [LICENSE](LICENSE) for copyright and license information. +Please see our [LICENSE](https://raw.githubusercontent.com/open-component-model/.github/main/LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/open-component-model/demo-secure-delivery). From d456bc40b97169f0fa653a44151e29d99a80e754 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Thu, 22 Aug 2024 09:50:35 +0200 Subject: [PATCH 16/37] fix: Privacy Policy --- config/_default/hugo.toml | 2 +- config/_default/languages.toml | 2 +- config/_default/menus/menus.en.toml | 10 ---------- content/privacy.md | 14 -------------- 4 files changed, 2 insertions(+), 26 deletions(-) delete mode 100644 content/privacy.md diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml index 11b3fd13..c8d710d6 100644 --- a/config/_default/hugo.toml +++ b/config/_default/hugo.toml @@ -18,7 +18,7 @@ disableLanguages = ["de", "nl"] defaultContentLanguageInSubdir = false # Footer -footer = '© Copyright 2024, SAP SE and Open Component Model Contributors | Trademark | Privacy Policy | Terms of Use | Legal Disclosure' +footer = '© Copyright 2024, SAP SE and Open Component Model Contributors | Trademark | Privacy Policy | Terms of Use | Legal Disclosure' # Feed copyRight = "© Copyright 2024, SAP SE and Open Component Model Contributors" diff --git a/config/_default/languages.toml b/config/_default/languages.toml index 6a79526b..00731572 100644 --- a/config/_default/languages.toml +++ b/config/_default/languages.toml @@ -5,4 +5,4 @@ [en.params] languageISO = "EN" languageTag = "en-US" - footer = '© Copyright 2024, SAP SE and Open Component Model Contributors | Trademark | Privacy Policy | Terms of Use | Legal Disclosure' + footer = '© Copyright 2024, SAP SE and Open Component Model Contributors | Trademark | Privacy Policy | Terms of Use | Legal Disclosure' diff --git a/config/_default/menus/menus.en.toml b/config/_default/menus/menus.en.toml index f5ea04d6..0522b61a 100644 --- a/config/_default/menus/menus.en.toml +++ b/config/_default/menus/menus.en.toml @@ -26,13 +26,3 @@ pre = "" url = "https://kubernetes.slack.com/archives/C05UWBE8R1D" weight = 20 - -[[footer]] - name = "Privacy Policy" - url = "/privacy/" - weight = 10 - -# [[footer]] -# name = "Terms of Service" -# url = "/terms/" -# weight = 20 diff --git a/content/privacy.md b/content/privacy.md deleted file mode 100644 index 5d589539..00000000 --- a/content/privacy.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Privacy Policy" -description: "" -summary: "" -date: 2023-09-07T17:19:07+02:00 -lastmod: 2023-09-07T17:19:07+02:00 -draft: false -type: "legal" -seo: - title: "" # custom title (optional) - description: "" # custom description (recommended) - canonical: "" # custom canonical URL (optional) - noindex: false # false (default) or true ---- From 350c57e41a14ebcd494938c145c40b8f39e062bb Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Thu, 22 Aug 2024 12:37:37 +0200 Subject: [PATCH 17/37] fix links --- .github/config/markdown-link-check.json | 6 ------ .github/config/markdownignore | 2 ++ .../build-deploy-software-via-helm-charts-with-ocm-101.md | 2 +- 3 files changed, 3 insertions(+), 7 deletions(-) delete mode 100644 .github/config/markdown-link-check.json diff --git a/.github/config/markdown-link-check.json b/.github/config/markdown-link-check.json deleted file mode 100644 index 68b57bd1..00000000 --- a/.github/config/markdown-link-check.json +++ /dev/null @@ -1,6 +0,0 @@ -{ "replacementPatterns": [ - { "pattern": "^/", "replacement": "{{BASEURL}}/" } - ], - "ignorePatterns": [ - ] -} diff --git a/.github/config/markdownignore b/.github/config/markdownignore index e69de29b..546fac2c 100644 --- a/.github/config/markdownignore +++ b/.github/config/markdownignore @@ -0,0 +1,2 @@ +/content/docs/cli-reference +/content/docs/controller/controller-reference diff --git a/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md b/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md index 6e86aafc..7a8ac34f 100644 --- a/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md +++ b/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md @@ -13,7 +13,7 @@ toc: true ## Introduction Let's illustrate a very simple "Hello World" example application and show how to leverage OCM to build an application component containing a Helm Chart and an OCI Image and deploy it to a local `kind` k8s cluster. -The topics `ocm` [`localization`](/docs/tutorials/deployment-scenario-using-an-aggregated-component/#localization) and [`configuration`](/docs/tutorials/deployment-scenario-using-an-aggregated-component/#configuration) are NOT part of this very simple example, but is covered in other tutorials. +The topics `ocm` [`localization`](/docs/tutorials/structuring-and-deploying-software-products-with-ocm/#localization) and [`configuration`](/docs/tutorials/structuring-and-deploying-software-products-with-ocm/#configuration) are NOT part of this very simple example, but is covered in other tutorials. As base we use the `podinfo` application from Stefan Prodan's [Github repo](https://github.com/stefanprodan/podinfo). All files can be found [here](https://github.com/open-component-model/ocm-examples/tree/main/components). From 5a8bef800fcde8ad9d4fa65702948150483c7412 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Thu, 22 Aug 2024 15:27:33 +0200 Subject: [PATCH 18/37] lint fix bootstrap.md:132 MD024/no-duplicate-heading --- .github/config/markdownlint.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/config/markdownlint.yml b/.github/config/markdownlint.yml index b0e18773..079cff87 100644 --- a/.github/config/markdownlint.yml +++ b/.github/config/markdownlint.yml @@ -2,3 +2,5 @@ default: true MD013: false #Line length - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md013 MD033: false #Inline HTML - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md033 +MD024: + siblings_only: true #Multiple headers with the same content From ddf149905cbb35275589646685b1be19167d6951 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Thu, 22 Aug 2024 15:32:48 +0200 Subject: [PATCH 19/37] lint fix mpas getting_started --- content/mpas/getting_started.md | 393 ++++++++++++++++---------------- 1 file changed, 195 insertions(+), 198 deletions(-) diff --git a/content/mpas/getting_started.md b/content/mpas/getting_started.md index 58e44499..954e47c0 100644 --- a/content/mpas/getting_started.md +++ b/content/mpas/getting_started.md @@ -3,7 +3,6 @@ title: "Get Started with MPAS" description: "" lead: "" date: 2023-09-12T10:37:58+01:00 -lastmod: 2023-11-03T10:53:00+01:00 draft: false images: [] weight: 131 @@ -35,7 +34,7 @@ To install the MPAS CLI using `brew`: brew install open-component-model/tap/mpas ``` -For other installation methods, see the [installation guide](/mpas/installation/). +For other installation methods, see the [installation guide](installation.md). ## Bootstrap MPAS @@ -80,7 +79,7 @@ reconciles the `Project` resource. The output of the bootstrap is similar to the following: -```bash +```text Running mpas bootstrap ... ✓ Preparing Management repository mpas-bootstrap ✓ Fetching bootstrap component from ghcr.io/open-component-model/mpas-bootstrap-component @@ -110,7 +109,7 @@ be configured to watch the target github repository for changes in the path `./c Clone the `mpas-bootstrap` repository to your local machine: -```sh +```bash git clone https://github.com/$GITHUB_USER/mpas-bootstrap cd mpas-bootstrap ``` @@ -120,231 +119,229 @@ cd mpas-bootstrap The [podinfo application](https://github.com/stefanprodan/podinfo) has been packaged as an OCM component and can be retrieved from [Github](https://ghcr.io/open-component-model/podinfo). -1. Create a secret containing your GitHub credentials that will be used by MPAS to -create your project repository. +1. Create a secret containing your GitHub credentials that will be used by MPAS to create your project repository. -```bash -kubectl create secret generic \ - github-access \ - --from-literal=username=$GITHUB_USER \ - --from-literal=password=$GITHUB_TOKEN \ - -n mpas-system -``` + ```bash + kubectl create secret generic \ + github-access \ + --from-literal=username=$GITHUB_USER \ + --from-literal=password=$GITHUB_TOKEN \ + -n mpas-system + ``` 2. Create a project that will contain the podinfo application. -Let's create a directory for the project: + Let's create a directory for the project: -```bash -mkdir -p ./clusters/my-cluster/podinfo -```` + ```bash + mkdir -p ./clusters/my-cluster/podinfo + ```` -Then, create a `project.yaml` file in the `./clusters/my-cluster/podinfo` directory: + Then, create a `project.yaml` file in the `./clusters/my-cluster/podinfo` directory: -```bash -mpas create project podinfo-application \ - --owner=$GITHUB_USER \ - --provider=github \ - --visibility=public \ - --already-exists-policy=fail \ - --branch=main \ - --secret-ref=github-access \ - --email=$MY_EMAIL \ - --message=xxx \ - --author=mpas-admin \ - --maintainers=$GITHUB_USER \ - --prune \ - --personal \ - --export >> ./clusters/my-cluster/podinfo/project.yaml -``` + ```bash + mpas create project podinfo-application \ + --owner=$GITHUB_USER \ + --provider=github \ + --visibility=public \ + --already-exists-policy=fail \ + --branch=main \ + --secret-ref=github-access \ + --email=$MY_EMAIL \ + --message=xxx \ + --author=mpas-admin \ + --maintainers=$GITHUB_USER \ + --prune \ + --personal \ + --export >> ./clusters/my-cluster/podinfo/project.yaml + ``` -Then, apply the project to the cluster in a GitOps fashion: + Then, apply the project to the cluster in a GitOps fashion: -```bash -git add --all && git commit -m "Add podinfo project" && git push -``` + ```bash + git add --all && git commit -m "Add podinfo project" && git push + ``` -`Flux` will detect the changes and apply the project to the cluster. + `Flux` will detect the changes and apply the project to the cluster. -This will create a `namespace` for the project, a `serviceaccount`, and RBAC in the cluster. -It will also create a GitHub repository for the project, and configure `Flux` to manage the project's resources. + This will create a `namespace` for the project, a `serviceaccount`, and RBAC in the cluster. + It will also create a GitHub repository for the project, and configure `Flux` to manage the project's resources. 3. Add the needed secrets to the namespace -`Flux` is used to deploy all workloads in a GitOps way. `Flux` needs a secret in -the project namespace that will be used to communicate with github: + `Flux` is used to deploy all workloads in a GitOps way. `Flux` needs a secret in + the project namespace that will be used to communicate with github: -```bash -kubectl create secret generic \ - github-access \ - --from-literal=username=$GITHUB_USER \ - --from-literal=password=$GITHUB_TOKEN \ - -n mpas-podinfo-application -``` + ```bash + kubectl create secret generic \ + github-access \ + --from-literal=username=$GITHUB_USER \ + --from-literal=password=$GITHUB_TOKEN \ + -n mpas-podinfo-application + ``` -**Note** The credentials should have access to GitHub packages. + **Note** The credentials should have access to GitHub packages. -As part of step 2, a `serviceaccount` was created for the project. We will use this service account -to provide the necessary permissions to pull from the `ghcr` registry. + As part of step 2, a `serviceaccount` was created for the project. We will use this service account + to provide the necessary permissions to pull from the `ghcr` registry. -First, create a secret containing the credentials for the service account: + First, create a secret containing the credentials for the service account: -```bash -kubectl create secret docker-registry github-registry-key --docker-server=ghcr.io \ - --docker-username=$GITHUB_USER --docker-password=$GITHUB_TOKEN \ - --docker-email=$MY_EMAIL -n mpas-podinfo-application -``` + ```bash + kubectl create secret docker-registry github-registry-key --docker-server=ghcr.io \ + --docker-username=$GITHUB_USER --docker-password=$GITHUB_TOKEN \ + --docker-email=$MY_EMAIL -n mpas-podinfo-application + ``` -Then, patch the service account to use the secret: + Then, patch the service account to use the secret: -```bash -kubectl patch serviceaccount mpas-podinfo-application -p '{"imagePullSecrets": [{"name": "github-registry-key"}]}' \ - -n mpas-podinfo-application -``` + ```bash + kubectl patch serviceaccount mpas-podinfo-application -p '{"imagePullSecrets": [{"name": "github-registry-key"}]}' \ + -n mpas-podinfo-application + ``` -1. Clone the project repository +4. Clone the project repository -```bash -git clone https://github.com/$GITHUB_USER/mpas-podinfo-application -cd mpas-podinfo-application -``` + ```bash + git clone https://github.com/$GITHUB_USER/mpas-podinfo-application + cd mpas-podinfo-application + ``` 5. Add the podinfo `ComponentSubscription` -Create a file under `./subscriptions/` that will contain the subscription declaration. + Create a file under `./subscriptions/` that will contain the subscription declaration. -```bash -mpas create cs podinfo-subscription \ - --component=ocm.software/mpas/podinfo \ - --semver=">=v1.0.0" \ - --source-url=ghcr.io/open-component-model/mpas \ - --source-secret-ref=github-access \ - --target-url=ghcr.io/$GITHUB_USER \ - --target-secret-ref=github-access \ - --namespace=mpas-podinfo-application \ - --export >> ./subscriptions/podinfo.yaml -``` + ```bash + mpas create cs podinfo-subscription \ + --component=ocm.software/mpas/podinfo \ + --semver=">=v1.0.0" \ + --source-url=ghcr.io/open-component-model/mpas \ + --source-secret-ref=github-access \ + --target-url=ghcr.io/$GITHUB_USER \ + --target-secret-ref=github-access \ + --namespace=mpas-podinfo-application \ + --export >> ./subscriptions/podinfo.yaml + ``` -Then, apply the `ComponentSubscription` to the project in a GitOps fashion: + Then, apply the `ComponentSubscription` to the project in a GitOps fashion: -```bash -git add --all && git commit -m "Add podinfo subscription" && git push -``` + ```bash + git add --all && git commit -m "Add podinfo subscription" && git push + ``` -`Flux` will detect the changes and apply the subscription to the cluster. + `Flux` will detect the changes and apply the subscription to the cluster. -This will replicate the product referenced by the field `spec.component` in the `ComponentSubscription` resource from -the defined registry in `spec.source.url` to the `spec.destination.url` registry. + This will replicate the product referenced by the field `spec.component` in the `ComponentSubscription` resource from + the defined registry in `spec.source.url` to the `spec.destination.url` registry. 6. Add a `Target` for the podinfo application -The target will define where the application will be installed - - -```bash -cat <> ./targets/podinfo.yaml -apiVersion: mpas.ocm.software/v1alpha1 -kind: Target -metadata: - name: podinfo-kubernetes-target - namespace: mpas-podinfo-application - labels: - target.mpas.ocm.software/ingress-enabled: "true" # This label is defined by the component that will use it to select an appropriate target to deploy to. -spec: - type: kubernetes - access: - targetNamespace: podinfo - serviceAccountName: podinfo-sa - selector: - matchLabels: - mpas.ocm.software/target-selector: podinfo-kubernetes-target - interval: 5m0s -EOF -``` - -Then, apply the `Target` to the project in a GitOps fashion: - -```bash -git add --all && git commit -m "Add a target for podinfo" && git push -``` - -`Flux` will detect the changes and apply the target to the cluster. - -In order for the `Target` to reach a `Ready` state, the needed secrets should be created in the `podinfo` namespace. - -First, create a secret containing the credentials for the service account: - -```bash -kubectl create secret docker-registry github-registry-key --docker-server=ghcr.io \ - --docker-username=$GITHUB_USER --docker-password=$GITHUB_TOKEN \ - --docker-email=$MY_EMAIL -n podinfo -``` - -Then, add a label to allow the target to select it using the label selector: - -```bash -kubectl label secret github-registry-key mpas.ocm.software/target-selector=podinfo-kubernetes-target -n podinfo -``` - -1. Deploy the podinfo application - -In order to deploy the podinfo application, we need to create a `ProductDeploymentGenerator` resource: - -```bash -mpas create pdg podinfo \ - --service-account=mpas-podinfo-application \ - --subscription-name=podinfo-subscription \ - --subscription-namespace=mpas-podinfo-application \ - --namespace=mpas-podinfo-application \ - --export >> ./generators/podinfo.yaml -``` - -Then, apply the `ProductDeploymentGenerator` to the project in a GitOps fashion: - -```bash -git add --all && git commit -m "Add podinfo deployment generator" && git push -``` - -`Flux` will detect the changes and apply the resource to the cluster. - -This will create a pull request in the project repository with the `ProductDeployment` resource -that will deploy the podinfo application. - -Go to the project repository and retrieve the pull request. -It should contain a `ProductDeployment` declaration that provides the configuration and -all steps needed to deploy the product, as well as a `values.yaml` file. The `values` file -contains values that should be used to configure the different resources that are part of -the product to be deployed. There is a check that should pass before merging the pull request. - -Once the pull request is merged, `Flux` will detect the changes and deploy the application to the cluster. - -After a moment the `ProductDeployment` should be deployed successfully. -It is possible to verify this with the command: - -```bash -k describe productdeployment -n mpas-podinfo-application -``` - -The result should look something like: - -```bash -Name: podinfo -Namespace: mpas-podinfo-application -Labels: kustomize.toolkit.fluxcd.io/name=mpas-podinfo-application-products - kustomize.toolkit.fluxcd.io/namespace=mpas-system -API Version: mpas.ocm.software/v1alpha1 -Kind: ProductDeployment -Metadata: -... -Status: - Conditions: - Last Transition Time: 2023-09-14T10:14:41Z - Message: Reconciliation success - Observed Generation: 1 - Reason: Succeeded - Status: True - Type: Ready - Observed Generation: 1 -``` - -The application is deployed in the `podinfo` namespace. + The target will define where the application will be installed + + ```bash + cat <> ./targets/podinfo.yaml + apiVersion: mpas.ocm.software/v1alpha1 + kind: Target + metadata: + name: podinfo-kubernetes-target + namespace: mpas-podinfo-application + labels: + target.mpas.ocm.software/ingress-enabled: "true" # This label is defined by the component that will use it to select an appropriate target to deploy to. + spec: + type: kubernetes + access: + targetNamespace: podinfo + serviceAccountName: podinfo-sa + selector: + matchLabels: + mpas.ocm.software/target-selector: podinfo-kubernetes-target + interval: 5m0s + EOF + ``` + + Then, apply the `Target` to the project in a GitOps fashion: + + ```bash + git add --all && git commit -m "Add a target for podinfo" && git push + ``` + + `Flux` will detect the changes and apply the target to the cluster. + + In order for the `Target` to reach a `Ready` state, the needed secrets should be created in the `podinfo` namespace. + + First, create a secret containing the credentials for the service account: + + ```bash + kubectl create secret docker-registry github-registry-key --docker-server=ghcr.io \ + --docker-username=$GITHUB_USER --docker-password=$GITHUB_TOKEN \ + --docker-email=$MY_EMAIL -n podinfo + ``` + + Then, add a label to allow the target to select it using the label selector: + + ```bash + kubectl label secret github-registry-key mpas.ocm.software/target-selector=podinfo-kubernetes-target -n podinfo + ``` + +7. Deploy the podinfo application + + In order to deploy the podinfo application, we need to create a `ProductDeploymentGenerator` resource: + + ```bash + mpas create pdg podinfo \ + --service-account=mpas-podinfo-application \ + --subscription-name=podinfo-subscription \ + --subscription-namespace=mpas-podinfo-application \ + --namespace=mpas-podinfo-application \ + --export >> ./generators/podinfo.yaml + ``` + + Then, apply the `ProductDeploymentGenerator` to the project in a GitOps fashion: + + ```bash + git add --all && git commit -m "Add podinfo deployment generator" && git push + ``` + + `Flux` will detect the changes and apply the resource to the cluster. + + This will create a pull request in the project repository with the `ProductDeployment` resource + that will deploy the podinfo application. + + Go to the project repository and retrieve the pull request. + It should contain a `ProductDeployment` declaration that provides the configuration and + all steps needed to deploy the product, as well as a `values.yaml` file. The `values` file + contains values that should be used to configure the different resources that are part of + the product to be deployed. There is a check that should pass before merging the pull request. + + Once the pull request is merged, `Flux` will detect the changes and deploy the application to the cluster. + + After a moment the `ProductDeployment` should be deployed successfully. + It is possible to verify this with the command: + + ```bash + k describe productdeployment -n mpas-podinfo-application + ``` + + The result should look something like: + + ```text + Name: podinfo + Namespace: mpas-podinfo-application + Labels: kustomize.toolkit.fluxcd.io/name=mpas-podinfo-application-products + kustomize.toolkit.fluxcd.io/namespace=mpas-system + API Version: mpas.ocm.software/v1alpha1 + Kind: ProductDeployment + Metadata: + ... + Status: + Conditions: + Last Transition Time: 2023-09-14T10:14:41Z + Message: Reconciliation success + Observed Generation: 1 + Reason: Succeeded + Status: True + Type: Ready + Observed Generation: 1 + ``` + + The application is deployed in the `podinfo` namespace. From ec8877d5441b90a2dd3527f0926a31ed6cd483e1 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Thu, 22 Aug 2024 17:02:41 +0200 Subject: [PATCH 20/37] ```bash --- content/mpas/installation.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/content/mpas/installation.md b/content/mpas/installation.md index a6fc0e89..d204b79c 100644 --- a/content/mpas/installation.md +++ b/content/mpas/installation.md @@ -18,10 +18,14 @@ To install the MPAS CLI, you can download the binaries for major platforms from You can also install via [homebrew](https://brew.sh/) for macOS and Linux: -`brew install open-component-model/tap/mpas` +```bash +brew install open-component-model/tap/mpas +``` ## Bash To install with `bash` for macOS or Linux execute the following command: -`curl -sfL https://raw.githubusercontent.com/open-component-model/mpas/main/install.sh | sh -` +```bash +curl -sfL https://raw.githubusercontent.com/open-component-model/mpas/main/install.sh | sh - +``` From dafb5d7905594fc27ae44adeb24fe59c53c74848 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Thu, 22 Aug 2024 17:04:37 +0200 Subject: [PATCH 21/37] update node version + license --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index e679f055..89ce9016 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8,7 +8,7 @@ "name": "ocm-website", "version": "0.0.0", "hasInstallScript": true, - "license": "MIT", + "license": "Apache-2.0", "dependencies": { "@hyas/doks-core": "^1.4.1", "@hyas/images": "^3.1.0", @@ -23,8 +23,8 @@ "shx": "^0.3.4" }, "engines": { - "node": ">=18.14.1", - "pnpm": ">=8.10.0" + "node": ">=20.16.0", + "pnpm": ">=9.7.1" } }, "node_modules/@ampproject/remapping": { From c8b88aa1e7cbef4b0dc721cf232cc080c8647c0a Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Thu, 22 Aug 2024 17:04:49 +0200 Subject: [PATCH 22/37] md lint --- content/docs/tutorials/input_and_access.md | 28 +++++++++++----------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/content/docs/tutorials/input_and_access.md b/content/docs/tutorials/input_and_access.md index 8c5428bf..2c579af4 100644 --- a/content/docs/tutorials/input_and_access.md +++ b/content/docs/tutorials/input_and_access.md @@ -50,23 +50,23 @@ in a component descriptor. The following input types are supported: -* binary -* dir -* docker -* dockermulti -* file -* helm -* ociImage -* spiff -* utf-8 +- binary +- dir +- docker +- dockermulti +- file +- helm +- ociImage +- spiff +- utf-8 The following list of access types is supported: -* gitHub -* localBlob -* ociArtifact -* ociBlob -* s3 +- gitHub +- localBlob +- ociArtifact +- ociBlob +- s3 Not all access and input types can be combined in useful ways with all artifact types. But the OCM specification does not define any restrictions on possible combinations. From f7de3a042d2b19d3c0994ca65fecea74c1ae0787 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Mon, 26 Aug 2024 15:13:19 +0200 Subject: [PATCH 23/37] call reusable workflow --- .github/workflows/verify-md.yml | 29 +++++++---------------------- 1 file changed, 7 insertions(+), 22 deletions(-) diff --git a/.github/workflows/verify-md.yml b/.github/workflows/verify-md.yml index a4e386fd..4cf18613 100644 --- a/.github/workflows/verify-md.yml +++ b/.github/workflows/verify-md.yml @@ -8,18 +8,13 @@ on: - '**/*.md' jobs: - markdown-lint: - runs-on: ubuntu-latest - name: Lint Markdown - steps: - - uses: actions/checkout@v4 - - name: Markdown Linting - uses: nosborn/github-action-markdown-cli@v3 - with: - files: . - dot: true - config_file: .github/config/markdownlint.yml - ignore_path: .github/config/markdownignore + markdown-lint: # call reusable workflow from central '.github' repo + uses: open-component-model/.github/.github/workflows/markdown.yml + secrets: inherit + with: + config_file: .github/config/markdownlint.yml + ignore_path: .github/config/markdownignore + config_path: .github/config/spellcheck.yml verify-links: name: Verify HTML links runs-on: ubuntu-latest @@ -42,13 +37,3 @@ jobs: uses: untitaker/hyperlink@0.1.32 with: args: public/ --sources content/ - spellcheck: - name: Spellcheck - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - name: Spellcheck - uses: rojopolis/spellcheck-github-actions@v0 - with: - config_path: .github/config/spellcheck.yml - task_name: Markdown From 04d43115cf61d49a6fa73f5d7dd0c48132cb57bc Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Mon, 26 Aug 2024 15:15:19 +0200 Subject: [PATCH 24/37] fix: no version specified --- .github/workflows/verify-md.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/verify-md.yml b/.github/workflows/verify-md.yml index 4cf18613..053a0749 100644 --- a/.github/workflows/verify-md.yml +++ b/.github/workflows/verify-md.yml @@ -9,7 +9,7 @@ on: jobs: markdown-lint: # call reusable workflow from central '.github' repo - uses: open-component-model/.github/.github/workflows/markdown.yml + uses: open-component-model/.github/.github/workflows/markdown.yml@main secrets: inherit with: config_file: .github/config/markdownlint.yml From 0c039f5cdfd689d0829cf5e65af2a828fbf2cee8 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Mon, 26 Aug 2024 15:23:45 +0200 Subject: [PATCH 25/37] rename inputs --- .github/workflows/{verify-md.yml => verify.yml} | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) rename .github/workflows/{verify-md.yml => verify.yml} (85%) diff --git a/.github/workflows/verify-md.yml b/.github/workflows/verify.yml similarity index 85% rename from .github/workflows/verify-md.yml rename to .github/workflows/verify.yml index 053a0749..5ebcb970 100644 --- a/.github/workflows/verify-md.yml +++ b/.github/workflows/verify.yml @@ -12,9 +12,9 @@ jobs: uses: open-component-model/.github/.github/workflows/markdown.yml@main secrets: inherit with: - config_file: .github/config/markdownlint.yml - ignore_path: .github/config/markdownignore - config_path: .github/config/spellcheck.yml + md-lint: .github/config/markdownlint.yml + md-ignore: .github/config/markdownignore + spellcheck: .github/config/spellcheck.yml verify-links: name: Verify HTML links runs-on: ubuntu-latest From ac625cba387d823ebb9b1cc08a5def13b634034f Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Tue, 27 Aug 2024 15:58:40 +0200 Subject: [PATCH 26/37] individual link mapping --- hack/generate-cli-docs/generate_markdown.go | 4 +- hack/generate-cli-docs/map.go | 70 +++++++++++++++++++++ 2 files changed, 71 insertions(+), 3 deletions(-) create mode 100644 hack/generate-cli-docs/map.go diff --git a/hack/generate-cli-docs/generate_markdown.go b/hack/generate-cli-docs/generate_markdown.go index 8b78653b..cb5a6944 100644 --- a/hack/generate-cli-docs/generate_markdown.go +++ b/hack/generate-cli-docs/generate_markdown.go @@ -80,9 +80,7 @@ func genMarkdownTreeCustom(cmd *cobra.Command, dir, urlPrefix, parentCmd string) defer f.Close() linkHandler := func(path string) string { - link := strings.Replace(path, " ", "/", -1) - link = strings.Replace(link, "ocm", "cli-reference", 1) - return "/docs/" + link + return cmdToLink[path] } frontmatter := func() string { diff --git a/hack/generate-cli-docs/map.go b/hack/generate-cli-docs/map.go new file mode 100644 index 00000000..298bc653 --- /dev/null +++ b/hack/generate-cli-docs/map.go @@ -0,0 +1,70 @@ +package main + +var cmdToLink = map[string]string{ + "ocm add componentversions": "/docs/cli-reference/add/componentversions/", + "ocm add references": "/docs/cli-reference/add/references/", + "ocm add resource-configuration": "/docs/cli-reference/add/resource-configuration/", + "ocm add resources": "/docs/cli-reference/add/resources/", + "ocm add routingslips": "/docs/cli-reference/add/routingslips/", + "ocm add source-configuration": "/docs/cli-reference/add/source-configuration/", + "ocm add sources": "/docs/cli-reference/add/sources/", + "ocm add": "/docs/cli-reference/add/", + "ocm attributes": "/docs/cli-reference/help/attributes/", + "ocm bootstrap configuration": "https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration/", + "ocm bootstrap package": "https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package/", + "ocm check componentversions": "/docs/cli-reference/check/componentversions/", + "ocm check": "/docs/cli-reference/check/", + "ocm clean cache": "/docs/cli-reference/clean/cache/", + "ocm clean": "/docs/cli-reference/clean/", + "ocm configfile": "/docs/cli-reference/help/configfile/", + "ocm create componentarchive": "/docs/cli-reference/create/componentarchive/", + "ocm create rsakeypair": "/docs/cli-reference/create/rsakeypair/", + "ocm create transportarchive": "/docs/cli-reference/create/transportarchive/", + "ocm create": "/docs/cli-reference/create/", + "ocm describe artifacts": "/docs/cli-reference/describe/artifacts/", + "ocm describe cache": "/docs/cli-reference/describe/cache/", + "ocm describe package": "/docs/cli-reference/describe/package/", + "ocm describe plugins": "/docs/cli-reference/describe/plugins/", + "ocm describe": "/docs/cli-reference/describe/", + "ocm download artifacts": "/docs/cli-reference/download/artifacts/", + "ocm download cli": "/docs/cli-reference/download/cli/", + "ocm download componentversions": "/docs/cli-reference/download/componentversions/", + "ocm download resources": "/docs/cli-reference/download/resources/", + "ocm download": "/docs/cli-reference/download/", + "ocm get artifacts": "/docs/cli-reference/get/artifacts/", + "ocm get componentversions": "/docs/cli-reference/get/componentversions/", + "ocm get config": "/docs/cli-reference/get/config/", + "ocm get credentials": "/docs/cli-reference/get/credentials/", + "ocm get plugins": "/docs/cli-reference/get/plugins/", + "ocm get pubsub": "/docs/cli-reference/get/pubsub/", + "ocm get references": "/docs/cli-reference/get/references/", + "ocm get resources": "/docs/cli-reference/get/resources/", + "ocm get routingslips": "/docs/cli-reference/get/routingslips/", + "ocm get sources": "/docs/cli-reference/get/sources/", + "ocm get": "/docs/cli-reference/get/", + "ocm list componentversions": "/docs/cli-reference/list/componentversions/", + "ocm list": "/docs/cli-reference/list/", + "ocm logging": "/docs/cli-reference/help/logging/", + "ocm ocm-accessmethods": "/docs/cli-reference/help/ocm-accessmethods/", + "ocm ocm-downloadhandlers": "/docs/cli-reference/help/ocm-downloadhandlers/", + "ocm ocm-labels": "/docs/cli-reference/help/ocm-labels/", + "ocm ocm-pubsub": "/docs/cli-reference/help/ocm-pubsub/", + "ocm ocm-uploadhandlers": "/docs/cli-reference/help/ocm-uploadhandlers/", + "ocm set pubsub": "/docs/cli-reference/set/set_pubsub/", + "ocm set": "/docs/cli-reference/set/", + "ocm show tags": "/docs/cli-reference/show/tags/", + "ocm show versions": "/docs/cli-reference/show/versions/", + "ocm show": "/docs/cli-reference/show/", + "ocm sign componentversions": "/docs/cli-reference/sign/componentversions/", + "ocm sign hash": "/docs/cli-reference/sign/hash/", + "ocm sign": "/docs/cli-reference/sign/", + "ocm toi-bootstrapping": "/docs/cli-reference/help/toi-bootstrapping/", + "ocm transfer artifacts": "/docs/cli-reference/transfer/artifacts/", + "ocm transfer commontransportarchive": "/docs/cli-reference/transfer/commontransportarchive/", + "ocm transfer componentarchive": "/docs/cli-reference/transfer/componentarchive/", + "ocm transfer componentversions": "/docs/cli-reference/transfer/componentversions/", + "ocm transfer": "/docs/cli-reference/transfer/", + "ocm verify componentversions": "/docs/cli-reference/verify/componentversions/", + "ocm verify": "/docs/cli-reference/verify/", + "ocm": "/docs/cli-reference/", +} From 503b6a7b0ed110efafabb63c97537ff20c76ea10 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Tue, 27 Aug 2024 15:59:46 +0200 Subject: [PATCH 27/37] remove timestamp --- hack/generate-cli-docs/generate_markdown.go | 2 -- 1 file changed, 2 deletions(-) diff --git a/hack/generate-cli-docs/generate_markdown.go b/hack/generate-cli-docs/generate_markdown.go index cb5a6944..2528b11c 100644 --- a/hack/generate-cli-docs/generate_markdown.go +++ b/hack/generate-cli-docs/generate_markdown.go @@ -9,7 +9,6 @@ import ( "path/filepath" "sort" "strings" - "time" "github.com/spf13/cobra" "ocm.software/ocm/api/utils/cobrautils" @@ -19,7 +18,6 @@ const fmTmpl = `--- title: %s name: %s url: %s -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true From 60db66c1d144b1071e6619fb83eee74ddbc83748 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Tue, 27 Aug 2024 16:00:31 +0200 Subject: [PATCH 28/37] remove DisableAutoGenTag coding --- hack/generate-cli-docs/generate_markdown.go | 8 -------- hack/generate-cli-docs/main.go | 1 - 2 files changed, 9 deletions(-) diff --git a/hack/generate-cli-docs/generate_markdown.go b/hack/generate-cli-docs/generate_markdown.go index 2528b11c..f638cb5a 100644 --- a/hack/generate-cli-docs/generate_markdown.go +++ b/hack/generate-cli-docs/generate_markdown.go @@ -160,11 +160,6 @@ func genMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) buf.WriteString(fmt.Sprintf("* [%s](%s)\t — %s\n", pname, linkHandler(parent.CommandPath()), parent.Short)) } } - cmd.VisitParents(func(c *cobra.Command) { - if c.DisableAutoGenTag { - cmd.DisableAutoGenTag = c.DisableAutoGenTag - } - }) } children := cmd.Commands() @@ -202,9 +197,6 @@ func genMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) } } - if !cmd.DisableAutoGenTag { - buf.WriteString("###### Auto generated by spf13/cobra on " + time.Now().Format("2-Jan-2006") + "\n") - } _, err := buf.WriteTo(w) diff --git a/hack/generate-cli-docs/main.go b/hack/generate-cli-docs/main.go index b1b19294..1f54992a 100644 --- a/hack/generate-cli-docs/main.go +++ b/hack/generate-cli-docs/main.go @@ -62,7 +62,6 @@ func run(dir, urlPrefix string) error { } cmd := app.NewCliCommand(clictx.DefaultContext()) - cmd.DisableAutoGenTag = true for _, subCmd := range cmd.Commands() { if slices.Contains(commandDenyList, subCmd.Name()) { From 5edbd1c327273ba7f5cd31aff79aaf56be8f730f Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Tue, 27 Aug 2024 16:00:57 +0200 Subject: [PATCH 29/37] organize import --- hack/generate-cli-docs/generate_markdown.go | 5 ++--- hack/generate-cli-docs/main.go | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/hack/generate-cli-docs/generate_markdown.go b/hack/generate-cli-docs/generate_markdown.go index f638cb5a..be5d744f 100644 --- a/hack/generate-cli-docs/generate_markdown.go +++ b/hack/generate-cli-docs/generate_markdown.go @@ -3,15 +3,14 @@ package main import ( "bytes" "fmt" + "github.com/spf13/cobra" "io" + "ocm.software/ocm/api/utils/cobrautils" "os" "path" "path/filepath" "sort" "strings" - - "github.com/spf13/cobra" - "ocm.software/ocm/api/utils/cobrautils" ) const fmTmpl = `--- diff --git a/hack/generate-cli-docs/main.go b/hack/generate-cli-docs/main.go index 1f54992a..62061706 100644 --- a/hack/generate-cli-docs/main.go +++ b/hack/generate-cli-docs/main.go @@ -4,13 +4,12 @@ import ( "flag" "fmt" "log" + clictx "ocm.software/ocm/api/cli" + "ocm.software/ocm/cmds/ocm/app" "os" "path/filepath" "slices" "strings" - - clictx "ocm.software/ocm/api/cli" - "ocm.software/ocm/cmds/ocm/app" ) var commandDenyList = []string{ From 8ff6fa6144a62befcf76fd73a9d6b3c274f5c221 Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Tue, 27 Aug 2024 16:01:44 +0200 Subject: [PATCH 30/37] regenerate docs --- content/docs/cli-reference/_index.md | 35 +++++++++---------- content/docs/cli-reference/add/_index.md | 15 ++++---- .../add/add_componentversions.md | 9 +++-- .../docs/cli-reference/add/add_references.md | 3 +- .../add/add_resource-configuration.md | 7 ++-- .../docs/cli-reference/add/add_resources.md | 5 ++- .../cli-reference/add/add_routingslips.md | 3 +- .../add/add_source-configuration.md | 7 ++-- content/docs/cli-reference/add/add_sources.md | 5 ++- content/docs/cli-reference/check/_index.md | 3 +- .../check/check_componentversions.md | 3 +- content/docs/cli-reference/clean/_index.md | 3 +- .../docs/cli-reference/clean/clean_cache.md | 3 +- content/docs/cli-reference/create/_index.md | 7 ++-- .../create/create_componentarchive.md | 3 +- .../cli-reference/create/create_rsakeypair.md | 3 +- .../create/create_transportarchive.md | 3 +- content/docs/cli-reference/describe/_index.md | 9 +++-- .../describe/describe_artifacts.md | 3 +- .../cli-reference/describe/describe_cache.md | 3 +- .../describe/describe_package.md | 5 ++- .../describe/describe_plugins.md | 3 +- content/docs/cli-reference/download/_index.md | 9 +++-- .../download/download_artifacts.md | 3 +- .../cli-reference/download/download_cli.md | 3 +- .../download/download_componentversions.md | 3 +- .../download/download_resources.md | 5 ++- content/docs/cli-reference/get/_index.md | 21 ++++++----- .../docs/cli-reference/get/get_artifacts.md | 3 +- .../get/get_componentversions.md | 3 +- content/docs/cli-reference/get/get_config.md | 3 +- .../docs/cli-reference/get/get_credentials.md | 3 +- content/docs/cli-reference/get/get_plugins.md | 3 +- content/docs/cli-reference/get/get_pubsub.md | 5 ++- .../docs/cli-reference/get/get_references.md | 3 +- .../docs/cli-reference/get/get_resources.md | 3 +- .../cli-reference/get/get_routingslips.md | 3 +- content/docs/cli-reference/get/get_sources.md | 3 +- content/docs/cli-reference/help/_index.md | 1 - .../help/add_componentversions_ocm-labels.md | 5 ++- content/docs/cli-reference/help/attributes.md | 5 ++- content/docs/cli-reference/help/configfile.md | 5 ++- .../cli-reference/help/credential-handling.md | 3 +- .../describe_package_toi-bootstrapping.md | 13 ++++--- content/docs/cli-reference/help/logging.md | 5 ++- .../docs/cli-reference/help/oci-references.md | 1 - .../cli-reference/help/ocm-accessmethods.md | 3 +- .../help/ocm-downloadhandlers.md | 7 ++-- content/docs/cli-reference/help/ocm-labels.md | 1 - content/docs/cli-reference/help/ocm-pubsub.md | 5 ++- .../docs/cli-reference/help/ocm-references.md | 1 - .../cli-reference/help/ocm-uploadhandlers.md | 5 ++- .../cli-reference/help/toi-bootstrapping.md | 9 +++-- content/docs/cli-reference/list/_index.md | 3 +- .../list/list_componentversions.md | 3 +- content/docs/cli-reference/set/_index.md | 3 +- content/docs/cli-reference/set/set_pubsub.md | 7 ++-- content/docs/cli-reference/show/_index.md | 5 ++- content/docs/cli-reference/show/show_tags.md | 3 +- .../docs/cli-reference/show/show_versions.md | 3 +- content/docs/cli-reference/sign/_index.md | 5 ++- .../sign/sign_componentversions.md | 3 +- content/docs/cli-reference/sign/sign_hash.md | 3 +- content/docs/cli-reference/transfer/_index.md | 9 +++-- .../transfer/transfer_artifacts.md | 3 +- .../transfer_commontransportarchive.md | 5 ++- .../transfer/transfer_componentarchive.md | 3 +- .../transfer/transfer_componentversions.md | 5 ++- content/docs/cli-reference/verify/_index.md | 3 +- .../verify/verify_componentversions.md | 3 +- hugo_stats.json | 6 ++-- 71 files changed, 145 insertions(+), 215 deletions(-) diff --git a/content/docs/cli-reference/_index.md b/content/docs/cli-reference/_index.md index c5d96694..95f8ebee 100644 --- a/content/docs/cli-reference/_index.md +++ b/content/docs/cli-reference/_index.md @@ -2,7 +2,6 @@ title: cli-reference name: cli-reference url: /docs/cli-reference/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -47,7 +46,7 @@ It can be used in two ways: The command accepts some top level options, they can only be given before the sub commands. -A configuration according to [ocm configfile](/docs/cli-reference/configfile) is read from a .ocmconfig file +A configuration according to [ocm configfile](/docs/cli-reference/help/configfile/) is read from a .ocmconfig file located in the HOME directory. With the option --config other file locations can be specified. If nothing is specified and no file is found at the default location a default configuration is composed according to known type specific @@ -98,7 +97,7 @@ form The --log* options can be used to configure the logging behaviour. -For details see [ocm logging](/docs/cli-reference/logging). +For details see [ocm logging](/docs/cli-reference/help/logging/). There is a quick config option --logkeys to configure simple tag/realm based condition rules. The comma-separated names build an AND rule. @@ -110,7 +109,7 @@ realm is affected. For example /+ocm=trace will enable all log outp OCM library. A tag directly matches the logging tags. Used tags and realms can be found under -topic [ocm logging](/docs/cli-reference/logging). The ocm coding basically uses the realm ocm. +topic [ocm logging](/docs/cli-reference/help/logging/). The ocm coding basically uses the realm ocm. The default level to enable is info. Separated by an equal sign (=) optionally a dedicated level can be specified. Log levels can be (error, warn, info, debug and trace. @@ -120,7 +119,7 @@ logging configuration (yaml/json) via command line. If the argument starts with an @, the logging configuration is taken from a file. The value can be a simple type or a JSON/YAML string for complex values -(see [ocm attributes](/docs/cli-reference/attributes). The following attributes are supported: +(see [ocm attributes](/docs/cli-reference/help/attributes/). The following attributes are supported: - github.com/mandelsoft/logforward [logfwd]: *logconfig* Logging config structure used for config forwarding This attribute is used to specify a logging configuration intended @@ -363,19 +362,19 @@ by a certificate delivered with the signature. ##### Sub Commands -* [ocm add](/docs/cli-reference/add) — Add elements to a component repository or component version -* [ocm check](/docs/cli-reference/check) — check components in OCM repository -* [ocm clean](/docs/cli-reference/clean) — Cleanup/re-organize elements -* [ocm create](/docs/cli-reference/create) — Create transport or component archive -* [ocm describe](/docs/cli-reference/describe) — Describe various elements by using appropriate sub commands. -* [ocm download](/docs/cli-reference/download) — Download oci artifacts, resources or complete components -* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components -* [ocm list](/docs/cli-reference/list) — List information about components -* [ocm set](/docs/cli-reference/set) — Set information about OCM repositories -* [ocm show](/docs/cli-reference/show) — Show tags or versions -* [ocm sign](/docs/cli-reference/sign) — Sign components or hashes -* [ocm transfer](/docs/cli-reference/transfer) — Transfer artifacts or components -* [ocm verify](/docs/cli-reference/verify) — Verify component version signatures +* [ocm add](/docs/cli-reference/add/) — Add elements to a component repository or component version +* [ocm check](/docs/cli-reference/check/) — check components in OCM repository +* [ocm clean](/docs/cli-reference/clean/) — Cleanup/re-organize elements +* [ocm create](/docs/cli-reference/create/) — Create transport or component archive +* [ocm describe](/docs/cli-reference/describe/) — Describe various elements by using appropriate sub commands. +* [ocm download](/docs/cli-reference/download/) — Download oci artifacts, resources or complete components +* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components +* [ocm list](/docs/cli-reference/list/) — List information about components +* [ocm set](/docs/cli-reference/set/) — Set information about OCM repositories +* [ocm show](/docs/cli-reference/show/) — Show tags or versions +* [ocm sign](/docs/cli-reference/sign/) — Sign components or hashes +* [ocm transfer](/docs/cli-reference/transfer/) — Transfer artifacts or components +* [ocm verify](/docs/cli-reference/verify/) — Verify component version signatures diff --git a/content/docs/cli-reference/add/_index.md b/content/docs/cli-reference/add/_index.md index 1d8be6c8..70b1871d 100644 --- a/content/docs/cli-reference/add/_index.md +++ b/content/docs/cli-reference/add/_index.md @@ -2,7 +2,6 @@ title: add name: add url: /docs/cli-reference/add/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -27,11 +26,11 @@ ocm add [] ... ##### Sub Commands -* [ocm add componentversions](/docs/cli-reference/add/componentversions) — add component version(s) to a (new) transport archive -* [ocm add references](/docs/cli-reference/add/references) — add aggregation information to a component version -* [ocm add resource-configuration](/docs/cli-reference/add/resource-configuration) — add a resource specification to a resource config file -* [ocm add resources](/docs/cli-reference/add/resources) — add resources to a component version -* [ocm add routingslips](/docs/cli-reference/add/routingslips) — add routing slip entry -* [ocm add source-configuration](/docs/cli-reference/add/source-configuration) — add a source specification to a source config file -* [ocm add sources](/docs/cli-reference/add/sources) — add source information to a component version +* [ocm add componentversions](/docs/cli-reference/add/componentversions/) — add component version(s) to a (new) transport archive +* [ocm add references](/docs/cli-reference/add/references/) — add aggregation information to a component version +* [ocm add resource-configuration](/docs/cli-reference/add/resource-configuration/) — add a resource specification to a resource config file +* [ocm add resources](/docs/cli-reference/add/resources/) — add resources to a component version +* [ocm add routingslips](/docs/cli-reference/add/routingslips/) — add routing slip entry +* [ocm add source-configuration](/docs/cli-reference/add/source-configuration/) — add a source specification to a source config file +* [ocm add sources](/docs/cli-reference/add/sources/) — add source information to a component version diff --git a/content/docs/cli-reference/add/add_componentversions.md b/content/docs/cli-reference/add/add_componentversions.md index b5090ad9..345793fc 100644 --- a/content/docs/cli-reference/add/add_componentversions.md +++ b/content/docs/cli-reference/add/add_componentversions.md @@ -2,7 +2,6 @@ title: componentversions name: add componentversions url: /docs/cli-reference/add/componentversions/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -62,7 +61,7 @@ existing element append (false) or replace (true) the existing element. The source, resource and reference list can be composed according to the commands -[ocm add sources](/docs/cli-reference/add/sources), [ocm add resources](/docs/cli-reference/add/resources), [ocm add references](/docs/cli-reference/add/references), +[ocm add sources](/docs/cli-reference/add/sources/), [ocm add resources](/docs/cli-reference/add/resources/), [ocm add references](/docs/cli-reference/add/references/), respectively. The description file might contain: @@ -76,7 +75,7 @@ component descriptor. If given it overrides the --schema option of the command. By default, v2 is used. Various elements support to add arbitrary information by using labels -(see [ocm ocm-labels](/docs/cli-reference/ocm-labels)). +(see [ocm ocm-labels](/docs/cli-reference/help/ocm-labels/)). The --type option accepts a file format for the @@ -212,7 +211,7 @@ The uploader name may be a path expression with the following possibilities: -See [ocm ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) for further details on using +See [ocm ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) for further details on using upload handlers. @@ -255,7 +254,7 @@ next to the description file. ### See Also -* [ocm add](/docs/cli-reference/add) — Add elements to a component repository or component version +* [ocm add](/docs/cli-reference/add/) — Add elements to a component repository or component version diff --git a/content/docs/cli-reference/add/add_references.md b/content/docs/cli-reference/add/add_references.md index 973b7db6..ab706336 100644 --- a/content/docs/cli-reference/add/add_references.md +++ b/content/docs/cli-reference/add/add_references.md @@ -2,7 +2,6 @@ title: references name: add references url: /docs/cli-reference/add/references/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -174,5 +173,5 @@ $ ocm add references path/to/ca references.yaml VERSION=1.0.0 ### See Also -* [ocm add](/docs/cli-reference/add) — Add elements to a component repository or component version +* [ocm add](/docs/cli-reference/add/) — Add elements to a component repository or component version diff --git a/content/docs/cli-reference/add/add_resource-configuration.md b/content/docs/cli-reference/add/add_resource-configuration.md index b50423f1..2d9a3af5 100644 --- a/content/docs/cli-reference/add/add_resource-configuration.md +++ b/content/docs/cli-reference/add/add_resource-configuration.md @@ -2,7 +2,6 @@ title: resource-configuration name: add resource-configuration url: /docs/cli-reference/add/resource-configuration/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -76,7 +75,7 @@ ocm add resource-configuration [] { | =--resource, @@ -639,7 +638,7 @@ shown below. An optional keyring used to verify the chart. It uses the consumer identity type HelmChartRepository with the fields - for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials)). + for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials/)). Options used to configure fields: --accessPackage, --accessRepository, --accessVersion @@ -957,5 +956,5 @@ $ ocm add resource-configuration resources.yaml --name myresource --type PlainTe ### See Also -* [ocm add](/docs/cli-reference/add) — Add elements to a component repository or component version +* [ocm add](/docs/cli-reference/add/) — Add elements to a component repository or component version diff --git a/content/docs/cli-reference/add/add_resources.md b/content/docs/cli-reference/add/add_resources.md index 9819849d..5ad74452 100644 --- a/content/docs/cli-reference/add/add_resources.md +++ b/content/docs/cli-reference/add/add_resources.md @@ -2,7 +2,6 @@ title: resources name: add resources url: /docs/cli-reference/add/resources/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -650,7 +649,7 @@ shown below. An optional keyring used to verify the chart. It uses the consumer identity type HelmChartRepository with the fields - for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials)). + for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials/)). Options used to configure fields: --accessPackage, --accessRepository, --accessVersion @@ -988,5 +987,5 @@ $ ocm add resources --file path/to/ca resources.yaml VERSION=1.0.0 ### See Also -* [ocm add](/docs/cli-reference/add) — Add elements to a component repository or component version +* [ocm add](/docs/cli-reference/add/) — Add elements to a component repository or component version diff --git a/content/docs/cli-reference/add/add_routingslips.md b/content/docs/cli-reference/add/add_routingslips.md index 108d8307..5e37003c 100644 --- a/content/docs/cli-reference/add/add_routingslips.md +++ b/content/docs/cli-reference/add/add_routingslips.md @@ -2,7 +2,6 @@ title: routingslips name: add routingslips url: /docs/cli-reference/add/routingslips/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -122,5 +121,5 @@ $ ocm add routingslip ghcr.io/mandelsoft/ocm//ocmdemoinstaller:0.0.1-dev mandels ### See Also -* [ocm add](/docs/cli-reference/add) — Add elements to a component repository or component version +* [ocm add](/docs/cli-reference/add/) — Add elements to a component repository or component version diff --git a/content/docs/cli-reference/add/add_source-configuration.md b/content/docs/cli-reference/add/add_source-configuration.md index dd0b06d0..a4e7b1fe 100644 --- a/content/docs/cli-reference/add/add_source-configuration.md +++ b/content/docs/cli-reference/add/add_source-configuration.md @@ -2,7 +2,6 @@ title: source-configuration name: add source-configuration url: /docs/cli-reference/add/source-configuration/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -75,7 +74,7 @@ ocm add source-configuration [] { | =} ### Description -Add a source specification to a source config file used by [ocm add sources](/docs/cli-reference/add/sources). +Add a source specification to a source config file used by [ocm add sources](/docs/cli-reference/add/sources/). It is possible to describe a single source via command line options. The meta data of this element is described by the argument of option --source, @@ -639,7 +638,7 @@ shown below. An optional keyring used to verify the chart. It uses the consumer identity type HelmChartRepository with the fields - for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials)). + for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials/)). Options used to configure fields: --accessPackage, --accessRepository, --accessVersion @@ -957,5 +956,5 @@ $ ocm add source-config sources.yaml --name sources --type filesystem --access ' ### See Also -* [ocm add](/docs/cli-reference/add) — Add elements to a component repository or component version +* [ocm add](/docs/cli-reference/add/) — Add elements to a component repository or component version diff --git a/content/docs/cli-reference/add/add_sources.md b/content/docs/cli-reference/add/add_sources.md index 6a38576b..eb748436 100644 --- a/content/docs/cli-reference/add/add_sources.md +++ b/content/docs/cli-reference/add/add_sources.md @@ -2,7 +2,6 @@ title: sources name: add sources url: /docs/cli-reference/add/sources/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -648,7 +647,7 @@ shown below. An optional keyring used to verify the chart. It uses the consumer identity type HelmChartRepository with the fields - for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials)). + for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials/)). Options used to configure fields: --accessPackage, --accessRepository, --accessVersion @@ -972,5 +971,5 @@ $ ocm add sources --file path/to/cafile sources.yaml ### See Also -* [ocm add](/docs/cli-reference/add) — Add elements to a component repository or component version +* [ocm add](/docs/cli-reference/add/) — Add elements to a component repository or component version diff --git a/content/docs/cli-reference/check/_index.md b/content/docs/cli-reference/check/_index.md index dd230b75..da9273a2 100644 --- a/content/docs/cli-reference/check/_index.md +++ b/content/docs/cli-reference/check/_index.md @@ -2,7 +2,6 @@ title: check name: check url: /docs/cli-reference/check/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -27,5 +26,5 @@ ocm check [] ... ##### Sub Commands -* [ocm check componentversions](/docs/cli-reference/check/componentversions) — Check completeness of a component version in an OCM repository +* [ocm check componentversions](/docs/cli-reference/check/componentversions/) — Check completeness of a component version in an OCM repository diff --git a/content/docs/cli-reference/check/check_componentversions.md b/content/docs/cli-reference/check/check_componentversions.md index 46e4c198..bba0baf2 100644 --- a/content/docs/cli-reference/check/check_componentversions.md +++ b/content/docs/cli-reference/check/check_componentversions.md @@ -2,7 +2,6 @@ title: componentversions name: check componentversions url: /docs/cli-reference/check/componentversions/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -102,5 +101,5 @@ $ ocm get componentversion --repo OCIRegistry::ghcr.io mandelsoft/kubelink ### See Also -* [ocm check](/docs/cli-reference/check) — check components in OCM repository +* [ocm check](/docs/cli-reference/check/) — check components in OCM repository diff --git a/content/docs/cli-reference/clean/_index.md b/content/docs/cli-reference/clean/_index.md index b6beece2..d9213623 100644 --- a/content/docs/cli-reference/clean/_index.md +++ b/content/docs/cli-reference/clean/_index.md @@ -2,7 +2,6 @@ title: clean name: clean url: /docs/cli-reference/clean/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -27,5 +26,5 @@ ocm clean [] ... ##### Sub Commands -* [ocm clean cache](/docs/cli-reference/clean/cache) — cleanup oci blob cache +* [ocm clean cache](/docs/cli-reference/clean/cache/) — cleanup oci blob cache diff --git a/content/docs/cli-reference/clean/clean_cache.md b/content/docs/cli-reference/clean/clean_cache.md index d84e099b..d62cfa13 100644 --- a/content/docs/cli-reference/clean/clean_cache.md +++ b/content/docs/cli-reference/clean/clean_cache.md @@ -2,7 +2,6 @@ title: cache name: clean cache url: /docs/cli-reference/clean/cache/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -39,5 +38,5 @@ $ ocm clean cache ### See Also -* [ocm clean](/docs/cli-reference/clean) — Cleanup/re-organize elements +* [ocm clean](/docs/cli-reference/clean/) — Cleanup/re-organize elements diff --git a/content/docs/cli-reference/create/_index.md b/content/docs/cli-reference/create/_index.md index fba14567..cb3be2b8 100644 --- a/content/docs/cli-reference/create/_index.md +++ b/content/docs/cli-reference/create/_index.md @@ -2,7 +2,6 @@ title: create name: create url: /docs/cli-reference/create/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -27,7 +26,7 @@ ocm create [] ... ##### Sub Commands -* [ocm create componentarchive](/docs/cli-reference/create/componentarchive) — create new component archive -* [ocm create rsakeypair](/docs/cli-reference/create/rsakeypair) — create RSA public key pair -* [ocm create transportarchive](/docs/cli-reference/create/transportarchive) — create new OCI/OCM transport archive +* [ocm create componentarchive](/docs/cli-reference/create/componentarchive/) — create new component archive +* [ocm create rsakeypair](/docs/cli-reference/create/rsakeypair/) — create RSA public key pair +* [ocm create transportarchive](/docs/cli-reference/create/transportarchive/) — create new OCI/OCM transport archive diff --git a/content/docs/cli-reference/create/create_componentarchive.md b/content/docs/cli-reference/create/create_componentarchive.md index 29bd64fe..c56c2cf3 100644 --- a/content/docs/cli-reference/create/create_componentarchive.md +++ b/content/docs/cli-reference/create/create_componentarchive.md @@ -2,7 +2,6 @@ title: componentarchive name: create componentarchive url: /docs/cli-reference/create/componentarchive/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -62,5 +61,5 @@ $ ocm create componentarchive --file myfirst --provider acme.org --provider emai ### See Also -* [ocm create](/docs/cli-reference/create) — Create transport or component archive +* [ocm create](/docs/cli-reference/create/) — Create transport or component archive diff --git a/content/docs/cli-reference/create/create_rsakeypair.md b/content/docs/cli-reference/create/create_rsakeypair.md index 8c1bf0d6..5dd0a87b 100644 --- a/content/docs/cli-reference/create/create_rsakeypair.md +++ b/content/docs/cli-reference/create/create_rsakeypair.md @@ -2,7 +2,6 @@ title: rsakeypair name: create rsakeypair url: /docs/cli-reference/create/rsakeypair/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -69,5 +68,5 @@ $ ocm create rsakeypair mandelsoft.priv mandelsoft.cert issuer=mandelsoft ### See Also -* [ocm create](/docs/cli-reference/create) — Create transport or component archive +* [ocm create](/docs/cli-reference/create/) — Create transport or component archive diff --git a/content/docs/cli-reference/create/create_transportarchive.md b/content/docs/cli-reference/create/create_transportarchive.md index 02887459..c02882ee 100644 --- a/content/docs/cli-reference/create/create_transportarchive.md +++ b/content/docs/cli-reference/create/create_transportarchive.md @@ -2,7 +2,6 @@ title: transportarchive name: create transportarchive url: /docs/cli-reference/create/transportarchive/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -32,5 +31,5 @@ to host artifact content or a tar/tgz file. ### See Also -* [ocm create](/docs/cli-reference/create) — Create transport or component archive +* [ocm create](/docs/cli-reference/create/) — Create transport or component archive diff --git a/content/docs/cli-reference/describe/_index.md b/content/docs/cli-reference/describe/_index.md index 65216bdb..224ecce2 100644 --- a/content/docs/cli-reference/describe/_index.md +++ b/content/docs/cli-reference/describe/_index.md @@ -2,7 +2,6 @@ title: describe name: describe url: /docs/cli-reference/describe/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -27,8 +26,8 @@ ocm describe [] ... ##### Sub Commands -* [ocm describe artifacts](/docs/cli-reference/describe/artifacts) — describe artifact version -* [ocm describe cache](/docs/cli-reference/describe/cache) — show OCI blob cache information -* [ocm describe package](/docs/cli-reference/describe/package) — describe TOI package -* [ocm describe plugins](/docs/cli-reference/describe/plugins) — get plugins +* [ocm describe artifacts](/docs/cli-reference/describe/artifacts/) — describe artifact version +* [ocm describe cache](/docs/cli-reference/describe/cache/) — show OCI blob cache information +* [ocm describe package](/docs/cli-reference/describe/package/) — describe TOI package +* [ocm describe plugins](/docs/cli-reference/describe/plugins/) — get plugins diff --git a/content/docs/cli-reference/describe/describe_artifacts.md b/content/docs/cli-reference/describe/describe_artifacts.md index abb3e200..eb0e6492 100644 --- a/content/docs/cli-reference/describe/describe_artifacts.md +++ b/content/docs/cli-reference/describe/describe_artifacts.md @@ -2,7 +2,6 @@ title: artifacts name: describe artifacts url: /docs/cli-reference/describe/artifacts/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -86,5 +85,5 @@ $ ocm describe artifact --repo OCIRegistry::ghcr.io mandelsoft/kubelink ### See Also -* [ocm describe](/docs/cli-reference/describe) — Describe various elements by using appropriate sub commands. +* [ocm describe](/docs/cli-reference/describe/) — Describe various elements by using appropriate sub commands. diff --git a/content/docs/cli-reference/describe/describe_cache.md b/content/docs/cli-reference/describe/describe_cache.md index 8dc6d9d8..741ee8cd 100644 --- a/content/docs/cli-reference/describe/describe_cache.md +++ b/content/docs/cli-reference/describe/describe_cache.md @@ -2,7 +2,6 @@ title: cache name: describe cache url: /docs/cli-reference/describe/cache/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -37,5 +36,5 @@ $ ocm cache info ### See Also -* [ocm describe](/docs/cli-reference/describe) — Describe various elements by using appropriate sub commands. +* [ocm describe](/docs/cli-reference/describe/) — Describe various elements by using appropriate sub commands. diff --git a/content/docs/cli-reference/describe/describe_package.md b/content/docs/cli-reference/describe/describe_package.md index cad3b139..8a4b92ad 100644 --- a/content/docs/cli-reference/describe/describe_package.md +++ b/content/docs/cli-reference/describe/describe_package.md @@ -2,7 +2,6 @@ title: package name: describe package url: /docs/cli-reference/describe/package/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -30,7 +29,7 @@ Describe a TOI package provided by a resource of an OCM component version. The package resource must have the type toiPackage. This is a simple YAML file resource describing the bootstrapping of a dedicated kind -of software. See also the topic [ocm toi-bootstrapping](/docs/cli-reference/toi-bootstrapping). +of software. See also the topic [ocm toi-bootstrapping](/docs/cli-reference/help/toi-bootstrapping/). The first matching resource of this type is selected. Optionally a set of identity attribute can be specified used to refine the match. This can be the @@ -100,7 +99,7 @@ $ ocm toi describe package ghcr.io/mandelsoft/ocm//ocmdemoinstaller:0.0.1-dev ### See Also -* [ocm describe](/docs/cli-reference/describe) — Describe various elements by using appropriate sub commands. +* [ocm describe](/docs/cli-reference/describe/) — Describe various elements by using appropriate sub commands. diff --git a/content/docs/cli-reference/describe/describe_plugins.md b/content/docs/cli-reference/describe/describe_plugins.md index e6b01b59..fa40ba25 100644 --- a/content/docs/cli-reference/describe/describe_plugins.md +++ b/content/docs/cli-reference/describe/describe_plugins.md @@ -2,7 +2,6 @@ title: plugins name: describe plugins url: /docs/cli-reference/describe/plugins/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -39,5 +38,5 @@ $ ocm describe plugins demo ### See Also -* [ocm describe](/docs/cli-reference/describe) — Describe various elements by using appropriate sub commands. +* [ocm describe](/docs/cli-reference/describe/) — Describe various elements by using appropriate sub commands. diff --git a/content/docs/cli-reference/download/_index.md b/content/docs/cli-reference/download/_index.md index 792c752d..35be0fd8 100644 --- a/content/docs/cli-reference/download/_index.md +++ b/content/docs/cli-reference/download/_index.md @@ -2,7 +2,6 @@ title: download name: download url: /docs/cli-reference/download/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -27,8 +26,8 @@ ocm download [] ... ##### Sub Commands -* [ocm download artifacts](/docs/cli-reference/download/artifacts) — download oci artifacts -* [ocm download cli](/docs/cli-reference/download/cli) — download OCM CLI from an OCM repository -* [ocm download componentversions](/docs/cli-reference/download/componentversions) — download ocm component versions -* [ocm download resources](/docs/cli-reference/download/resources) — download resources of a component version +* [ocm download artifacts](/docs/cli-reference/download/artifacts/) — download oci artifacts +* [ocm download cli](/docs/cli-reference/download/cli/) — download OCM CLI from an OCM repository +* [ocm download componentversions](/docs/cli-reference/download/componentversions/) — download ocm component versions +* [ocm download resources](/docs/cli-reference/download/resources/) — download resources of a component version diff --git a/content/docs/cli-reference/download/download_artifacts.md b/content/docs/cli-reference/download/download_artifacts.md index da64fe8c..cdf7781d 100644 --- a/content/docs/cli-reference/download/download_artifacts.md +++ b/content/docs/cli-reference/download/download_artifacts.md @@ -2,7 +2,6 @@ title: artifacts name: download artifacts url: /docs/cli-reference/download/artifacts/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -88,5 +87,5 @@ The default format is directory. ### See Also -* [ocm download](/docs/cli-reference/download) — Download oci artifacts, resources or complete components +* [ocm download](/docs/cli-reference/download/) — Download oci artifacts, resources or complete components diff --git a/content/docs/cli-reference/download/download_cli.md b/content/docs/cli-reference/download/download_cli.md index e6b81186..d262642f 100644 --- a/content/docs/cli-reference/download/download_cli.md +++ b/content/docs/cli-reference/download/download_cli.md @@ -2,7 +2,6 @@ title: cli name: download cli url: /docs/cli-reference/download/cli/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -96,5 +95,5 @@ option. Otherwise the resource as returned by the access method is stored. ### See Also -* [ocm download](/docs/cli-reference/download) — Download oci artifacts, resources or complete components +* [ocm download](/docs/cli-reference/download/) — Download oci artifacts, resources or complete components diff --git a/content/docs/cli-reference/download/download_componentversions.md b/content/docs/cli-reference/download/download_componentversions.md index 9a6186cb..b8ffcb8d 100644 --- a/content/docs/cli-reference/download/download_componentversions.md +++ b/content/docs/cli-reference/download/download_componentversions.md @@ -2,7 +2,6 @@ title: componentversions name: download componentversions url: /docs/cli-reference/download/componentversions/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -88,5 +87,5 @@ The default format is directory. ### See Also -* [ocm download](/docs/cli-reference/download) — Download oci artifacts, resources or complete components +* [ocm download](/docs/cli-reference/download/) — Download oci artifacts, resources or complete components diff --git a/content/docs/cli-reference/download/download_resources.md b/content/docs/cli-reference/download/download_resources.md index 05760034..f8d5ae3a 100644 --- a/content/docs/cli-reference/download/download_resources.md +++ b/content/docs/cli-reference/download/download_resources.md @@ -2,7 +2,6 @@ title: resources name: download resources url: /docs/cli-reference/download/resources/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -203,7 +202,7 @@ The downloader name may be a path expression with the following possibilities: -See [ocm ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers) for further details on using +See [ocm ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/) for further details on using download handlers. @@ -229,5 +228,5 @@ references. ### See Also -* [ocm download](/docs/cli-reference/download) — Download oci artifacts, resources or complete components +* [ocm download](/docs/cli-reference/download/) — Download oci artifacts, resources or complete components diff --git a/content/docs/cli-reference/get/_index.md b/content/docs/cli-reference/get/_index.md index d6a3f3c5..4fae0d92 100644 --- a/content/docs/cli-reference/get/_index.md +++ b/content/docs/cli-reference/get/_index.md @@ -2,7 +2,6 @@ title: get name: get url: /docs/cli-reference/get/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -27,14 +26,14 @@ ocm get [] ... ##### Sub Commands -* [ocm get artifacts](/docs/cli-reference/get/artifacts) — get artifact version -* [ocm get componentversions](/docs/cli-reference/get/componentversions) — get component version -* [ocm get config](/docs/cli-reference/get/config) — Get evaluated config for actual command call -* [ocm get credentials](/docs/cli-reference/get/credentials) — Get credentials for a dedicated consumer spec -* [ocm get plugins](/docs/cli-reference/get/plugins) — get plugins -* [ocm get pubsub](/docs/cli-reference/get/pubsub) — Get the pubsub spec for an ocm repository -* [ocm get references](/docs/cli-reference/get/references) — get references of a component version -* [ocm get resources](/docs/cli-reference/get/resources) — get resources of a component version -* [ocm get routingslips](/docs/cli-reference/get/routingslips) — get routings slips for a component version -* [ocm get sources](/docs/cli-reference/get/sources) — get sources of a component version +* [ocm get artifacts](/docs/cli-reference/get/artifacts/) — get artifact version +* [ocm get componentversions](/docs/cli-reference/get/componentversions/) — get component version +* [ocm get config](/docs/cli-reference/get/config/) — Get evaluated config for actual command call +* [ocm get credentials](/docs/cli-reference/get/credentials/) — Get credentials for a dedicated consumer spec +* [ocm get plugins](/docs/cli-reference/get/plugins/) — get plugins +* [ocm get pubsub](/docs/cli-reference/get/pubsub/) — Get the pubsub spec for an ocm repository +* [ocm get references](/docs/cli-reference/get/references/) — get references of a component version +* [ocm get resources](/docs/cli-reference/get/resources/) — get resources of a component version +* [ocm get routingslips](/docs/cli-reference/get/routingslips/) — get routings slips for a component version +* [ocm get sources](/docs/cli-reference/get/sources/) — get sources of a component version diff --git a/content/docs/cli-reference/get/get_artifacts.md b/content/docs/cli-reference/get/get_artifacts.md index 18a31418..6e8582ea 100644 --- a/content/docs/cli-reference/get/get_artifacts.md +++ b/content/docs/cli-reference/get/get_artifacts.md @@ -2,7 +2,6 @@ title: artifacts name: get artifacts url: /docs/cli-reference/get/artifacts/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -91,5 +90,5 @@ $ ocm get artifact --repo OCIRegistry::ghcr.io mandelsoft/kubelink ### See Also -* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components +* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components diff --git a/content/docs/cli-reference/get/get_componentversions.md b/content/docs/cli-reference/get/get_componentversions.md index 84ffd1b2..041c1217 100644 --- a/content/docs/cli-reference/get/get_componentversions.md +++ b/content/docs/cli-reference/get/get_componentversions.md @@ -2,7 +2,6 @@ title: componentversions name: get componentversions url: /docs/cli-reference/get/componentversions/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -130,5 +129,5 @@ $ ocm get componentversion --repo OCIRegistry::ghcr.io mandelsoft/kubelink ### See Also -* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components +* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components diff --git a/content/docs/cli-reference/get/get_config.md b/content/docs/cli-reference/get/get_config.md index 98846a3c..b3556130 100644 --- a/content/docs/cli-reference/get/get_config.md +++ b/content/docs/cli-reference/get/get_config.md @@ -2,7 +2,6 @@ title: config name: get config url: /docs/cli-reference/get/config/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -41,5 +40,5 @@ The following modes are supported: ### See Also -* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components +* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components diff --git a/content/docs/cli-reference/get/get_credentials.md b/content/docs/cli-reference/get/get_credentials.md index fb425769..556f7920 100644 --- a/content/docs/cli-reference/get/get_credentials.md +++ b/content/docs/cli-reference/get/get_credentials.md @@ -2,7 +2,6 @@ title: credentials name: get credentials url: /docs/cli-reference/get/credentials/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -194,5 +193,5 @@ The usage of a dedicated matcher can be enforced by the option --matcher--output the output mode can be selected. @@ -43,5 +42,5 @@ The following modes are supported: ### See Also -* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components +* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components diff --git a/content/docs/cli-reference/get/get_references.md b/content/docs/cli-reference/get/get_references.md index f9f28ead..9a3aca29 100644 --- a/content/docs/cli-reference/get/get_references.md +++ b/content/docs/cli-reference/get/get_references.md @@ -2,7 +2,6 @@ title: references name: get references url: /docs/cli-reference/get/references/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -112,5 +111,5 @@ The following modes are supported: ### See Also -* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components +* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components diff --git a/content/docs/cli-reference/get/get_resources.md b/content/docs/cli-reference/get/get_resources.md index 708ded17..bc0a3e3b 100644 --- a/content/docs/cli-reference/get/get_resources.md +++ b/content/docs/cli-reference/get/get_resources.md @@ -2,7 +2,6 @@ title: resources name: get resources url: /docs/cli-reference/get/resources/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -113,5 +112,5 @@ The following modes are supported: ### See Also -* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components +* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components diff --git a/content/docs/cli-reference/get/get_routingslips.md b/content/docs/cli-reference/get/get_routingslips.md index dd45e227..71bad0ec 100644 --- a/content/docs/cli-reference/get/get_routingslips.md +++ b/content/docs/cli-reference/get/get_routingslips.md @@ -2,7 +2,6 @@ title: routingslips name: get routingslips url: /docs/cli-reference/get/routingslips/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -107,5 +106,5 @@ The following modes are supported: ### See Also -* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components +* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components diff --git a/content/docs/cli-reference/get/get_sources.md b/content/docs/cli-reference/get/get_sources.md index 0bb2b08b..78ce8f9b 100644 --- a/content/docs/cli-reference/get/get_sources.md +++ b/content/docs/cli-reference/get/get_sources.md @@ -2,7 +2,6 @@ title: sources name: get sources url: /docs/cli-reference/get/sources/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -112,5 +111,5 @@ The following modes are supported: ### See Also -* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components +* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components diff --git a/content/docs/cli-reference/help/_index.md b/content/docs/cli-reference/help/_index.md index 54eb08d4..3fe03571 100644 --- a/content/docs/cli-reference/help/_index.md +++ b/content/docs/cli-reference/help/_index.md @@ -2,7 +2,6 @@ title: help name: help url: /docs/cli-reference/help -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true diff --git a/content/docs/cli-reference/help/add_componentversions_ocm-labels.md b/content/docs/cli-reference/help/add_componentversions_ocm-labels.md index d551b5e6..a03d6225 100644 --- a/content/docs/cli-reference/help/add_componentversions_ocm-labels.md +++ b/content/docs/cli-reference/help/add_componentversions_ocm-labels.md @@ -2,7 +2,6 @@ title: ocm-labels name: ocm-labels url: /docs/cli-reference/help/ocm-labels/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -183,6 +182,6 @@ The following label assignments are configured: ### See Also -* [ocm add componentversions](/docs/cli-reference/add/componentversions) — add component version(s) to a (new) transport archive -* [ocm add](/docs/cli-reference/add) — Add elements to a component repository or component version +* [ocm add componentversions](/docs/cli-reference/add/componentversions/) — add component version(s) to a (new) transport archive +* [ocm add](/docs/cli-reference/add/) — Add elements to a component repository or component version diff --git a/content/docs/cli-reference/help/attributes.md b/content/docs/cli-reference/help/attributes.md index cebf70e4..b061a78c 100644 --- a/content/docs/cli-reference/help/attributes.md +++ b/content/docs/cli-reference/help/attributes.md @@ -2,7 +2,6 @@ title: attributes name: attributes url: /docs/cli-reference/help/attributes/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -14,8 +13,8 @@ sidebar: The OCM library supports a set of attributes, which can be used to influence the behaviour of various functions. The CLI also supports setting of those -attributes using the config file (see [ocm configfile](/docs/cli-reference/configfile)) or by -command line options of the main command (see [ocm](/docs/cli-reference)). +attributes using the config file (see [ocm configfile](/docs/cli-reference/help/configfile/)) or by +command line options of the main command (see [ocm](/docs/cli-reference/)). The following options are available in the currently used version of the OCM library: diff --git a/content/docs/cli-reference/help/configfile.md b/content/docs/cli-reference/help/configfile.md index d0efb252..7ebc716b 100644 --- a/content/docs/cli-reference/help/configfile.md +++ b/content/docs/cli-reference/help/configfile.md @@ -2,7 +2,6 @@ title: configfile name: configfile url: /docs/cli-reference/help/configfile/ -date: 2024-04-17T18:02:57+02:00 draft: false images: [] toc: true @@ -71,7 +70,7 @@ The following configuration types are supported: - downloader.ocm.config.ocm.software The config type downloader.ocm.config.ocm.software can be used to define a list - of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers)): + of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/)): 
       type: downloader.ocm.config.ocm.software
@@ -322,7 +321,7 @@ The following configuration types are supported:
- uploader.ocm.config.ocm.software The config type uploader.ocm.config.ocm.software can be used to define a list - of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers)): + of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/)): 
       type: uploader.ocm.config.ocm.software
diff --git a/content/docs/cli-reference/help/credential-handling.md b/content/docs/cli-reference/help/credential-handling.md
index 44356422..a1349a30 100644
--- a/content/docs/cli-reference/help/credential-handling.md
+++ b/content/docs/cli-reference/help/credential-handling.md
@@ -2,7 +2,6 @@
 title: credential-handling
 name: credential-handling
 url: /docs/cli-reference/help/credential-handling/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -279,7 +278,7 @@ by the provider type).
 The type Credentials can be used to inline
 credentials in credential configuration objects
 to configure mappings of consumer identities to a credential
-set (see [ocm configfile](/docs/cli-reference/configfile)).
+set (see [ocm configfile](/docs/cli-reference/help/configfile/)).
 
 The following types are currently available:
 
diff --git a/content/docs/cli-reference/help/describe_package_toi-bootstrapping.md b/content/docs/cli-reference/help/describe_package_toi-bootstrapping.md
index acb6d9f9..9039ede5 100644
--- a/content/docs/cli-reference/help/describe_package_toi-bootstrapping.md
+++ b/content/docs/cli-reference/help/describe_package_toi-bootstrapping.md
@@ -2,7 +2,6 @@
 title: toi-bootstrapping
 name: toi-bootstrapping
 url: /docs/cli-reference/help/toi-bootstrapping/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -17,11 +16,11 @@ a possibility to run images taken from a component version with user
 configuration and feed them with the content of this component version.
 It is some basic mechanism, which can be used to execute simple installation
 steps based on content described by the Open Component Model
-(see [ocm bootstrap package](/docs/cli-reference/bootstrap/package)).
+(see [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package/)).
 
 Therefore, a dedicated resource type toiPackage is defined,
 which describes an installation package to be handled by TOI.
-When calling the [ocm bootstrap package](/docs/cli-reference/bootstrap/package) command it is selected by a resource
+When calling the [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package/) command it is selected by a resource
 identity pattern. The first resource in given component version matching the
 pattern is used. A possible use case could be to provide different packages for
 different environments. The resource can use an identity attribute
@@ -110,7 +109,7 @@ It has the following format:
   - **configFile**: an example template for a parameter file
   - **credentialsFile**: an example template for a credentials file
 
-  Those templates can be downloaded with [ocm bootstrap configuration](/docs/cli-reference/bootstrap/configuration).
+  Those templates can be downloaded with [ocm bootstrap configuration](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration/).
 
 #### *ExecutorSpecification*
 
@@ -359,7 +358,7 @@ It uses the following fields:
   in the OCM support library, if used by the executor. At least the field
   type and one additional field must be set.
 
-Credentials are provided in an ocm config file (see [ocm configfile](/docs/cli-reference/configfile)).
+Credentials are provided in an ocm config file (see [ocm configfile](/docs/cli-reference/help/configfile/)).
 It uses a memory credential repository with the name default
 to store the credentials under the given name. Additionally appropriate
 consumer ids will be propagated, if requested in the credentials request config.
@@ -463,6 +462,6 @@ additionalResources:
 
 ### See Also
 
-* [ocm describe package](/docs/cli-reference/describe/package)	 — describe TOI package
-* [ocm describe](/docs/cli-reference/describe)	 — Describe various elements by using appropriate sub commands.
+* [ocm describe package](/docs/cli-reference/describe/package/)	 — describe TOI package
+* [ocm describe](/docs/cli-reference/describe/)	 — Describe various elements by using appropriate sub commands.
 
diff --git a/content/docs/cli-reference/help/logging.md b/content/docs/cli-reference/help/logging.md
index e0b5a698..4629339e 100644
--- a/content/docs/cli-reference/help/logging.md
+++ b/content/docs/cli-reference/help/logging.md
@@ -2,7 +2,6 @@
 title: logging
 name: logging
 url: /docs/cli-reference/help/logging/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -12,8 +11,8 @@ sidebar:
 ### Description
 
 
-Logging can be configured as part of the ocm config file ([ocm configfile](/docs/cli-reference/configfile))
-or by command line options of the [ocm](/docs/cli-reference) command. Details about
+Logging can be configured as part of the ocm config file ([ocm configfile](/docs/cli-reference/help/configfile/))
+or by command line options of the [ocm](/docs/cli-reference/) command. Details about
 the YAML structure of a logging settings can be found on https://github.com/mandelsoft/logging.
 
 The command line also supports some quick-config options for enabling log levels
diff --git a/content/docs/cli-reference/help/oci-references.md b/content/docs/cli-reference/help/oci-references.md
index 13cf0fa6..06d8f729 100644
--- a/content/docs/cli-reference/help/oci-references.md
+++ b/content/docs/cli-reference/help/oci-references.md
@@ -2,7 +2,6 @@
 title: oci-references
 name: oci-references
 url: /docs/cli-reference/help/oci-references/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
diff --git a/content/docs/cli-reference/help/ocm-accessmethods.md b/content/docs/cli-reference/help/ocm-accessmethods.md
index 091151da..75b8f364 100644
--- a/content/docs/cli-reference/help/ocm-accessmethods.md
+++ b/content/docs/cli-reference/help/ocm-accessmethods.md
@@ -2,7 +2,6 @@
 title: ocm-accessmethods
 name: ocm-accessmethods
 url: /docs/cli-reference/help/ocm-accessmethods/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -133,7 +132,7 @@ shown below.
       An optional keyring used to verify the chart.
     
     It uses the consumer identity type HelmChartRepository with the fields
-    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials)).
+    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials/)).
   
   Options used to configure fields: --accessPackage, --accessRepository, --accessVersion
   
diff --git a/content/docs/cli-reference/help/ocm-downloadhandlers.md b/content/docs/cli-reference/help/ocm-downloadhandlers.md
index a48f4a48..d32efd55 100644
--- a/content/docs/cli-reference/help/ocm-downloadhandlers.md
+++ b/content/docs/cli-reference/help/ocm-downloadhandlers.md
@@ -2,7 +2,6 @@
 title: ocm-downloadhandlers
 name: ocm-downloadhandlers
 url: /docs/cli-reference/help/ocm-downloadhandlers/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -14,7 +13,7 @@ sidebar:
 
 A download handler can be used to process resources to be downloaded from
 on OCM repository. By default, the blobs provided from the access method
-(see [ocm ocm-accessmethods](/docs/cli-reference/ocm-accessmethods)) are used to store the resource content
+(see [ocm ocm-accessmethods](/docs/cli-reference/help/ocm-accessmethods/)) are used to store the resource content
 in the local filesystem. Download handlers can be used to tweak this process.
 They get access to the blob content and decide on their own what to do
 with it, or how to transform it into files stored in the file system.
@@ -31,7 +30,7 @@ New handlers can be provided by plugins. In general available handlers,
 plugin-based or as part of the CLI coding are nameable using an hierarchical
 namespace. Those names can be used by a --downloader option
 to register handlers for various conditions for CLI commands like
-[ocm download resources](/docs/cli-reference/download/resources) (implicitly registered download handlers
+[ocm download resources](/docs/cli-reference/download/resources/) (implicitly registered download handlers
 can be enabled using the option -d).
 
 Besides the activation constraints (resource type and media type of the
@@ -121,7 +120,7 @@ The following handler names are possible:
 
 
 
-See [ocm ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers) for further details on using
+See [ocm ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/) for further details on using
 download handlers.
 
 
diff --git a/content/docs/cli-reference/help/ocm-labels.md b/content/docs/cli-reference/help/ocm-labels.md
index 7de9c785..2708411a 100644
--- a/content/docs/cli-reference/help/ocm-labels.md
+++ b/content/docs/cli-reference/help/ocm-labels.md
@@ -2,7 +2,6 @@
 title: ocm-labels
 name: ocm-labels
 url: /docs/cli-reference/help/ocm-labels/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
diff --git a/content/docs/cli-reference/help/ocm-pubsub.md b/content/docs/cli-reference/help/ocm-pubsub.md
index f4683d91..068bbd1e 100644
--- a/content/docs/cli-reference/help/ocm-pubsub.md
+++ b/content/docs/cli-reference/help/ocm-pubsub.md
@@ -2,7 +2,6 @@
 title: ocm-pubsub
 name: ocm-pubsub
 url: /docs/cli-reference/help/ocm-pubsub/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -15,8 +14,8 @@ sidebar:
 An OCM repository can be configured to propagate change events via a 
 publish/subscribe system, if there is a persistence provider for the dedicated
 repository type. If available any known publish/subscribe system can
-be configured with [ocm set pubsub](/docs/cli-reference/set/pubsub) and shown with
-[ocm get pubsub](/docs/cli-reference/get/pubsub). Hereby, the pub/sub system 
+be configured with [ocm set pubsub](/docs/cli-reference/set/set_pubsub/) and shown with
+[ocm get pubsub](/docs/cli-reference/get/pubsub/). Hereby, the pub/sub system 
 is described by a typed specification.
 
 
diff --git a/content/docs/cli-reference/help/ocm-references.md b/content/docs/cli-reference/help/ocm-references.md
index da399957..a1025483 100644
--- a/content/docs/cli-reference/help/ocm-references.md
+++ b/content/docs/cli-reference/help/ocm-references.md
@@ -2,7 +2,6 @@
 title: ocm-references
 name: ocm-references
 url: /docs/cli-reference/help/ocm-references/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
diff --git a/content/docs/cli-reference/help/ocm-uploadhandlers.md b/content/docs/cli-reference/help/ocm-uploadhandlers.md
index 52469fe4..bfaa0680 100644
--- a/content/docs/cli-reference/help/ocm-uploadhandlers.md
+++ b/content/docs/cli-reference/help/ocm-uploadhandlers.md
@@ -2,7 +2,6 @@
 title: ocm-uploadhandlers
 name: ocm-uploadhandlers
 url: /docs/cli-reference/help/ocm-uploadhandlers/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -38,7 +37,7 @@ New handlers can be provided by plugins. In general available handlers,
 plugin-based or as part of the CLI coding are nameable using an hierarchical
 namespace. Those names can be used by a --uploader option
 to register handlers for various conditions for CLI commands like
-[ocm transfer componentversions](/docs/cli-reference/transfer/componentversions) or [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive).
+[ocm transfer componentversions](/docs/cli-reference/transfer/componentversions/) or [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive/).
 
 Besides the activation constraints (resource type and media type of the
 resource blob), it is possible to pass a target configuration controlling the
@@ -93,7 +92,7 @@ The following handler names are possible:
 
 
 
-See [ocm ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) for further details on using
+See [ocm ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) for further details on using
 upload handlers.
 
 
diff --git a/content/docs/cli-reference/help/toi-bootstrapping.md b/content/docs/cli-reference/help/toi-bootstrapping.md
index 3d14799f..5614d1c3 100644
--- a/content/docs/cli-reference/help/toi-bootstrapping.md
+++ b/content/docs/cli-reference/help/toi-bootstrapping.md
@@ -2,7 +2,6 @@
 title: toi-bootstrapping
 name: toi-bootstrapping
 url: /docs/cli-reference/help/toi-bootstrapping/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -17,11 +16,11 @@ a possibility to run images taken from a component version with user
 configuration and feed them with the content of this component version.
 It is some basic mechanism, which can be used to execute simple installation
 steps based on content described by the Open Component Model
-(see [ocm bootstrap package](/docs/cli-reference/bootstrap/package)).
+(see [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package/)).
 
 Therefore, a dedicated resource type toiPackage is defined,
 which describes an installation package to be handled by TOI.
-When calling the [ocm bootstrap package](/docs/cli-reference/bootstrap/package) command it is selected by a resource
+When calling the [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package/) command it is selected by a resource
 identity pattern. The first resource in given component version matching the
 pattern is used. A possible use case could be to provide different packages for
 different environments. The resource can use an identity attribute
@@ -110,7 +109,7 @@ It has the following format:
   - **configFile**: an example template for a parameter file
   - **credentialsFile**: an example template for a credentials file
 
-  Those templates can be downloaded with [ocm bootstrap configuration](/docs/cli-reference/bootstrap/configuration).
+  Those templates can be downloaded with [ocm bootstrap configuration](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration/).
 
 #### *ExecutorSpecification*
 
@@ -359,7 +358,7 @@ It uses the following fields:
   in the OCM support library, if used by the executor. At least the field
   type and one additional field must be set.
 
-Credentials are provided in an ocm config file (see [ocm configfile](/docs/cli-reference/configfile)).
+Credentials are provided in an ocm config file (see [ocm configfile](/docs/cli-reference/help/configfile/)).
 It uses a memory credential repository with the name default
 to store the credentials under the given name. Additionally appropriate
 consumer ids will be propagated, if requested in the credentials request config.
diff --git a/content/docs/cli-reference/list/_index.md b/content/docs/cli-reference/list/_index.md
index cab31889..76f07d48 100644
--- a/content/docs/cli-reference/list/_index.md
+++ b/content/docs/cli-reference/list/_index.md
@@ -2,7 +2,6 @@
 title: list
 name: list
 url: /docs/cli-reference/list/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,5 +26,5 @@ ocm list []  ...
 
 ##### Sub Commands
 
-* [ocm list componentversions](/docs/cli-reference/list/componentversions)	 — list component version names
+* [ocm list componentversions](/docs/cli-reference/list/componentversions/)	 — list component version names
 
diff --git a/content/docs/cli-reference/list/list_componentversions.md b/content/docs/cli-reference/list/list_componentversions.md
index 2d8a39c5..3556096d 100644
--- a/content/docs/cli-reference/list/list_componentversions.md
+++ b/content/docs/cli-reference/list/list_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: list componentversions
 url: /docs/cli-reference/list/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -124,5 +123,5 @@ $ ocm list componentversion --repo OCIRegistry::ghcr.io mandelsoft/kubelink
 
 ### See Also
 
-* [ocm list](/docs/cli-reference/list)	 — List information about components
+* [ocm list](/docs/cli-reference/list/)	 — List information about components
 
diff --git a/content/docs/cli-reference/set/_index.md b/content/docs/cli-reference/set/_index.md
index ff940c87..6cad4a0b 100644
--- a/content/docs/cli-reference/set/_index.md
+++ b/content/docs/cli-reference/set/_index.md
@@ -2,7 +2,6 @@
 title: set
 name: set
 url: /docs/cli-reference/set/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,5 +26,5 @@ ocm set []  ...
 
 ##### Sub Commands
 
-* [ocm set pubsub](/docs/cli-reference/set/pubsub)	 — Set the pubsub spec for an ocm repository
+* [ocm set pubsub](/docs/cli-reference/set/set_pubsub/)	 — Set the pubsub spec for an ocm repository
 
diff --git a/content/docs/cli-reference/set/set_pubsub.md b/content/docs/cli-reference/set/set_pubsub.md
index ff8d7cdf..0f429403 100644
--- a/content/docs/cli-reference/set/set_pubsub.md
+++ b/content/docs/cli-reference/set/set_pubsub.md
@@ -2,7 +2,6 @@
 title: pubsub
 name: set pubsub
 url: /docs/cli-reference/set/pubsub/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -32,12 +31,12 @@ to set the pub/sub specification for a repository.
 If no specification is given an existing specification
 will be removed for the given repository.
 The specification
-can be queried with the [ocm get pubsub](/docs/cli-reference/get/pubsub).
+can be queried with the [ocm get pubsub](/docs/cli-reference/get/pubsub/).
 Types and specification formats are shown for the topic
-[ocm ocm-pubsub](/docs/cli-reference/ocm-pubsub).
+[ocm ocm-pubsub](/docs/cli-reference/help/ocm-pubsub/).
 
 
 ### See Also
 
-* [ocm set](/docs/cli-reference/set)	 — Set information about OCM repositories
+* [ocm set](/docs/cli-reference/set/)	 — Set information about OCM repositories
 
diff --git a/content/docs/cli-reference/show/_index.md b/content/docs/cli-reference/show/_index.md
index ea81e936..27ae87fa 100644
--- a/content/docs/cli-reference/show/_index.md
+++ b/content/docs/cli-reference/show/_index.md
@@ -2,7 +2,6 @@
 title: show
 name: show
 url: /docs/cli-reference/show/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,6 +26,6 @@ ocm show []  ...
 
 ##### Sub Commands
 
-* [ocm show tags](/docs/cli-reference/show/tags)	 — show dedicated tags of OCI artifacts
-* [ocm show versions](/docs/cli-reference/show/versions)	 — show dedicated versions (semver compliant)
+* [ocm show tags](/docs/cli-reference/show/tags/)	 — show dedicated tags of OCI artifacts
+* [ocm show versions](/docs/cli-reference/show/versions/)	 — show dedicated versions (semver compliant)
 
diff --git a/content/docs/cli-reference/show/show_tags.md b/content/docs/cli-reference/show/show_tags.md
index 99722e9b..d957d2b8 100644
--- a/content/docs/cli-reference/show/show_tags.md
+++ b/content/docs/cli-reference/show/show_tags.md
@@ -2,7 +2,6 @@
 title: tags
 name: show tags
 url: /docs/cli-reference/show/tags/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -75,5 +74,5 @@ $ oci show tags ghcr.io/mandelsoft/kubelink
 
 ### See Also
 
-* [ocm show](/docs/cli-reference/show)	 — Show tags or versions
+* [ocm show](/docs/cli-reference/show/)	 — Show tags or versions
 
diff --git a/content/docs/cli-reference/show/show_versions.md b/content/docs/cli-reference/show/show_versions.md
index bc283ddb..7260e85c 100644
--- a/content/docs/cli-reference/show/show_versions.md
+++ b/content/docs/cli-reference/show/show_versions.md
@@ -2,7 +2,6 @@
 title: versions
 name: show versions
 url: /docs/cli-reference/show/versions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -83,5 +82,5 @@ $ ocm show versions ghcr.io/mandelsoft/cnudie//github.com/mandelsoft/playground
 
 ### See Also
 
-* [ocm show](/docs/cli-reference/show)	 — Show tags or versions
+* [ocm show](/docs/cli-reference/show/)	 — Show tags or versions
 
diff --git a/content/docs/cli-reference/sign/_index.md b/content/docs/cli-reference/sign/_index.md
index f13fe7f9..8052e2ab 100644
--- a/content/docs/cli-reference/sign/_index.md
+++ b/content/docs/cli-reference/sign/_index.md
@@ -2,7 +2,6 @@
 title: sign
 name: sign
 url: /docs/cli-reference/sign/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,6 +26,6 @@ ocm sign []  ...
 
 ##### Sub Commands
 
-* [ocm sign componentversions](/docs/cli-reference/sign/componentversions)	 — Sign component version
-* [ocm sign hash](/docs/cli-reference/sign/hash)	 — sign hash
+* [ocm sign componentversions](/docs/cli-reference/sign/componentversions/)	 — Sign component version
+* [ocm sign hash](/docs/cli-reference/sign/hash/)	 — sign hash
 
diff --git a/content/docs/cli-reference/sign/sign_componentversions.md b/content/docs/cli-reference/sign/sign_componentversions.md
index 79fa93cf..da484bdd 100644
--- a/content/docs/cli-reference/sign/sign_componentversions.md
+++ b/content/docs/cli-reference/sign/sign_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: sign componentversions
 url: /docs/cli-reference/sign/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -146,5 +145,5 @@ $ ocm sign componentversion --signature mandelsoft --private-key=mandelsoft.key
 
 ### See Also
 
-* [ocm sign](/docs/cli-reference/sign)	 — Sign components or hashes
+* [ocm sign](/docs/cli-reference/sign/)	 — Sign components or hashes
 
diff --git a/content/docs/cli-reference/sign/sign_hash.md b/content/docs/cli-reference/sign/sign_hash.md
index 3def637a..0f38f60f 100644
--- a/content/docs/cli-reference/sign/sign_hash.md
+++ b/content/docs/cli-reference/sign/sign_hash.md
@@ -2,7 +2,6 @@
 title: hash
 name: sign hash
 url: /docs/cli-reference/sign/hash/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -41,5 +40,5 @@ $ ocm sign hash key.priv SHA-256:810ff2fb242a5dee4220f2cb0e6a519891fb67f2f828a6c
 
 ### See Also
 
-* [ocm sign](/docs/cli-reference/sign)	 — Sign components or hashes
+* [ocm sign](/docs/cli-reference/sign/)	 — Sign components or hashes
 
diff --git a/content/docs/cli-reference/transfer/_index.md b/content/docs/cli-reference/transfer/_index.md
index 5b605d6f..c906b659 100644
--- a/content/docs/cli-reference/transfer/_index.md
+++ b/content/docs/cli-reference/transfer/_index.md
@@ -2,7 +2,6 @@
 title: transfer
 name: transfer
 url: /docs/cli-reference/transfer/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,8 +26,8 @@ ocm transfer []  ...
 
 ##### Sub Commands
 
-* [ocm transfer artifacts](/docs/cli-reference/transfer/artifacts)	 — transfer OCI artifacts
-* [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive)	 — transfer transport archive
-* [ocm transfer componentarchive](/docs/cli-reference/transfer/componentarchive)	 — transfer component archive to some component repository
-* [ocm transfer componentversions](/docs/cli-reference/transfer/componentversions)	 — transfer component version
+* [ocm transfer artifacts](/docs/cli-reference/transfer/artifacts/)	 — transfer OCI artifacts
+* [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive/)	 — transfer transport archive
+* [ocm transfer componentarchive](/docs/cli-reference/transfer/componentarchive/)	 — transfer component archive to some component repository
+* [ocm transfer componentversions](/docs/cli-reference/transfer/componentversions/)	 — transfer component version
 
diff --git a/content/docs/cli-reference/transfer/transfer_artifacts.md b/content/docs/cli-reference/transfer/transfer_artifacts.md
index 3a6b3468..57aebca9 100644
--- a/content/docs/cli-reference/transfer/transfer_artifacts.md
+++ b/content/docs/cli-reference/transfer/transfer_artifacts.md
@@ -2,7 +2,6 @@
 title: artifacts
 name: transfer artifacts
 url: /docs/cli-reference/transfer/artifacts/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -91,5 +90,5 @@ $ ocm oci artifact transfer /tmp/ctf gcr.io/my-project
 
 ### See Also
 
-* [ocm transfer](/docs/cli-reference/transfer)	 — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/)	 — Transfer artifacts or components
 
diff --git a/content/docs/cli-reference/transfer/transfer_commontransportarchive.md b/content/docs/cli-reference/transfer/transfer_commontransportarchive.md
index f866a823..efb04765 100644
--- a/content/docs/cli-reference/transfer/transfer_commontransportarchive.md
+++ b/content/docs/cli-reference/transfer/transfer_commontransportarchive.md
@@ -2,7 +2,6 @@
 title: commontransportarchive
 name: transfer commontransportarchive
 url: /docs/cli-reference/transfer/commontransportarchive/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -162,7 +161,7 @@ The uploader name may be a path expression with the following possibilities:
 
 
 
-See [ocm ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) for further details on using
+See [ocm ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) for further details on using
 upload handlers.
 
 
@@ -196,5 +195,5 @@ $ ocm transfer ctf ctf.tgz ghcr.io/mandelsoft/components
 
 ### See Also
 
-* [ocm transfer](/docs/cli-reference/transfer)	 — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/)	 — Transfer artifacts or components
 
diff --git a/content/docs/cli-reference/transfer/transfer_componentarchive.md b/content/docs/cli-reference/transfer/transfer_componentarchive.md
index 701ba0fa..a08cd844 100644
--- a/content/docs/cli-reference/transfer/transfer_componentarchive.md
+++ b/content/docs/cli-reference/transfer/transfer_componentarchive.md
@@ -2,7 +2,6 @@
 title: componentarchive
 name: transfer componentarchive
 url: /docs/cli-reference/transfer/componentarchive/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -94,5 +93,5 @@ with the script option family.
 
 ### See Also
 
-* [ocm transfer](/docs/cli-reference/transfer)	 — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/)	 — Transfer artifacts or components
 
diff --git a/content/docs/cli-reference/transfer/transfer_componentversions.md b/content/docs/cli-reference/transfer/transfer_componentversions.md
index 8afbddf4..e2367f52 100644
--- a/content/docs/cli-reference/transfer/transfer_componentversions.md
+++ b/content/docs/cli-reference/transfer/transfer_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: transfer componentversions
 url: /docs/cli-reference/transfer/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -219,7 +218,7 @@ The uploader name may be a path expression with the following possibilities:
 
 
 
-See [ocm ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) for further details on using
+See [ocm ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) for further details on using
 upload handlers.
 
 
@@ -254,5 +253,5 @@ $ ocm transfer components -t tgz --repo OCIRegistry::ghcr.io mandelsoft/kubelink
 
 ### See Also
 
-* [ocm transfer](/docs/cli-reference/transfer)	 — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/)	 — Transfer artifacts or components
 
diff --git a/content/docs/cli-reference/verify/_index.md b/content/docs/cli-reference/verify/_index.md
index 79010377..7a5d89f6 100644
--- a/content/docs/cli-reference/verify/_index.md
+++ b/content/docs/cli-reference/verify/_index.md
@@ -2,7 +2,6 @@
 title: verify
 name: verify
 url: /docs/cli-reference/verify/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,5 +26,5 @@ ocm verify []  ...
 
 ##### Sub Commands
 
-* [ocm verify componentversions](/docs/cli-reference/verify/componentversions)	 — Verify signature of component version
+* [ocm verify componentversions](/docs/cli-reference/verify/componentversions/)	 — Verify signature of component version
 
diff --git a/content/docs/cli-reference/verify/verify_componentversions.md b/content/docs/cli-reference/verify/verify_componentversions.md
index 803be373..1e6c5168 100644
--- a/content/docs/cli-reference/verify/verify_componentversions.md
+++ b/content/docs/cli-reference/verify/verify_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: verify componentversions
 url: /docs/cli-reference/verify/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -121,5 +120,5 @@ $ ocm verify componentversion --signature mandelsoft --public-key=mandelsoft.key
 
 ### See Also
 
-* [ocm verify](/docs/cli-reference/verify)	 — Verify component version signatures
+* [ocm verify](/docs/cli-reference/verify/)	 — Verify component version signatures
 
diff --git a/hugo_stats.json b/hugo_stats.json
index 57e75cc1..12b6879a 100644
--- a/hugo_stats.json
+++ b/hugo_stats.json
@@ -13,6 +13,7 @@
       "center",
       "circle",
       "code",
+      "component",
       "component-name",
       "component-version",
       "details",
@@ -67,7 +68,8 @@
       "time",
       "title",
       "tr",
-      "ul"
+      "ul",
+      "version"
     ],
     "classes": [
       "DocSearch-Label",
@@ -75,7 +77,6 @@
       "admonition",
       "anchor",
       "bg-dots",
-      "blog-header",
       "btn",
       "btn-close",
       "btn-link",
@@ -227,7 +228,6 @@
       "pb-2",
       "pb-3",
       "pe-4",
-      "privacy",
       "ps-3",
       "pt-4",
       "px-0",

From f779f7dab0709af9d794596ca8453203dea51200 Mon Sep 17 00:00:00 2001
From: Hilmar Falkenberg 
Date: Tue, 27 Aug 2024 16:26:39 +0200
Subject: [PATCH 31/37] fix links

---
 hack/generate-cli-docs/generate_root_index.go | 4 ++--
 hack/generate-cli-docs/map.go                 | 6 +++---
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/hack/generate-cli-docs/generate_root_index.go b/hack/generate-cli-docs/generate_root_index.go
index 872d7b6f..5d5956ad 100644
--- a/hack/generate-cli-docs/generate_root_index.go
+++ b/hack/generate-cli-docs/generate_root_index.go
@@ -34,10 +34,10 @@ func genIndexForRootHelpTopics(dir string, urlBase string) (err error) {
 	}()
 
 	f.WriteString(fmt.Sprintf(fmTmpl, "help", "help", urlBase+"help"))
-	f.WriteString("### Additional Topics\n")
+	f.WriteString("### Additional Topics\n\n")
 
 	for _, topic := range topics {
-		f.WriteString(fmt.Sprintf("* [%s](%s)\t — %s\n", topic, urlBase+topic, topic))
+		f.WriteString(fmt.Sprintf("* [%s](%shelp/%s/) — %s\n", topic, urlBase, topic, topic))
 	}
 
 	return nil
diff --git a/hack/generate-cli-docs/map.go b/hack/generate-cli-docs/map.go
index 298bc653..cdfd4729 100644
--- a/hack/generate-cli-docs/map.go
+++ b/hack/generate-cli-docs/map.go
@@ -10,8 +10,8 @@ var cmdToLink = map[string]string{
 	"ocm add sources":                     "/docs/cli-reference/add/sources/",
 	"ocm add":                             "/docs/cli-reference/add/",
 	"ocm attributes":                      "/docs/cli-reference/help/attributes/",
-	"ocm bootstrap configuration":         "https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration/",
-	"ocm bootstrap package":               "https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package/",
+	"ocm bootstrap configuration":         "https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration.md",
+	"ocm bootstrap package":               "https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package.md",
 	"ocm check componentversions":         "/docs/cli-reference/check/componentversions/",
 	"ocm check":                           "/docs/cli-reference/check/",
 	"ocm clean cache":                     "/docs/cli-reference/clean/cache/",
@@ -50,7 +50,7 @@ var cmdToLink = map[string]string{
 	"ocm ocm-labels":                      "/docs/cli-reference/help/ocm-labels/",
 	"ocm ocm-pubsub":                      "/docs/cli-reference/help/ocm-pubsub/",
 	"ocm ocm-uploadhandlers":              "/docs/cli-reference/help/ocm-uploadhandlers/",
-	"ocm set pubsub":                      "/docs/cli-reference/set/set_pubsub/",
+	"ocm set pubsub":                      "/docs/cli-reference/set/pubsub/",
 	"ocm set":                             "/docs/cli-reference/set/",
 	"ocm show tags":                       "/docs/cli-reference/show/tags/",
 	"ocm show versions":                   "/docs/cli-reference/show/versions/",

From 10927c7eb94ea9ee965a6828f5b2ced55488c188 Mon Sep 17 00:00:00 2001
From: Hilmar Falkenberg 
Date: Tue, 27 Aug 2024 16:27:27 +0200
Subject: [PATCH 32/37] re-generate

---
 content/docs/cli-reference/get/get_pubsub.md  |  2 +-
 content/docs/cli-reference/help/_index.md     | 29 ++++++++++---------
 .../describe_package_toi-bootstrapping.md     |  6 ++--
 content/docs/cli-reference/help/ocm-pubsub.md |  2 +-
 .../cli-reference/help/toi-bootstrapping.md   |  6 ++--
 content/docs/cli-reference/set/_index.md      |  2 +-
 6 files changed, 24 insertions(+), 23 deletions(-)

diff --git a/content/docs/cli-reference/get/get_pubsub.md b/content/docs/cli-reference/get/get_pubsub.md
index 7d573a4a..dbcf1793 100644
--- a/content/docs/cli-reference/get/get_pubsub.md
+++ b/content/docs/cli-reference/get/get_pubsub.md
@@ -29,7 +29,7 @@ A repository may be able to store a publish/subscribe specification
 to propagate the creation or update of component versions.
 If such an implementation is available and a specification is
 assigned to the repository, it is shown. The specification
-can be set with the [ocm set pubsub](/docs/cli-reference/set/set_pubsub/).
+can be set with the [ocm set pubsub](/docs/cli-reference/set/pubsub/).
 
 
 With the option --output the output mode can be selected.
diff --git a/content/docs/cli-reference/help/_index.md b/content/docs/cli-reference/help/_index.md
index 3fe03571..19772ad7 100644
--- a/content/docs/cli-reference/help/_index.md
+++ b/content/docs/cli-reference/help/_index.md
@@ -9,17 +9,18 @@ sidebar:
   collapsed: true
 ---
 ### Additional Topics
-* [add_componentversions_ocm-labels](/docs/cli-reference/add_componentversions_ocm-labels)	 — add_componentversions_ocm-labels
-* [attributes](/docs/cli-reference/attributes)	 — attributes
-* [configfile](/docs/cli-reference/configfile)	 — configfile
-* [credential-handling](/docs/cli-reference/credential-handling)	 — credential-handling
-* [describe_package_toi-bootstrapping](/docs/cli-reference/describe_package_toi-bootstrapping)	 — describe_package_toi-bootstrapping
-* [logging](/docs/cli-reference/logging)	 — logging
-* [oci-references](/docs/cli-reference/oci-references)	 — oci-references
-* [ocm-accessmethods](/docs/cli-reference/ocm-accessmethods)	 — ocm-accessmethods
-* [ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers)	 — ocm-downloadhandlers
-* [ocm-labels](/docs/cli-reference/ocm-labels)	 — ocm-labels
-* [ocm-pubsub](/docs/cli-reference/ocm-pubsub)	 — ocm-pubsub
-* [ocm-references](/docs/cli-reference/ocm-references)	 — ocm-references
-* [ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers)	 — ocm-uploadhandlers
-* [toi-bootstrapping](/docs/cli-reference/toi-bootstrapping)	 — toi-bootstrapping
+
+* [add_componentversions_ocm-labels](/docs/cli-reference/help/add_componentversions_ocm-labels/) — add_componentversions_ocm-labels
+* [attributes](/docs/cli-reference/help/attributes/) — attributes
+* [configfile](/docs/cli-reference/help/configfile/) — configfile
+* [credential-handling](/docs/cli-reference/help/credential-handling/) — credential-handling
+* [describe_package_toi-bootstrapping](/docs/cli-reference/help/describe_package_toi-bootstrapping/) — describe_package_toi-bootstrapping
+* [logging](/docs/cli-reference/help/logging/) — logging
+* [oci-references](/docs/cli-reference/help/oci-references/) — oci-references
+* [ocm-accessmethods](/docs/cli-reference/help/ocm-accessmethods/) — ocm-accessmethods
+* [ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/) — ocm-downloadhandlers
+* [ocm-labels](/docs/cli-reference/help/ocm-labels/) — ocm-labels
+* [ocm-pubsub](/docs/cli-reference/help/ocm-pubsub/) — ocm-pubsub
+* [ocm-references](/docs/cli-reference/help/ocm-references/) — ocm-references
+* [ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) — ocm-uploadhandlers
+* [toi-bootstrapping](/docs/cli-reference/help/toi-bootstrapping/) — toi-bootstrapping
diff --git a/content/docs/cli-reference/help/describe_package_toi-bootstrapping.md b/content/docs/cli-reference/help/describe_package_toi-bootstrapping.md
index 9039ede5..e2fd30a9 100644
--- a/content/docs/cli-reference/help/describe_package_toi-bootstrapping.md
+++ b/content/docs/cli-reference/help/describe_package_toi-bootstrapping.md
@@ -16,11 +16,11 @@ a possibility to run images taken from a component version with user
 configuration and feed them with the content of this component version.
 It is some basic mechanism, which can be used to execute simple installation
 steps based on content described by the Open Component Model
-(see [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package/)).
+(see [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package.md)).
 
 Therefore, a dedicated resource type toiPackage is defined,
 which describes an installation package to be handled by TOI.
-When calling the [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package/) command it is selected by a resource
+When calling the [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package.md) command it is selected by a resource
 identity pattern. The first resource in given component version matching the
 pattern is used. A possible use case could be to provide different packages for
 different environments. The resource can use an identity attribute
@@ -109,7 +109,7 @@ It has the following format:
   - **configFile**: an example template for a parameter file
   - **credentialsFile**: an example template for a credentials file
 
-  Those templates can be downloaded with [ocm bootstrap configuration](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration/).
+  Those templates can be downloaded with [ocm bootstrap configuration](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration.md).
 
 #### *ExecutorSpecification*
 
diff --git a/content/docs/cli-reference/help/ocm-pubsub.md b/content/docs/cli-reference/help/ocm-pubsub.md
index 068bbd1e..39625bdb 100644
--- a/content/docs/cli-reference/help/ocm-pubsub.md
+++ b/content/docs/cli-reference/help/ocm-pubsub.md
@@ -14,7 +14,7 @@ sidebar:
 An OCM repository can be configured to propagate change events via a 
 publish/subscribe system, if there is a persistence provider for the dedicated
 repository type. If available any known publish/subscribe system can
-be configured with [ocm set pubsub](/docs/cli-reference/set/set_pubsub/) and shown with
+be configured with [ocm set pubsub](/docs/cli-reference/set/pubsub/) and shown with
 [ocm get pubsub](/docs/cli-reference/get/pubsub/). Hereby, the pub/sub system 
 is described by a typed specification.
 
diff --git a/content/docs/cli-reference/help/toi-bootstrapping.md b/content/docs/cli-reference/help/toi-bootstrapping.md
index 5614d1c3..22fee071 100644
--- a/content/docs/cli-reference/help/toi-bootstrapping.md
+++ b/content/docs/cli-reference/help/toi-bootstrapping.md
@@ -16,11 +16,11 @@ a possibility to run images taken from a component version with user
 configuration and feed them with the content of this component version.
 It is some basic mechanism, which can be used to execute simple installation
 steps based on content described by the Open Component Model
-(see [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package/)).
+(see [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package.md)).
 
 Therefore, a dedicated resource type toiPackage is defined,
 which describes an installation package to be handled by TOI.
-When calling the [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package/) command it is selected by a resource
+When calling the [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package.md) command it is selected by a resource
 identity pattern. The first resource in given component version matching the
 pattern is used. A possible use case could be to provide different packages for
 different environments. The resource can use an identity attribute
@@ -109,7 +109,7 @@ It has the following format:
   - **configFile**: an example template for a parameter file
   - **credentialsFile**: an example template for a credentials file
 
-  Those templates can be downloaded with [ocm bootstrap configuration](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration/).
+  Those templates can be downloaded with [ocm bootstrap configuration](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration.md).
 
 #### *ExecutorSpecification*
 
diff --git a/content/docs/cli-reference/set/_index.md b/content/docs/cli-reference/set/_index.md
index 6cad4a0b..baf49e71 100644
--- a/content/docs/cli-reference/set/_index.md
+++ b/content/docs/cli-reference/set/_index.md
@@ -26,5 +26,5 @@ ocm set []  ...
 
 ##### Sub Commands
 
-* [ocm set pubsub](/docs/cli-reference/set/set_pubsub/)	 — Set the pubsub spec for an ocm repository
+* [ocm set pubsub](/docs/cli-reference/set/pubsub/)	 — Set the pubsub spec for an ocm repository
 

From 02c450f10741c60a6e693f6a70ecab591880b326 Mon Sep 17 00:00:00 2001
From: Hilmar Falkenberg 
Date: Tue, 27 Aug 2024 16:39:10 +0200
Subject: [PATCH 33/37] shitty hugo - is not able to translate links correctly

---
 content/mpas/getting_started.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/content/mpas/getting_started.md b/content/mpas/getting_started.md
index 954e47c0..fa309ce8 100644
--- a/content/mpas/getting_started.md
+++ b/content/mpas/getting_started.md
@@ -34,7 +34,7 @@ To install the MPAS CLI using `brew`:
 brew install open-component-model/tap/mpas
 ```
 
-For other installation methods, see the [installation guide](installation.md).
+For other installation methods, see the [installation guide](/mpas/installation/).
 
 ## Bootstrap MPAS
 

From 9e84b9210a33926000ffd09b407907d5f0718064 Mon Sep 17 00:00:00 2001
From: Hilmar Falkenberg 
Date: Wed, 28 Aug 2024 12:57:46 +0200
Subject: [PATCH 34/37] md lint

---
 content/docs/overview/project.md | 6 +-----
 1 file changed, 1 insertion(+), 5 deletions(-)

diff --git a/content/docs/overview/project.md b/content/docs/overview/project.md
index 27d6d35e..252ba04f 100644
--- a/content/docs/overview/project.md
+++ b/content/docs/overview/project.md
@@ -3,8 +3,6 @@ title : "About the OCM Project"
 description: "About the Open Component Model Project"
 url: /docs/overview/about
 lead: ""
-date: 2020-10-06T08:48:23+00:00
-lastmod: 2020-10-06T08:48:23+00:00
 draft: false
 weight: 11
 toc: true
@@ -13,7 +11,7 @@ images: []
 
 The Open Component Model (OCM) project provides an open standard for describing software artifacts and lifecycle metadata, with the purpose to securely deliver and deploy software products. It facilitates asynchronous handling of various lifecycle management processes, such as compliance checks, security scans, deployments, and more, in a decoupled and streamlined manner. OCM provides the ability to deliver software securely, consistently, and compliantly across cloud, on-prem, hybrid and air-gapped environments.
 
-![](./ocm-uses-cases.png)
+![OCM use cases](./ocm-uses-cases.png)
 
 Below are the main projects, but please also check out the others in our [Github org](https://github.com/open-component-model).
 
@@ -22,5 +20,3 @@ Below are the main projects, but please also check out the others in our [Github
 - [OCM CLI](https://github.com/open-component-model/ocm#ocm-cli) - With the `ocm` command line interface end users can interact with OCM elements, helping them create component versions and embed them in CI and CD processes. Examples can be found in [this Makefile](https://github.com/open-component-model/ocm/blob/main/examples/make/Makefile).
 - [OCM Controller](https://github.com/open-component-model/ocm-controller) - The `ocm-controllers` are designed to enable the automated deployment of software using the [Open Component Model](https://ocm.software) and Flux.
 - [OCM Website](https://github.com/open-component-model/ocm-website) - The `ocm-website` you are currently visiting. It is built using Hugo and hosted on Github Pages.
-
-

From 96c247364aaafd47c52f47bbff659f5fa5530364 Mon Sep 17 00:00:00 2001
From: Gerald Morrison <67469729+morri-son@users.noreply.github.com>
Date: Tue, 3 Sep 2024 11:41:50 +0200
Subject: [PATCH 35/37] Update publish-site.yaml

---
 .github/workflows/publish-site.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/publish-site.yaml b/.github/workflows/publish-site.yaml
index 72b97200..4821999f 100644
--- a/.github/workflows/publish-site.yaml
+++ b/.github/workflows/publish-site.yaml
@@ -44,11 +44,11 @@ jobs:
         with:
           python-version: '3.11'
 
-      - run: |
+      - name: Generate Schema
+        run: |
           python3 -m pip install json-schema-for-humans
           generate-schema-doc --config-file generate-schema.yaml static/schemas/component-descriptor-v2 schema-v2.html
           generate-schema-doc --config-file generate-schema.yaml static/schemas/component-descriptor-v3alpha1 schema-v3alpha1.html
-        name: Generate Schema
 
       - name: Copy Schema
         run: |

From f4cab2e52c873d5ddf0fd02060e91b6a61bce7eb Mon Sep 17 00:00:00 2001
From: Hilmar Falkenberg 
Date: Fri, 13 Sep 2024 17:26:03 +0200
Subject: [PATCH 36/37] typo

---
 config/_default/params.toml | 266 ++++++++++++++++++------------------
 1 file changed, 133 insertions(+), 133 deletions(-)

diff --git a/config/_default/params.toml b/config/_default/params.toml
index b93dbd85..712b71df 100644
--- a/config/_default/params.toml
+++ b/config/_default/params.toml
@@ -1,134 +1,134 @@
-# Hugo
-title = "Open Component Model"
-description = ""
-leader = "An open standard to describe software artifact delivery."
-leader_open_source_text = "Open-Source Apache-2.0 licensed."
+# Hugo
+title = "Open Component Model"
+description = ""
+leader = "An open standard to describe software artifact delivery."
+leader_open_source_text = "Open-Source Apache-2.0 licensed."
 latest_version = "v0.14.0"
-images = ["logo-image.png"]
-
-# mainSections
-mainSections = ["docs"]
-
-# Doks (@hyas/doks-core)
-[doks]
-  # Color mode
-  # For now, all PNG text is White so switching to Light mode will make those texts disapper.
-  colorMode = "dark" # auto (default), light or dark
-  colorModeToggler = false # true (default) or false (this setting is only relevant when colorMode = auto)
-
-  # Navbar
-  navbarSticky = true # true (default) or false
-  containerBreakpoint = "fluid" # "", "sm", "md", "lg" (default), "xl", "xxl", or "fluid"
-
-  ## Button
-  navBarButton = false # false (default) or true
-  navBarButtonUrl = "/docs/overview/context"
-  navBarButtonText = "Get started"
-
-  # FlexSearch
-  flexSearch = true # true (default) or false
-  searchExclKinds = [] # list of page kinds to exclude from search indexing (e.g. ["home", "taxonomy", "term"] )
-  searchExclTypes = [] # list of content types to exclude from search indexing (e.g. ["blog", "docs", "legal", "contributors", "categories"])
-  showSearch = [] # [] (all pages, default) or homepage (optionally) and list of sections (e.g. ["homepage", "blog", "guides"])
-  indexSummary = false # true or false (default); whether to index only the `.Summary` instead of the full `.Content`; limits the respective JSON field size and thus increases loading time
-
-  ## Search results
-  showDate = false # false (default) or true
-  showSummary = true # true (default) or false
-  searchLimit = 99 # 0 (no limit, default) or natural number
-
-  # Global alert
-  alert = false # false (default) or true
-  alertDismissable = true # true (default) or false
-
-  # Bootstrap
-  bootstrapJavascript = false # false (default) or true
-
-  # Nav
-  sectionNav = ["docs"] # ["docs"] (default) or list of sections (e.g. ["docs", "guides"])
-  toTopButton = false # false (default) or true
-  breadcrumbTrail = false # false (default) or true
-  headlineHash = true # true (default) or false
-  scrollSpy = true # true (default) or false
-
-  # Multilingual
-  multilingualMode = false # false (default) or true
-  showMissingLanguages = true # whether or not to show untranslated languages in the language menu; true (default) or false
-
-  # Versioning
-  docsVersioning = false # false (default) or true
-  docsVersion = "1.0"
-
-  # UX
-  headerBar = true # true (default) or false
-  backgroundDots = true # true (default) or false
-
-  # Homepage
-  sectionFooter = false # false (default) or true
-
-  # Blog
-  relatedPosts = false # false (default) or true
-  imageList = true # true (default) or false
-  imageSingle = true # true (default) or false
-
-  # Repository
-  repoHost = "GitHub" # GitHub (default), Gitea, GitLab, Bitbucket, or BitbucketServer
-
-  # SCSS colors
-  # backGround = "yellowgreen"
-  ## Dark theme
-  # textDark = "#dee2e6" # "#dee2e6" (default), "#dee2e6" (orignal), or custom color
-  # accentDark = "#5d2f86" # "#5d2f86" (default), "#5d2f86" (original), or custom color
-  ## Light theme
-  # textLight = "#1d2d35" # "#1d2d35" (default), "#1d2d35" (orignal), or custom color
-  # accentLight = "#8ed6fb" # "#8ed6fb" (default), "#8ed6fb" (orignal), or custom color
-
-  # [doks.menu]
-  #   [doks.menu.section]
-  #     auto = true # true (default) or false
-  #     collapsibleSidebar = true # true (default) or false
-
-# Debug
-[render_hooks.image]
-  errorLevel = 'ignore' # ignore (default), warning, or error (fails the build)
-
-[render_hooks.link]
-  errorLevel = 'ignore' # ignore (default), warning, or error (fails the build)
-  highlightBroken = false # true or false (default)
-
-# Images (@hyas/images)
-[hyas_images]
-  [hyas_images.defaults]
-    decoding = "async" # sync, async, or auto (default)
-    fetchpriority = "auto" # high, low, or auto (default)
-    loading = "lazy" # eager or lazy (default)
-    widths = [480, 576, 768, 1025, 1200, 1440] # [640, 768, 1024, 1366, 1600, 1920] for example
-    sizes = "auto" # 100vw (default), 75vw, or auto for example
-    process = "" # "fill 1600x900" or "fill 2100x900" for example
-    lqip = "16x webp q20" # "16x webp q20" or "21x webp q20" for example
-
-# Inline SVG (@hyas/inline-svg)
-[inline_svg]
-  iconSetDir = "tabler-icons" # "tabler-icons" (default)
-
-# SEO (@hyas/seo)
-[seo]
-  [seo.title]
-    separator = " | "
-    suffix = ""
-  [seo.favicons]
-    sizes = []
-    icon = "favicon.png" # favicon.png (default)
-    svgIcon = "favicon.svg" # favicon.svg (default)
-    maskIcon = "mask-icon.svg" # mask-icon.svg (default)
-    maskIconColor = "white" # white (default)
-  [seo.schemas]
-    type = "Organization" # Organization (default) or Person
-    logo = "favicon-512x512.png" # Logo of Organization — favicon-512x512.png (default)
-    name = "Open Component Model" # Name of Organization or Person
-    sameAs = [] # E.g. ["https://github.com/gethyas/hyas", "https://fosstodon.org/@hyas"]
-    images = ["logo-image.png"] # ["cover.png"] (default)
-    article = [] # Article sections
-    newsArticle = [] # NewsArticle sections
-    blogPosting = ["blog"] # BlogPosting sections
-    product = [] # Product sections
+images = ["logo-image.png"]
+
+# mainSections
+mainSections = ["docs"]
+
+# Doks (@hyas/doks-core)
+[doks]
+  # Color mode
+  # For now, all PNG text is White so switching to Light mode will make those texts disappear.
+  colorMode = "dark" # auto (default), light or dark
+  colorModeToggler = false # true (default) or false (this setting is only relevant when colorMode = auto)
+
+  # Navbar
+  navbarSticky = true # true (default) or false
+  containerBreakpoint = "fluid" # "", "sm", "md", "lg" (default), "xl", "xxl", or "fluid"
+
+  ## Button
+  navBarButton = false # false (default) or true
+  navBarButtonUrl = "/docs/overview/context"
+  navBarButtonText = "Get started"
+
+  # FlexSearch
+  flexSearch = true # true (default) or false
+  searchExclKinds = [] # list of page kinds to exclude from search indexing (e.g. ["home", "taxonomy", "term"] )
+  searchExclTypes = [] # list of content types to exclude from search indexing (e.g. ["blog", "docs", "legal", "contributors", "categories"])
+  showSearch = [] # [] (all pages, default) or homepage (optionally) and list of sections (e.g. ["homepage", "blog", "guides"])
+  indexSummary = false # true or false (default); whether to index only the `.Summary` instead of the full `.Content`; limits the respective JSON field size and thus increases loading time
+
+  ## Search results
+  showDate = false # false (default) or true
+  showSummary = true # true (default) or false
+  searchLimit = 99 # 0 (no limit, default) or natural number
+
+  # Global alert
+  alert = false # false (default) or true
+  alertDismissable = true # true (default) or false
+
+  # Bootstrap
+  bootstrapJavascript = false # false (default) or true
+
+  # Nav
+  sectionNav = ["docs"] # ["docs"] (default) or list of sections (e.g. ["docs", "guides"])
+  toTopButton = false # false (default) or true
+  breadcrumbTrail = false # false (default) or true
+  headlineHash = true # true (default) or false
+  scrollSpy = true # true (default) or false
+
+  # Multilingual
+  multilingualMode = false # false (default) or true
+  showMissingLanguages = true # whether or not to show untranslated languages in the language menu; true (default) or false
+
+  # Versioning
+  docsVersioning = false # false (default) or true
+  docsVersion = "1.0"
+
+  # UX
+  headerBar = true # true (default) or false
+  backgroundDots = true # true (default) or false
+
+  # Homepage
+  sectionFooter = false # false (default) or true
+
+  # Blog
+  relatedPosts = false # false (default) or true
+  imageList = true # true (default) or false
+  imageSingle = true # true (default) or false
+
+  # Repository
+  repoHost = "GitHub" # GitHub (default), Gitea, GitLab, Bitbucket, or BitbucketServer
+
+  # SCSS colors
+  # backGround = "yellowgreen"
+  ## Dark theme
+  # textDark = "#dee2e6" # "#dee2e6" (default), "#dee2e6" (orignal), or custom color
+  # accentDark = "#5d2f86" # "#5d2f86" (default), "#5d2f86" (original), or custom color
+  ## Light theme
+  # textLight = "#1d2d35" # "#1d2d35" (default), "#1d2d35" (orignal), or custom color
+  # accentLight = "#8ed6fb" # "#8ed6fb" (default), "#8ed6fb" (orignal), or custom color
+
+  # [doks.menu]
+  #   [doks.menu.section]
+  #     auto = true # true (default) or false
+  #     collapsibleSidebar = true # true (default) or false
+
+# Debug
+[render_hooks.image]
+  errorLevel = 'ignore' # ignore (default), warning, or error (fails the build)
+
+[render_hooks.link]
+  errorLevel = 'ignore' # ignore (default), warning, or error (fails the build)
+  highlightBroken = false # true or false (default)
+
+# Images (@hyas/images)
+[hyas_images]
+  [hyas_images.defaults]
+    decoding = "async" # sync, async, or auto (default)
+    fetchpriority = "auto" # high, low, or auto (default)
+    loading = "lazy" # eager or lazy (default)
+    widths = [480, 576, 768, 1025, 1200, 1440] # [640, 768, 1024, 1366, 1600, 1920] for example
+    sizes = "auto" # 100vw (default), 75vw, or auto for example
+    process = "" # "fill 1600x900" or "fill 2100x900" for example
+    lqip = "16x webp q20" # "16x webp q20" or "21x webp q20" for example
+
+# Inline SVG (@hyas/inline-svg)
+[inline_svg]
+  iconSetDir = "tabler-icons" # "tabler-icons" (default)
+
+# SEO (@hyas/seo)
+[seo]
+  [seo.title]
+    separator = " | "
+    suffix = ""
+  [seo.favicons]
+    sizes = []
+    icon = "favicon.png" # favicon.png (default)
+    svgIcon = "favicon.svg" # favicon.svg (default)
+    maskIcon = "mask-icon.svg" # mask-icon.svg (default)
+    maskIconColor = "white" # white (default)
+  [seo.schemas]
+    type = "Organization" # Organization (default) or Person
+    logo = "favicon-512x512.png" # Logo of Organization — favicon-512x512.png (default)
+    name = "Open Component Model" # Name of Organization or Person
+    sameAs = [] # E.g. ["https://github.com/gethyas/hyas", "https://fosstodon.org/@hyas"]
+    images = ["logo-image.png"] # ["cover.png"] (default)
+    article = [] # Article sections
+    newsArticle = [] # NewsArticle sections
+    blogPosting = ["blog"] # BlogPosting sections
+    product = [] # Product sections

From 20bd79d6336280641ba5330b6364e74138fc9ce8 Mon Sep 17 00:00:00 2001
From: Hilmar Falkenberg 
Date: Mon, 16 Sep 2024 09:02:16 +0200
Subject: [PATCH 37/37] new generate

---
 content/docs/cli-reference/_index.md          | 35 +++++++++----------
 content/docs/cli-reference/add/_index.md      | 15 ++++----
 .../add/add_componentversions.md              |  9 +++--
 .../docs/cli-reference/add/add_references.md  |  3 +-
 .../add/add_resource-configuration.md         |  7 ++--
 .../docs/cli-reference/add/add_resources.md   |  5 ++-
 .../cli-reference/add/add_routingslips.md     |  3 +-
 .../add/add_source-configuration.md           |  7 ++--
 content/docs/cli-reference/add/add_sources.md |  5 ++-
 content/docs/cli-reference/check/_index.md    |  3 +-
 .../check/check_componentversions.md          |  3 +-
 content/docs/cli-reference/clean/_index.md    |  3 +-
 .../docs/cli-reference/clean/clean_cache.md   |  3 +-
 content/docs/cli-reference/create/_index.md   |  7 ++--
 .../create/create_componentarchive.md         |  3 +-
 .../cli-reference/create/create_rsakeypair.md |  3 +-
 .../create/create_transportarchive.md         |  3 +-
 content/docs/cli-reference/describe/_index.md |  9 +++--
 .../describe/describe_artifacts.md            |  3 +-
 .../cli-reference/describe/describe_cache.md  |  3 +-
 .../describe/describe_package.md              |  5 ++-
 .../describe/describe_plugins.md              |  3 +-
 content/docs/cli-reference/download/_index.md |  9 +++--
 .../download/download_artifacts.md            |  3 +-
 .../cli-reference/download/download_cli.md    |  3 +-
 .../download/download_componentversions.md    |  3 +-
 .../download/download_resources.md            |  5 ++-
 content/docs/cli-reference/get/_index.md      | 23 ++++++------
 .../docs/cli-reference/get/get_artifacts.md   |  3 +-
 .../get/get_componentversions.md              |  3 +-
 content/docs/cli-reference/get/get_config.md  |  3 +-
 .../docs/cli-reference/get/get_credentials.md |  3 +-
 content/docs/cli-reference/get/get_plugins.md |  3 +-
 content/docs/cli-reference/get/get_pubsub.md  |  5 ++-
 .../docs/cli-reference/get/get_references.md  |  3 +-
 .../docs/cli-reference/get/get_resources.md   |  3 +-
 .../cli-reference/get/get_routingslips.md     |  3 +-
 content/docs/cli-reference/get/get_sources.md |  3 +-
 .../docs/cli-reference/get/get_verified.md    |  3 +-
 content/docs/cli-reference/help/_index.md     | 26 +++++++-------
 content/docs/cli-reference/help/attributes.md |  5 ++-
 content/docs/cli-reference/help/configfile.md |  5 ++-
 .../cli-reference/help/credential-handling.md |  3 +-
 content/docs/cli-reference/help/logging.md    |  5 ++-
 .../docs/cli-reference/help/oci-references.md |  1 -
 .../cli-reference/help/ocm-accessmethods.md   |  3 +-
 .../help/ocm-downloadhandlers.md              |  7 ++--
 content/docs/cli-reference/help/ocm-labels.md |  1 -
 content/docs/cli-reference/help/ocm-pubsub.md |  5 ++-
 .../docs/cli-reference/help/ocm-references.md |  1 -
 .../cli-reference/help/ocm-uploadhandlers.md  |  5 ++-
 .../cli-reference/help/toi-bootstrapping.md   |  9 +++--
 content/docs/cli-reference/list/_index.md     |  3 +-
 .../list/list_componentversions.md            |  3 +-
 content/docs/cli-reference/set/_index.md      |  3 +-
 content/docs/cli-reference/set/set_pubsub.md  |  7 ++--
 content/docs/cli-reference/show/_index.md     |  5 ++-
 content/docs/cli-reference/show/show_tags.md  |  3 +-
 .../docs/cli-reference/show/show_versions.md  |  3 +-
 content/docs/cli-reference/sign/_index.md     |  5 ++-
 .../sign/sign_componentversions.md            |  3 +-
 content/docs/cli-reference/sign/sign_hash.md  |  3 +-
 content/docs/cli-reference/transfer/_index.md |  9 +++--
 .../transfer/transfer_artifacts.md            |  3 +-
 .../transfer_commontransportarchive.md        |  5 ++-
 .../transfer/transfer_componentarchive.md     |  3 +-
 .../transfer/transfer_componentversions.md    |  5 ++-
 content/docs/cli-reference/verify/_index.md   |  3 +-
 .../verify/verify_componentversions.md        |  3 +-
 69 files changed, 149 insertions(+), 217 deletions(-)

diff --git a/content/docs/cli-reference/_index.md b/content/docs/cli-reference/_index.md
index ceb9dbeb..96cd4a31 100644
--- a/content/docs/cli-reference/_index.md
+++ b/content/docs/cli-reference/_index.md
@@ -2,7 +2,6 @@
 title: cli-reference
 name: cli-reference
 url: /docs/cli-reference/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -47,7 +46,7 @@ It can be used in two ways:
 
 The command accepts some top level options, they can only be given before the sub commands.
 
-A configuration according to [ocm configfile](/docs/cli-reference/configfile) is read from a .ocmconfig file
+A configuration according to [ocm configfile](/docs/cli-reference/help/configfile/) is read from a .ocmconfig file
 located in the HOME directory. With the option --config other
 file locations can be specified. If nothing is specified and no file is found at the default
 location a default configuration is composed according to known type specific
@@ -98,7 +97,7 @@ form
 
 
 The --log* options can be used to configure the logging behaviour.
-For details see [ocm logging](/docs/cli-reference/logging).
+For details see [ocm logging](/docs/cli-reference/help/logging/).
 
 There is a quick config option --logkeys to configure simple
 tag/realm based condition rules. The comma-separated names build an AND rule.
@@ -110,7 +109,7 @@ realm is affected. For example /+ocm=trace will enable all log outp
 OCM library.
 
 A tag directly matches the logging tags. Used tags and realms can be found under
-topic [ocm logging](/docs/cli-reference/logging). The ocm coding basically uses the realm ocm.
+topic [ocm logging](/docs/cli-reference/help/logging/). The ocm coding basically uses the realm ocm.
 The default level to enable is info. Separated by an equal sign (=)
 optionally a dedicated level can be specified. Log levels can be (error,
 warn, info, debug and trace.
@@ -120,7 +119,7 @@ logging configuration (yaml/json) via command line. If the argument starts with
 an @, the logging configuration is taken from a file.
 
 The value can be a simple type or a JSON/YAML string for complex values
-(see [ocm attributes](/docs/cli-reference/attributes)). The following attributes are supported:
+(see [ocm attributes](/docs/cli-reference/help/attributes/)). The following attributes are supported:
 - github.com/mandelsoft/logforward [logfwd]: *logconfig* Logging config structure used for config forwarding
 
   This attribute is used to specify a logging configuration intended
@@ -365,19 +364,19 @@ by a certificate delivered with the signature.
 
 ##### Sub Commands
 
-* [ocm add](/docs/cli-reference/add)	 — Add elements to a component repository or component version
-* [ocm check](/docs/cli-reference/check)	 — check components in OCM repository
-* [ocm clean](/docs/cli-reference/clean)	 — Cleanup/re-organize elements
-* [ocm create](/docs/cli-reference/create)	 — Create transport or component archive
-* [ocm describe](/docs/cli-reference/describe)	 — Describe various elements by using appropriate sub commands.
-* [ocm download](/docs/cli-reference/download)	 — Download oci artifacts, resources or complete components
-* [ocm get](/docs/cli-reference/get)	 — Get information about artifacts and components
-* [ocm list](/docs/cli-reference/list)	 — List information about components
-* [ocm set](/docs/cli-reference/set)	 — Set information about OCM repositories
-* [ocm show](/docs/cli-reference/show)	 — Show tags or versions
-* [ocm sign](/docs/cli-reference/sign)	 — Sign components or hashes
-* [ocm transfer](/docs/cli-reference/transfer)	 — Transfer artifacts or components
-* [ocm verify](/docs/cli-reference/verify)	 — Verify component version signatures
+* [ocm add](/docs/cli-reference/add/)	 — Add elements to a component repository or component version
+* [ocm check](/docs/cli-reference/check/)	 — check components in OCM repository
+* [ocm clean](/docs/cli-reference/clean/)	 — Cleanup/re-organize elements
+* [ocm create](/docs/cli-reference/create/)	 — Create transport or component archive
+* [ocm describe](/docs/cli-reference/describe/)	 — Describe various elements by using appropriate sub commands.
+* [ocm download](/docs/cli-reference/download/)	 — Download oci artifacts, resources or complete components
+* [ocm get](/docs/cli-reference/get/)	 — Get information about artifacts and components
+* [ocm list](/docs/cli-reference/list/)	 — List information about components
+* [ocm set](/docs/cli-reference/set/)	 — Set information about OCM repositories
+* [ocm show](/docs/cli-reference/show/)	 — Show tags or versions
+* [ocm sign](/docs/cli-reference/sign/)	 — Sign components or hashes
+* [ocm transfer](/docs/cli-reference/transfer/)	 — Transfer artifacts or components
+* [ocm verify](/docs/cli-reference/verify/)	 — Verify component version signatures
 
 
 
diff --git a/content/docs/cli-reference/add/_index.md b/content/docs/cli-reference/add/_index.md
index 1d8be6c8..70b1871d 100644
--- a/content/docs/cli-reference/add/_index.md
+++ b/content/docs/cli-reference/add/_index.md
@@ -2,7 +2,6 @@
 title: add
 name: add
 url: /docs/cli-reference/add/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,11 +26,11 @@ ocm add []  ...
 
 ##### Sub Commands
 
-* [ocm add componentversions](/docs/cli-reference/add/componentversions)	 — add component version(s) to a (new) transport archive
-* [ocm add references](/docs/cli-reference/add/references)	 — add aggregation information to a component version
-* [ocm add resource-configuration](/docs/cli-reference/add/resource-configuration)	 — add a resource specification to a resource config file
-* [ocm add resources](/docs/cli-reference/add/resources)	 — add resources to a component version
-* [ocm add routingslips](/docs/cli-reference/add/routingslips)	 — add routing slip entry
-* [ocm add source-configuration](/docs/cli-reference/add/source-configuration)	 — add a source specification to a source config file
-* [ocm add sources](/docs/cli-reference/add/sources)	 — add source information to a component version
+* [ocm add componentversions](/docs/cli-reference/add/componentversions/)	 — add component version(s) to a (new) transport archive
+* [ocm add references](/docs/cli-reference/add/references/)	 — add aggregation information to a component version
+* [ocm add resource-configuration](/docs/cli-reference/add/resource-configuration/)	 — add a resource specification to a resource config file
+* [ocm add resources](/docs/cli-reference/add/resources/)	 — add resources to a component version
+* [ocm add routingslips](/docs/cli-reference/add/routingslips/)	 — add routing slip entry
+* [ocm add source-configuration](/docs/cli-reference/add/source-configuration/)	 — add a source specification to a source config file
+* [ocm add sources](/docs/cli-reference/add/sources/)	 — add source information to a component version
 
diff --git a/content/docs/cli-reference/add/add_componentversions.md b/content/docs/cli-reference/add/add_componentversions.md
index 4065ec1e..2e3c872b 100644
--- a/content/docs/cli-reference/add/add_componentversions.md
+++ b/content/docs/cli-reference/add/add_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: add componentversions
 url: /docs/cli-reference/add/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -62,7 +61,7 @@ existing element append (false) or replace (true) the existing element.
 
 
 The source, resource and reference list can be composed according to the commands
-[ocm add sources](/docs/cli-reference/add/sources), [ocm add resources](/docs/cli-reference/add/resources), [ocm add references](/docs/cli-reference/add/references),
+[ocm add sources](/docs/cli-reference/add/sources/), [ocm add resources](/docs/cli-reference/add/resources/), [ocm add references](/docs/cli-reference/add/references/),
 respectively.
 
 The description file might contain:
@@ -76,7 +75,7 @@ component descriptor. If given it overrides the --schema option
 of the command. By default, v2 is used.
 
 Various elements support to add arbitrary information by using labels
-(see [ocm ocm-labels](/docs/cli-reference/ocm-labels)).
+(see [ocm ocm-labels](/docs/cli-reference/help/ocm-labels/)).
 
 
 The --type option accepts a file format for the
@@ -212,7 +211,7 @@ The uploader name may be a path expression with the following possibilities:
 
 
 
-See [ocm ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) for further details on using
+See [ocm ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) for further details on using
 upload handlers.
 
 
@@ -255,5 +254,5 @@ next to the description file.
 
 ### See Also
 
-* [ocm add](/docs/cli-reference/add)	 — Add elements to a component repository or component version
+* [ocm add](/docs/cli-reference/add/)	 — Add elements to a component repository or component version
 
diff --git a/content/docs/cli-reference/add/add_references.md b/content/docs/cli-reference/add/add_references.md
index 973b7db6..ab706336 100644
--- a/content/docs/cli-reference/add/add_references.md
+++ b/content/docs/cli-reference/add/add_references.md
@@ -2,7 +2,6 @@
 title: references
 name: add references
 url: /docs/cli-reference/add/references/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -174,5 +173,5 @@ $ ocm add references  path/to/ca  references.yaml VERSION=1.0.0
 
 ### See Also
 
-* [ocm add](/docs/cli-reference/add)	 — Add elements to a component repository or component version
+* [ocm add](/docs/cli-reference/add/)	 — Add elements to a component repository or component version
 
diff --git a/content/docs/cli-reference/add/add_resource-configuration.md b/content/docs/cli-reference/add/add_resource-configuration.md
index 4b6edbc3..55a50f37 100644
--- a/content/docs/cli-reference/add/add_resource-configuration.md
+++ b/content/docs/cli-reference/add/add_resource-configuration.md
@@ -2,7 +2,6 @@
 title: resource-configuration
 name: add resource-configuration
 url: /docs/cli-reference/add/resource-configuration/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -79,7 +78,7 @@ ocm add resource-configuration []  { | =--resource,
@@ -688,7 +687,7 @@ shown below.
       An optional keyring used to verify the chart.
     
     It uses the consumer identity type HelmChartRepository with the fields
-    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials)).
+    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials/)).
   
   Options used to configure fields: --accessRepository, --accessVersion, --package
   
@@ -1040,5 +1039,5 @@ $ ocm add resource-configuration resources.yaml --name myresource --type PlainTe
 
 ### See Also
 
-* [ocm add](/docs/cli-reference/add)	 — Add elements to a component repository or component version
+* [ocm add](/docs/cli-reference/add/)	 — Add elements to a component repository or component version
 
diff --git a/content/docs/cli-reference/add/add_resources.md b/content/docs/cli-reference/add/add_resources.md
index 2f6ae596..e3362fe3 100644
--- a/content/docs/cli-reference/add/add_resources.md
+++ b/content/docs/cli-reference/add/add_resources.md
@@ -2,7 +2,6 @@
 title: resources
 name: add resources
 url: /docs/cli-reference/add/resources/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -699,7 +698,7 @@ shown below.
       An optional keyring used to verify the chart.
     
     It uses the consumer identity type HelmChartRepository with the fields
-    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials)).
+    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials/)).
   
   Options used to configure fields: --accessRepository, --accessVersion, --package
   
@@ -1071,5 +1070,5 @@ $ ocm add resources --file path/to/ca  resources.yaml VERSION=1.0.0
 
 ### See Also
 
-* [ocm add](/docs/cli-reference/add)	 — Add elements to a component repository or component version
+* [ocm add](/docs/cli-reference/add/)	 — Add elements to a component repository or component version
 
diff --git a/content/docs/cli-reference/add/add_routingslips.md b/content/docs/cli-reference/add/add_routingslips.md
index 108d8307..5e37003c 100644
--- a/content/docs/cli-reference/add/add_routingslips.md
+++ b/content/docs/cli-reference/add/add_routingslips.md
@@ -2,7 +2,6 @@
 title: routingslips
 name: add routingslips
 url: /docs/cli-reference/add/routingslips/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -122,5 +121,5 @@ $ ocm add routingslip ghcr.io/mandelsoft/ocm//ocmdemoinstaller:0.0.1-dev mandels
 
 ### See Also
 
-* [ocm add](/docs/cli-reference/add)	 — Add elements to a component repository or component version
+* [ocm add](/docs/cli-reference/add/)	 — Add elements to a component repository or component version
 
diff --git a/content/docs/cli-reference/add/add_source-configuration.md b/content/docs/cli-reference/add/add_source-configuration.md
index 424b73c6..5d988090 100644
--- a/content/docs/cli-reference/add/add_source-configuration.md
+++ b/content/docs/cli-reference/add/add_source-configuration.md
@@ -2,7 +2,6 @@
 title: source-configuration
 name: add source-configuration
 url: /docs/cli-reference/add/source-configuration/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -78,7 +77,7 @@ ocm add source-configuration []  { | =}
 ### Description
 
 
-Add a source specification to a source config file used by [ocm add sources](/docs/cli-reference/add/sources).
+Add a source specification to a source config file used by [ocm add sources](/docs/cli-reference/add/sources/).
 
 It is possible to describe a single source via command line options.
 The meta data of this element is described by the argument of option --source,
@@ -688,7 +687,7 @@ shown below.
       An optional keyring used to verify the chart.
     
     It uses the consumer identity type HelmChartRepository with the fields
-    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials)).
+    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials/)).
   
   Options used to configure fields: --accessRepository, --accessVersion, --package
   
@@ -1040,5 +1039,5 @@ $ ocm add source-config sources.yaml --name sources --type filesystem --access '
 
 ### See Also
 
-* [ocm add](/docs/cli-reference/add)	 — Add elements to a component repository or component version
+* [ocm add](/docs/cli-reference/add/)	 — Add elements to a component repository or component version
 
diff --git a/content/docs/cli-reference/add/add_sources.md b/content/docs/cli-reference/add/add_sources.md
index f8bc0918..3953ae22 100644
--- a/content/docs/cli-reference/add/add_sources.md
+++ b/content/docs/cli-reference/add/add_sources.md
@@ -2,7 +2,6 @@
 title: sources
 name: add sources
 url: /docs/cli-reference/add/sources/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -697,7 +696,7 @@ shown below.
       An optional keyring used to verify the chart.
     
     It uses the consumer identity type HelmChartRepository with the fields
-    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials)).
+    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials/)).
   
   Options used to configure fields: --accessRepository, --accessVersion, --package
   
@@ -1055,5 +1054,5 @@ $ ocm add sources --file path/to/cafile sources.yaml
 
 ### See Also
 
-* [ocm add](/docs/cli-reference/add)	 — Add elements to a component repository or component version
+* [ocm add](/docs/cli-reference/add/)	 — Add elements to a component repository or component version
 
diff --git a/content/docs/cli-reference/check/_index.md b/content/docs/cli-reference/check/_index.md
index dd230b75..da9273a2 100644
--- a/content/docs/cli-reference/check/_index.md
+++ b/content/docs/cli-reference/check/_index.md
@@ -2,7 +2,6 @@
 title: check
 name: check
 url: /docs/cli-reference/check/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,5 +26,5 @@ ocm check []  ...
 
 ##### Sub Commands
 
-* [ocm check componentversions](/docs/cli-reference/check/componentversions)	 — Check completeness of a component version in an OCM repository
+* [ocm check componentversions](/docs/cli-reference/check/componentversions/)	 — Check completeness of a component version in an OCM repository
 
diff --git a/content/docs/cli-reference/check/check_componentversions.md b/content/docs/cli-reference/check/check_componentversions.md
index 46e4c198..bba0baf2 100644
--- a/content/docs/cli-reference/check/check_componentversions.md
+++ b/content/docs/cli-reference/check/check_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: check componentversions
 url: /docs/cli-reference/check/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -102,5 +101,5 @@ $ ocm get componentversion --repo OCIRegistry::ghcr.io mandelsoft/kubelink
 
 ### See Also
 
-* [ocm check](/docs/cli-reference/check)	 — check components in OCM repository
+* [ocm check](/docs/cli-reference/check/)	 — check components in OCM repository
 
diff --git a/content/docs/cli-reference/clean/_index.md b/content/docs/cli-reference/clean/_index.md
index b6beece2..d9213623 100644
--- a/content/docs/cli-reference/clean/_index.md
+++ b/content/docs/cli-reference/clean/_index.md
@@ -2,7 +2,6 @@
 title: clean
 name: clean
 url: /docs/cli-reference/clean/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,5 +26,5 @@ ocm clean []  ...
 
 ##### Sub Commands
 
-* [ocm clean cache](/docs/cli-reference/clean/cache)	 — cleanup oci blob cache
+* [ocm clean cache](/docs/cli-reference/clean/cache/)	 — cleanup oci blob cache
 
diff --git a/content/docs/cli-reference/clean/clean_cache.md b/content/docs/cli-reference/clean/clean_cache.md
index d84e099b..d62cfa13 100644
--- a/content/docs/cli-reference/clean/clean_cache.md
+++ b/content/docs/cli-reference/clean/clean_cache.md
@@ -2,7 +2,6 @@
 title: cache
 name: clean cache
 url: /docs/cli-reference/clean/cache/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -39,5 +38,5 @@ $ ocm clean cache
 
 ### See Also
 
-* [ocm clean](/docs/cli-reference/clean)	 — Cleanup/re-organize elements
+* [ocm clean](/docs/cli-reference/clean/)	 — Cleanup/re-organize elements
 
diff --git a/content/docs/cli-reference/create/_index.md b/content/docs/cli-reference/create/_index.md
index fba14567..cb3be2b8 100644
--- a/content/docs/cli-reference/create/_index.md
+++ b/content/docs/cli-reference/create/_index.md
@@ -2,7 +2,6 @@
 title: create
 name: create
 url: /docs/cli-reference/create/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,7 +26,7 @@ ocm create []  ...
 
 ##### Sub Commands
 
-* [ocm create componentarchive](/docs/cli-reference/create/componentarchive)	 — create new component archive
-* [ocm create rsakeypair](/docs/cli-reference/create/rsakeypair)	 — create RSA public key pair
-* [ocm create transportarchive](/docs/cli-reference/create/transportarchive)	 — create new OCI/OCM transport  archive
+* [ocm create componentarchive](/docs/cli-reference/create/componentarchive/)	 — create new component archive
+* [ocm create rsakeypair](/docs/cli-reference/create/rsakeypair/)	 — create RSA public key pair
+* [ocm create transportarchive](/docs/cli-reference/create/transportarchive/)	 — create new OCI/OCM transport  archive
 
diff --git a/content/docs/cli-reference/create/create_componentarchive.md b/content/docs/cli-reference/create/create_componentarchive.md
index 29bd64fe..c56c2cf3 100644
--- a/content/docs/cli-reference/create/create_componentarchive.md
+++ b/content/docs/cli-reference/create/create_componentarchive.md
@@ -2,7 +2,6 @@
 title: componentarchive
 name: create componentarchive
 url: /docs/cli-reference/create/componentarchive/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -62,5 +61,5 @@ $ ocm create componentarchive --file myfirst --provider acme.org --provider emai
 
 ### See Also
 
-* [ocm create](/docs/cli-reference/create)	 — Create transport or component archive
+* [ocm create](/docs/cli-reference/create/)	 — Create transport or component archive
 
diff --git a/content/docs/cli-reference/create/create_rsakeypair.md b/content/docs/cli-reference/create/create_rsakeypair.md
index 8c1bf0d6..5dd0a87b 100644
--- a/content/docs/cli-reference/create/create_rsakeypair.md
+++ b/content/docs/cli-reference/create/create_rsakeypair.md
@@ -2,7 +2,6 @@
 title: rsakeypair
 name: create rsakeypair
 url: /docs/cli-reference/create/rsakeypair/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -69,5 +68,5 @@ $ ocm create rsakeypair mandelsoft.priv mandelsoft.cert issuer=mandelsoft
 
 ### See Also
 
-* [ocm create](/docs/cli-reference/create)	 — Create transport or component archive
+* [ocm create](/docs/cli-reference/create/)	 — Create transport or component archive
 
diff --git a/content/docs/cli-reference/create/create_transportarchive.md b/content/docs/cli-reference/create/create_transportarchive.md
index 02887459..c02882ee 100644
--- a/content/docs/cli-reference/create/create_transportarchive.md
+++ b/content/docs/cli-reference/create/create_transportarchive.md
@@ -2,7 +2,6 @@
 title: transportarchive
 name: create transportarchive
 url: /docs/cli-reference/create/transportarchive/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -32,5 +31,5 @@ to host artifact content or a tar/tgz file.
 
 ### See Also
 
-* [ocm create](/docs/cli-reference/create)	 — Create transport or component archive
+* [ocm create](/docs/cli-reference/create/)	 — Create transport or component archive
 
diff --git a/content/docs/cli-reference/describe/_index.md b/content/docs/cli-reference/describe/_index.md
index 65216bdb..224ecce2 100644
--- a/content/docs/cli-reference/describe/_index.md
+++ b/content/docs/cli-reference/describe/_index.md
@@ -2,7 +2,6 @@
 title: describe
 name: describe
 url: /docs/cli-reference/describe/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,8 +26,8 @@ ocm describe []  ...
 
 ##### Sub Commands
 
-* [ocm describe artifacts](/docs/cli-reference/describe/artifacts)	 — describe artifact version
-* [ocm describe cache](/docs/cli-reference/describe/cache)	 — show OCI blob cache information
-* [ocm describe package](/docs/cli-reference/describe/package)	 — describe TOI package
-* [ocm describe plugins](/docs/cli-reference/describe/plugins)	 — get plugins
+* [ocm describe artifacts](/docs/cli-reference/describe/artifacts/)	 — describe artifact version
+* [ocm describe cache](/docs/cli-reference/describe/cache/)	 — show OCI blob cache information
+* [ocm describe package](/docs/cli-reference/describe/package/)	 — describe TOI package
+* [ocm describe plugins](/docs/cli-reference/describe/plugins/)	 — get plugins
 
diff --git a/content/docs/cli-reference/describe/describe_artifacts.md b/content/docs/cli-reference/describe/describe_artifacts.md
index abb3e200..eb0e6492 100644
--- a/content/docs/cli-reference/describe/describe_artifacts.md
+++ b/content/docs/cli-reference/describe/describe_artifacts.md
@@ -2,7 +2,6 @@
 title: artifacts
 name: describe artifacts
 url: /docs/cli-reference/describe/artifacts/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -86,5 +85,5 @@ $ ocm describe artifact --repo OCIRegistry::ghcr.io mandelsoft/kubelink
 
 ### See Also
 
-* [ocm describe](/docs/cli-reference/describe)	 — Describe various elements by using appropriate sub commands.
+* [ocm describe](/docs/cli-reference/describe/)	 — Describe various elements by using appropriate sub commands.
 
diff --git a/content/docs/cli-reference/describe/describe_cache.md b/content/docs/cli-reference/describe/describe_cache.md
index 8dc6d9d8..741ee8cd 100644
--- a/content/docs/cli-reference/describe/describe_cache.md
+++ b/content/docs/cli-reference/describe/describe_cache.md
@@ -2,7 +2,6 @@
 title: cache
 name: describe cache
 url: /docs/cli-reference/describe/cache/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -37,5 +36,5 @@ $ ocm cache info
 
 ### See Also
 
-* [ocm describe](/docs/cli-reference/describe)	 — Describe various elements by using appropriate sub commands.
+* [ocm describe](/docs/cli-reference/describe/)	 — Describe various elements by using appropriate sub commands.
 
diff --git a/content/docs/cli-reference/describe/describe_package.md b/content/docs/cli-reference/describe/describe_package.md
index f07d24d5..662654be 100644
--- a/content/docs/cli-reference/describe/describe_package.md
+++ b/content/docs/cli-reference/describe/describe_package.md
@@ -2,7 +2,6 @@
 title: package
 name: describe package
 url: /docs/cli-reference/describe/package/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -30,7 +29,7 @@ Describe a TOI package provided by a resource of an OCM component version.
 
 The package resource must have the type toiPackage.
 This is a simple YAML file resource describing the bootstrapping of a dedicated kind
-of software. See also the topic [ocm toi-bootstrapping](/docs/cli-reference/toi-bootstrapping).
+of software. See also the topic [ocm toi-bootstrapping](/docs/cli-reference/help/toi-bootstrapping/).
 
 The first matching resource of this type is selected. Optionally a set of
 identity attribute can be specified used to refine the match. This can be the
@@ -100,5 +99,5 @@ $ ocm toi describe package ghcr.io/mandelsoft/ocm//ocmdemoinstaller:0.0.1-dev
 
 ### See Also
 
-* [ocm describe](/docs/cli-reference/describe)	 — Describe various elements by using appropriate sub commands.
+* [ocm describe](/docs/cli-reference/describe/)	 — Describe various elements by using appropriate sub commands.
 
diff --git a/content/docs/cli-reference/describe/describe_plugins.md b/content/docs/cli-reference/describe/describe_plugins.md
index e6b01b59..fa40ba25 100644
--- a/content/docs/cli-reference/describe/describe_plugins.md
+++ b/content/docs/cli-reference/describe/describe_plugins.md
@@ -2,7 +2,6 @@
 title: plugins
 name: describe plugins
 url: /docs/cli-reference/describe/plugins/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -39,5 +38,5 @@ $ ocm describe plugins demo
 
 ### See Also
 
-* [ocm describe](/docs/cli-reference/describe)	 — Describe various elements by using appropriate sub commands.
+* [ocm describe](/docs/cli-reference/describe/)	 — Describe various elements by using appropriate sub commands.
 
diff --git a/content/docs/cli-reference/download/_index.md b/content/docs/cli-reference/download/_index.md
index 792c752d..35be0fd8 100644
--- a/content/docs/cli-reference/download/_index.md
+++ b/content/docs/cli-reference/download/_index.md
@@ -2,7 +2,6 @@
 title: download
 name: download
 url: /docs/cli-reference/download/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,8 +26,8 @@ ocm download []  ...
 
 ##### Sub Commands
 
-* [ocm download artifacts](/docs/cli-reference/download/artifacts)	 — download oci artifacts
-* [ocm download cli](/docs/cli-reference/download/cli)	 — download OCM CLI from an OCM repository
-* [ocm download componentversions](/docs/cli-reference/download/componentversions)	 — download ocm component versions
-* [ocm download resources](/docs/cli-reference/download/resources)	 — download resources of a component version
+* [ocm download artifacts](/docs/cli-reference/download/artifacts/)	 — download oci artifacts
+* [ocm download cli](/docs/cli-reference/download/cli/)	 — download OCM CLI from an OCM repository
+* [ocm download componentversions](/docs/cli-reference/download/componentversions/)	 — download ocm component versions
+* [ocm download resources](/docs/cli-reference/download/resources/)	 — download resources of a component version
 
diff --git a/content/docs/cli-reference/download/download_artifacts.md b/content/docs/cli-reference/download/download_artifacts.md
index da64fe8c..cdf7781d 100644
--- a/content/docs/cli-reference/download/download_artifacts.md
+++ b/content/docs/cli-reference/download/download_artifacts.md
@@ -2,7 +2,6 @@
 title: artifacts
 name: download artifacts
 url: /docs/cli-reference/download/artifacts/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -88,5 +87,5 @@ The default format is directory.
 
 ### See Also
 
-* [ocm download](/docs/cli-reference/download)	 — Download oci artifacts, resources or complete components
+* [ocm download](/docs/cli-reference/download/)	 — Download oci artifacts, resources or complete components
 
diff --git a/content/docs/cli-reference/download/download_cli.md b/content/docs/cli-reference/download/download_cli.md
index 2b46b77c..67d1e519 100644
--- a/content/docs/cli-reference/download/download_cli.md
+++ b/content/docs/cli-reference/download/download_cli.md
@@ -2,7 +2,6 @@
 title: cli
 name: download cli
 url: /docs/cli-reference/download/cli/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -108,5 +107,5 @@ specifying a verification file with --verified.
 
 ### See Also
 
-* [ocm download](/docs/cli-reference/download)	 — Download oci artifacts, resources or complete components
+* [ocm download](/docs/cli-reference/download/)	 — Download oci artifacts, resources or complete components
 
diff --git a/content/docs/cli-reference/download/download_componentversions.md b/content/docs/cli-reference/download/download_componentversions.md
index 9a6186cb..b8ffcb8d 100644
--- a/content/docs/cli-reference/download/download_componentversions.md
+++ b/content/docs/cli-reference/download/download_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: download componentversions
 url: /docs/cli-reference/download/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -88,5 +87,5 @@ The default format is directory.
 
 ### See Also
 
-* [ocm download](/docs/cli-reference/download)	 — Download oci artifacts, resources or complete components
+* [ocm download](/docs/cli-reference/download/)	 — Download oci artifacts, resources or complete components
 
diff --git a/content/docs/cli-reference/download/download_resources.md b/content/docs/cli-reference/download/download_resources.md
index e2731dc0..ae572235 100644
--- a/content/docs/cli-reference/download/download_resources.md
+++ b/content/docs/cli-reference/download/download_resources.md
@@ -2,7 +2,6 @@
 title: resources
 name: download resources
 url: /docs/cli-reference/download/resources/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -206,7 +205,7 @@ The downloader name may be a path expression with the following possibilities:
 
 
 
-See [ocm ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers) for further details on using
+See [ocm ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/) for further details on using
 download handlers.
 
 
@@ -241,5 +240,5 @@ specifying a verification file with --verified.
 
 ### See Also
 
-* [ocm download](/docs/cli-reference/download)	 — Download oci artifacts, resources or complete components
+* [ocm download](/docs/cli-reference/download/)	 — Download oci artifacts, resources or complete components
 
diff --git a/content/docs/cli-reference/get/_index.md b/content/docs/cli-reference/get/_index.md
index effca9bd..e6a471d2 100644
--- a/content/docs/cli-reference/get/_index.md
+++ b/content/docs/cli-reference/get/_index.md
@@ -2,7 +2,6 @@
 title: get
 name: get
 url: /docs/cli-reference/get/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,15 +26,15 @@ ocm get []  ...
 
 ##### Sub Commands
 
-* [ocm get artifacts](/docs/cli-reference/get/artifacts)	 — get artifact version
-* [ocm get componentversions](/docs/cli-reference/get/componentversions)	 — get component version
-* [ocm get config](/docs/cli-reference/get/config)	 — Get evaluated config for actual command call
-* [ocm get credentials](/docs/cli-reference/get/credentials)	 — Get credentials for a dedicated consumer spec
-* [ocm get plugins](/docs/cli-reference/get/plugins)	 — get plugins
-* [ocm get pubsub](/docs/cli-reference/get/pubsub)	 — Get the pubsub spec for an ocm repository
-* [ocm get references](/docs/cli-reference/get/references)	 — get references of a component version
-* [ocm get resources](/docs/cli-reference/get/resources)	 — get resources of a component version
-* [ocm get routingslips](/docs/cli-reference/get/routingslips)	 — get routings slips for a component version
-* [ocm get sources](/docs/cli-reference/get/sources)	 — get sources of a component version
-* [ocm get verified](/docs/cli-reference/get/verified)	 — get verified component versions
+* [ocm get artifacts](/docs/cli-reference/get/artifacts/)	 — get artifact version
+* [ocm get componentversions](/docs/cli-reference/get/componentversions/)	 — get component version
+* [ocm get config](/docs/cli-reference/get/config/)	 — Get evaluated config for actual command call
+* [ocm get credentials](/docs/cli-reference/get/credentials/)	 — Get credentials for a dedicated consumer spec
+* [ocm get plugins](/docs/cli-reference/get/plugins/)	 — get plugins
+* [ocm get pubsub](/docs/cli-reference/get/pubsub/)	 — Get the pubsub spec for an ocm repository
+* [ocm get references](/docs/cli-reference/get/references/)	 — get references of a component version
+* [ocm get resources](/docs/cli-reference/get/resources/)	 — get resources of a component version
+* [ocm get routingslips](/docs/cli-reference/get/routingslips/)	 — get routings slips for a component version
+* [ocm get sources](/docs/cli-reference/get/sources/)	 — get sources of a component version
+* [ocm get verified]()	 — get verified component versions
 
diff --git a/content/docs/cli-reference/get/get_artifacts.md b/content/docs/cli-reference/get/get_artifacts.md
index 18a31418..6e8582ea 100644
--- a/content/docs/cli-reference/get/get_artifacts.md
+++ b/content/docs/cli-reference/get/get_artifacts.md
@@ -2,7 +2,6 @@
 title: artifacts
 name: get artifacts
 url: /docs/cli-reference/get/artifacts/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -91,5 +90,5 @@ $ ocm get artifact --repo OCIRegistry::ghcr.io mandelsoft/kubelink
 
 ### See Also
 
-* [ocm get](/docs/cli-reference/get)	 — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/)	 — Get information about artifacts and components
 
diff --git a/content/docs/cli-reference/get/get_componentversions.md b/content/docs/cli-reference/get/get_componentversions.md
index 84ffd1b2..041c1217 100644
--- a/content/docs/cli-reference/get/get_componentversions.md
+++ b/content/docs/cli-reference/get/get_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: get componentversions
 url: /docs/cli-reference/get/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -130,5 +129,5 @@ $ ocm get componentversion --repo OCIRegistry::ghcr.io mandelsoft/kubelink
 
 ### See Also
 
-* [ocm get](/docs/cli-reference/get)	 — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/)	 — Get information about artifacts and components
 
diff --git a/content/docs/cli-reference/get/get_config.md b/content/docs/cli-reference/get/get_config.md
index 98846a3c..b3556130 100644
--- a/content/docs/cli-reference/get/get_config.md
+++ b/content/docs/cli-reference/get/get_config.md
@@ -2,7 +2,6 @@
 title: config
 name: get config
 url: /docs/cli-reference/get/config/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -41,5 +40,5 @@ The following modes are supported:
 
 ### See Also
 
-* [ocm get](/docs/cli-reference/get)	 — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/)	 — Get information about artifacts and components
 
diff --git a/content/docs/cli-reference/get/get_credentials.md b/content/docs/cli-reference/get/get_credentials.md
index c1f7c071..0cbafca6 100644
--- a/content/docs/cli-reference/get/get_credentials.md
+++ b/content/docs/cli-reference/get/get_credentials.md
@@ -2,7 +2,6 @@
 title: credentials
 name: get credentials
 url: /docs/cli-reference/get/credentials/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -189,5 +188,5 @@ The usage of a dedicated matcher can be enforced by the option --matcher--output the output mode can be selected.
@@ -43,5 +42,5 @@ The following modes are supported:
 
 ### See Also
 
-* [ocm get](/docs/cli-reference/get)	 — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/)	 — Get information about artifacts and components
 
diff --git a/content/docs/cli-reference/get/get_references.md b/content/docs/cli-reference/get/get_references.md
index f9f28ead..9a3aca29 100644
--- a/content/docs/cli-reference/get/get_references.md
+++ b/content/docs/cli-reference/get/get_references.md
@@ -2,7 +2,6 @@
 title: references
 name: get references
 url: /docs/cli-reference/get/references/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -112,5 +111,5 @@ The following modes are supported:
 
 ### See Also
 
-* [ocm get](/docs/cli-reference/get)	 — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/)	 — Get information about artifacts and components
 
diff --git a/content/docs/cli-reference/get/get_resources.md b/content/docs/cli-reference/get/get_resources.md
index 708ded17..bc0a3e3b 100644
--- a/content/docs/cli-reference/get/get_resources.md
+++ b/content/docs/cli-reference/get/get_resources.md
@@ -2,7 +2,6 @@
 title: resources
 name: get resources
 url: /docs/cli-reference/get/resources/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -113,5 +112,5 @@ The following modes are supported:
 
 ### See Also
 
-* [ocm get](/docs/cli-reference/get)	 — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/)	 — Get information about artifacts and components
 
diff --git a/content/docs/cli-reference/get/get_routingslips.md b/content/docs/cli-reference/get/get_routingslips.md
index dd45e227..71bad0ec 100644
--- a/content/docs/cli-reference/get/get_routingslips.md
+++ b/content/docs/cli-reference/get/get_routingslips.md
@@ -2,7 +2,6 @@
 title: routingslips
 name: get routingslips
 url: /docs/cli-reference/get/routingslips/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -107,5 +106,5 @@ The following modes are supported:
 
 ### See Also
 
-* [ocm get](/docs/cli-reference/get)	 — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/)	 — Get information about artifacts and components
 
diff --git a/content/docs/cli-reference/get/get_sources.md b/content/docs/cli-reference/get/get_sources.md
index 0bb2b08b..78ce8f9b 100644
--- a/content/docs/cli-reference/get/get_sources.md
+++ b/content/docs/cli-reference/get/get_sources.md
@@ -2,7 +2,6 @@
 title: sources
 name: get sources
 url: /docs/cli-reference/get/sources/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -112,5 +111,5 @@ The following modes are supported:
 
 ### See Also
 
-* [ocm get](/docs/cli-reference/get)	 — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/)	 — Get information about artifacts and components
 
diff --git a/content/docs/cli-reference/get/get_verified.md b/content/docs/cli-reference/get/get_verified.md
index 9b0e4c2a..7e29c152 100644
--- a/content/docs/cli-reference/get/get_verified.md
+++ b/content/docs/cli-reference/get/get_verified.md
@@ -2,7 +2,6 @@
 title: verified
 name: get verified
 url: /docs/cli-reference/get/verified/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -50,5 +49,5 @@ $ ocm get verified -f verified.yaml acme.org/component -o yaml
 
 ### See Also
 
-* [ocm get](/docs/cli-reference/get)	 — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/)	 — Get information about artifacts and components
 
diff --git a/content/docs/cli-reference/help/_index.md b/content/docs/cli-reference/help/_index.md
index 787f1412..9f8653b7 100644
--- a/content/docs/cli-reference/help/_index.md
+++ b/content/docs/cli-reference/help/_index.md
@@ -2,7 +2,6 @@
 title: help
 name: help
 url: /docs/cli-reference/help
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -10,15 +9,16 @@ sidebar:
   collapsed: true
 ---
 ### Additional Topics
-* [attributes](/docs/cli-reference/attributes)	 — attributes
-* [configfile](/docs/cli-reference/configfile)	 — configfile
-* [credential-handling](/docs/cli-reference/credential-handling)	 — credential-handling
-* [logging](/docs/cli-reference/logging)	 — logging
-* [oci-references](/docs/cli-reference/oci-references)	 — oci-references
-* [ocm-accessmethods](/docs/cli-reference/ocm-accessmethods)	 — ocm-accessmethods
-* [ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers)	 — ocm-downloadhandlers
-* [ocm-labels](/docs/cli-reference/ocm-labels)	 — ocm-labels
-* [ocm-pubsub](/docs/cli-reference/ocm-pubsub)	 — ocm-pubsub
-* [ocm-references](/docs/cli-reference/ocm-references)	 — ocm-references
-* [ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers)	 — ocm-uploadhandlers
-* [toi-bootstrapping](/docs/cli-reference/toi-bootstrapping)	 — toi-bootstrapping
+
+* [attributes](/docs/cli-reference/help/attributes/) — attributes
+* [configfile](/docs/cli-reference/help/configfile/) — configfile
+* [credential-handling](/docs/cli-reference/help/credential-handling/) — credential-handling
+* [logging](/docs/cli-reference/help/logging/) — logging
+* [oci-references](/docs/cli-reference/help/oci-references/) — oci-references
+* [ocm-accessmethods](/docs/cli-reference/help/ocm-accessmethods/) — ocm-accessmethods
+* [ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/) — ocm-downloadhandlers
+* [ocm-labels](/docs/cli-reference/help/ocm-labels/) — ocm-labels
+* [ocm-pubsub](/docs/cli-reference/help/ocm-pubsub/) — ocm-pubsub
+* [ocm-references](/docs/cli-reference/help/ocm-references/) — ocm-references
+* [ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) — ocm-uploadhandlers
+* [toi-bootstrapping](/docs/cli-reference/help/toi-bootstrapping/) — toi-bootstrapping
diff --git a/content/docs/cli-reference/help/attributes.md b/content/docs/cli-reference/help/attributes.md
index d7086258..2d234728 100644
--- a/content/docs/cli-reference/help/attributes.md
+++ b/content/docs/cli-reference/help/attributes.md
@@ -2,7 +2,6 @@
 title: attributes
 name: attributes
 url: /docs/cli-reference/help/attributes/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -14,8 +13,8 @@ sidebar:
 
 The OCM library supports a set of attributes, which can be used to influence
 the behaviour of various functions. The CLI also supports setting of those
-attributes using the config file (see [ocm configfile](/docs/cli-reference/configfile)) or by
-command line options of the main command (see [ocm](/docs/cli-reference)).
+attributes using the config file (see [ocm configfile](/docs/cli-reference/help/configfile/)) or by
+command line options of the main command (see [ocm](/docs/cli-reference/)).
 
 The following options are available in the currently used version of the
 OCM library:
diff --git a/content/docs/cli-reference/help/configfile.md b/content/docs/cli-reference/help/configfile.md
index d0efb252..7ebc716b 100644
--- a/content/docs/cli-reference/help/configfile.md
+++ b/content/docs/cli-reference/help/configfile.md
@@ -2,7 +2,6 @@
 title: configfile
 name: configfile
 url: /docs/cli-reference/help/configfile/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -71,7 +70,7 @@ The following configuration types are supported:
- downloader.ocm.config.ocm.software The config type downloader.ocm.config.ocm.software can be used to define a list - of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers)): + of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/)): 
       type: downloader.ocm.config.ocm.software
@@ -322,7 +321,7 @@ The following configuration types are supported:
- uploader.ocm.config.ocm.software The config type uploader.ocm.config.ocm.software can be used to define a list - of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers)): + of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/)): 
       type: uploader.ocm.config.ocm.software
diff --git a/content/docs/cli-reference/help/credential-handling.md b/content/docs/cli-reference/help/credential-handling.md
index d5ff1124..8ec0ee14 100644
--- a/content/docs/cli-reference/help/credential-handling.md
+++ b/content/docs/cli-reference/help/credential-handling.md
@@ -2,7 +2,6 @@
 title: credential-handling
 name: credential-handling
 url: /docs/cli-reference/help/credential-handling/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -274,7 +273,7 @@ by the provider type).
 The type Credentials can be used to inline
 credentials in credential configuration objects
 to configure mappings of consumer identities to a credential
-set (see [ocm configfile](/docs/cli-reference/configfile)).
+set (see [ocm configfile](/docs/cli-reference/help/configfile/)).
 
 The following types are currently available:
 
diff --git a/content/docs/cli-reference/help/logging.md b/content/docs/cli-reference/help/logging.md
index e0b5a698..4629339e 100644
--- a/content/docs/cli-reference/help/logging.md
+++ b/content/docs/cli-reference/help/logging.md
@@ -2,7 +2,6 @@
 title: logging
 name: logging
 url: /docs/cli-reference/help/logging/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -12,8 +11,8 @@ sidebar:
 ### Description
 
 
-Logging can be configured as part of the ocm config file ([ocm configfile](/docs/cli-reference/configfile))
-or by command line options of the [ocm](/docs/cli-reference) command. Details about
+Logging can be configured as part of the ocm config file ([ocm configfile](/docs/cli-reference/help/configfile/))
+or by command line options of the [ocm](/docs/cli-reference/) command. Details about
 the YAML structure of a logging settings can be found on https://github.com/mandelsoft/logging.
 
 The command line also supports some quick-config options for enabling log levels
diff --git a/content/docs/cli-reference/help/oci-references.md b/content/docs/cli-reference/help/oci-references.md
index 13cf0fa6..06d8f729 100644
--- a/content/docs/cli-reference/help/oci-references.md
+++ b/content/docs/cli-reference/help/oci-references.md
@@ -2,7 +2,6 @@
 title: oci-references
 name: oci-references
 url: /docs/cli-reference/help/oci-references/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
diff --git a/content/docs/cli-reference/help/ocm-accessmethods.md b/content/docs/cli-reference/help/ocm-accessmethods.md
index d93994be..38856d25 100644
--- a/content/docs/cli-reference/help/ocm-accessmethods.md
+++ b/content/docs/cli-reference/help/ocm-accessmethods.md
@@ -2,7 +2,6 @@
 title: ocm-accessmethods
 name: ocm-accessmethods
 url: /docs/cli-reference/help/ocm-accessmethods/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -133,7 +132,7 @@ shown below.
       An optional keyring used to verify the chart.
     
     It uses the consumer identity type HelmChartRepository with the fields
-    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials)).
+    for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials/)).
   
   Options used to configure fields: --accessRepository, --accessVersion, --package
   
diff --git a/content/docs/cli-reference/help/ocm-downloadhandlers.md b/content/docs/cli-reference/help/ocm-downloadhandlers.md
index a48f4a48..d32efd55 100644
--- a/content/docs/cli-reference/help/ocm-downloadhandlers.md
+++ b/content/docs/cli-reference/help/ocm-downloadhandlers.md
@@ -2,7 +2,6 @@
 title: ocm-downloadhandlers
 name: ocm-downloadhandlers
 url: /docs/cli-reference/help/ocm-downloadhandlers/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -14,7 +13,7 @@ sidebar:
 
 A download handler can be used to process resources to be downloaded from
 on OCM repository. By default, the blobs provided from the access method
-(see [ocm ocm-accessmethods](/docs/cli-reference/ocm-accessmethods)) are used to store the resource content
+(see [ocm ocm-accessmethods](/docs/cli-reference/help/ocm-accessmethods/)) are used to store the resource content
 in the local filesystem. Download handlers can be used to tweak this process.
 They get access to the blob content and decide on their own what to do
 with it, or how to transform it into files stored in the file system.
@@ -31,7 +30,7 @@ New handlers can be provided by plugins. In general available handlers,
 plugin-based or as part of the CLI coding are nameable using an hierarchical
 namespace. Those names can be used by a --downloader option
 to register handlers for various conditions for CLI commands like
-[ocm download resources](/docs/cli-reference/download/resources) (implicitly registered download handlers
+[ocm download resources](/docs/cli-reference/download/resources/) (implicitly registered download handlers
 can be enabled using the option -d).
 
 Besides the activation constraints (resource type and media type of the
@@ -121,7 +120,7 @@ The following handler names are possible:
 
 
 
-See [ocm ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers) for further details on using
+See [ocm ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/) for further details on using
 download handlers.
 
 
diff --git a/content/docs/cli-reference/help/ocm-labels.md b/content/docs/cli-reference/help/ocm-labels.md
index 7de9c785..2708411a 100644
--- a/content/docs/cli-reference/help/ocm-labels.md
+++ b/content/docs/cli-reference/help/ocm-labels.md
@@ -2,7 +2,6 @@
 title: ocm-labels
 name: ocm-labels
 url: /docs/cli-reference/help/ocm-labels/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
diff --git a/content/docs/cli-reference/help/ocm-pubsub.md b/content/docs/cli-reference/help/ocm-pubsub.md
index f4683d91..39625bdb 100644
--- a/content/docs/cli-reference/help/ocm-pubsub.md
+++ b/content/docs/cli-reference/help/ocm-pubsub.md
@@ -2,7 +2,6 @@
 title: ocm-pubsub
 name: ocm-pubsub
 url: /docs/cli-reference/help/ocm-pubsub/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -15,8 +14,8 @@ sidebar:
 An OCM repository can be configured to propagate change events via a 
 publish/subscribe system, if there is a persistence provider for the dedicated
 repository type. If available any known publish/subscribe system can
-be configured with [ocm set pubsub](/docs/cli-reference/set/pubsub) and shown with
-[ocm get pubsub](/docs/cli-reference/get/pubsub). Hereby, the pub/sub system 
+be configured with [ocm set pubsub](/docs/cli-reference/set/pubsub/) and shown with
+[ocm get pubsub](/docs/cli-reference/get/pubsub/). Hereby, the pub/sub system 
 is described by a typed specification.
 
 
diff --git a/content/docs/cli-reference/help/ocm-references.md b/content/docs/cli-reference/help/ocm-references.md
index da399957..a1025483 100644
--- a/content/docs/cli-reference/help/ocm-references.md
+++ b/content/docs/cli-reference/help/ocm-references.md
@@ -2,7 +2,6 @@
 title: ocm-references
 name: ocm-references
 url: /docs/cli-reference/help/ocm-references/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
diff --git a/content/docs/cli-reference/help/ocm-uploadhandlers.md b/content/docs/cli-reference/help/ocm-uploadhandlers.md
index b48dfabb..c71c5efd 100644
--- a/content/docs/cli-reference/help/ocm-uploadhandlers.md
+++ b/content/docs/cli-reference/help/ocm-uploadhandlers.md
@@ -2,7 +2,6 @@
 title: ocm-uploadhandlers
 name: ocm-uploadhandlers
 url: /docs/cli-reference/help/ocm-uploadhandlers/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -38,7 +37,7 @@ New handlers can be provided by plugins. In general available handlers,
 plugin-based or as part of the CLI coding are nameable using an hierarchical
 namespace. Those names can be used by a --uploader option
 to register handlers for various conditions for CLI commands like
-[ocm transfer componentversions](/docs/cli-reference/transfer/componentversions) or [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive).
+[ocm transfer componentversions](/docs/cli-reference/transfer/componentversions/) or [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive/).
 
 Besides the activation constraints (resource type and media type of the
 resource blob), it is possible to pass a target configuration controlling the
@@ -93,7 +92,7 @@ The following handler names are possible:
 
 
 
-See [ocm ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) for further details on using
+See [ocm ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) for further details on using
 upload handlers.
 
 
diff --git a/content/docs/cli-reference/help/toi-bootstrapping.md b/content/docs/cli-reference/help/toi-bootstrapping.md
index 07b89871..96171cc7 100644
--- a/content/docs/cli-reference/help/toi-bootstrapping.md
+++ b/content/docs/cli-reference/help/toi-bootstrapping.md
@@ -2,7 +2,6 @@
 title: toi-bootstrapping
 name: toi-bootstrapping
 url: /docs/cli-reference/help/toi-bootstrapping/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -17,11 +16,11 @@ It provides a possibility to run images taken from a component version with user
 configuration and feed them with the content of this component version.
 It is some basic mechanism, which can be used to execute simple installation
 steps based on content described by the Open Component Model
-(see [ocm bootstrap package](/docs/cli-reference/bootstrap/package)).
+(see [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package.md)).
 
 Therefore, a dedicated resource type toiPackage is defined,
 which describes an installation package to be handled by TOI.
-When calling the [ocm bootstrap package](/docs/cli-reference/bootstrap/package) command it is selected by a resource
+When calling the [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package.md) command it is selected by a resource
 identity pattern. The first resource in given component version matching the
 pattern is used. A possible use case could be to provide different packages for
 different environments. The resource can use an identity attribute
@@ -110,7 +109,7 @@ It has the following format:
   - **configFile**: an example template for a parameter file
   - **credentialsFile**: an example template for a credentials file
 
-  Those templates can be downloaded with [ocm bootstrap configuration](/docs/cli-reference/bootstrap/configuration).
+  Those templates can be downloaded with [ocm bootstrap configuration](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration.md).
 
 #### *ExecutorSpecification*
 
@@ -359,7 +358,7 @@ It uses the following fields:
   in the OCM support library, if used by the executor. At least the field
   type and one additional field must be set.
 
-Credentials are provided in an ocm config file (see [ocm configfile](/docs/cli-reference/configfile)).
+Credentials are provided in an ocm config file (see [ocm configfile](/docs/cli-reference/help/configfile/)).
 It uses a memory credential repository with the name default
 to store the credentials under the given name. Additionally appropriate
 consumer ids will be propagated, if requested in the credentials request config.
diff --git a/content/docs/cli-reference/list/_index.md b/content/docs/cli-reference/list/_index.md
index cab31889..76f07d48 100644
--- a/content/docs/cli-reference/list/_index.md
+++ b/content/docs/cli-reference/list/_index.md
@@ -2,7 +2,6 @@
 title: list
 name: list
 url: /docs/cli-reference/list/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,5 +26,5 @@ ocm list []  ...
 
 ##### Sub Commands
 
-* [ocm list componentversions](/docs/cli-reference/list/componentversions)	 — list component version names
+* [ocm list componentversions](/docs/cli-reference/list/componentversions/)	 — list component version names
 
diff --git a/content/docs/cli-reference/list/list_componentversions.md b/content/docs/cli-reference/list/list_componentversions.md
index 2d8a39c5..3556096d 100644
--- a/content/docs/cli-reference/list/list_componentversions.md
+++ b/content/docs/cli-reference/list/list_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: list componentversions
 url: /docs/cli-reference/list/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -124,5 +123,5 @@ $ ocm list componentversion --repo OCIRegistry::ghcr.io mandelsoft/kubelink
 
 ### See Also
 
-* [ocm list](/docs/cli-reference/list)	 — List information about components
+* [ocm list](/docs/cli-reference/list/)	 — List information about components
 
diff --git a/content/docs/cli-reference/set/_index.md b/content/docs/cli-reference/set/_index.md
index ff940c87..baf49e71 100644
--- a/content/docs/cli-reference/set/_index.md
+++ b/content/docs/cli-reference/set/_index.md
@@ -2,7 +2,6 @@
 title: set
 name: set
 url: /docs/cli-reference/set/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,5 +26,5 @@ ocm set []  ...
 
 ##### Sub Commands
 
-* [ocm set pubsub](/docs/cli-reference/set/pubsub)	 — Set the pubsub spec for an ocm repository
+* [ocm set pubsub](/docs/cli-reference/set/pubsub/)	 — Set the pubsub spec for an ocm repository
 
diff --git a/content/docs/cli-reference/set/set_pubsub.md b/content/docs/cli-reference/set/set_pubsub.md
index ff8d7cdf..0f429403 100644
--- a/content/docs/cli-reference/set/set_pubsub.md
+++ b/content/docs/cli-reference/set/set_pubsub.md
@@ -2,7 +2,6 @@
 title: pubsub
 name: set pubsub
 url: /docs/cli-reference/set/pubsub/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -32,12 +31,12 @@ to set the pub/sub specification for a repository.
 If no specification is given an existing specification
 will be removed for the given repository.
 The specification
-can be queried with the [ocm get pubsub](/docs/cli-reference/get/pubsub).
+can be queried with the [ocm get pubsub](/docs/cli-reference/get/pubsub/).
 Types and specification formats are shown for the topic
-[ocm ocm-pubsub](/docs/cli-reference/ocm-pubsub).
+[ocm ocm-pubsub](/docs/cli-reference/help/ocm-pubsub/).
 
 
 ### See Also
 
-* [ocm set](/docs/cli-reference/set)	 — Set information about OCM repositories
+* [ocm set](/docs/cli-reference/set/)	 — Set information about OCM repositories
 
diff --git a/content/docs/cli-reference/show/_index.md b/content/docs/cli-reference/show/_index.md
index ea81e936..27ae87fa 100644
--- a/content/docs/cli-reference/show/_index.md
+++ b/content/docs/cli-reference/show/_index.md
@@ -2,7 +2,6 @@
 title: show
 name: show
 url: /docs/cli-reference/show/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,6 +26,6 @@ ocm show []  ...
 
 ##### Sub Commands
 
-* [ocm show tags](/docs/cli-reference/show/tags)	 — show dedicated tags of OCI artifacts
-* [ocm show versions](/docs/cli-reference/show/versions)	 — show dedicated versions (semver compliant)
+* [ocm show tags](/docs/cli-reference/show/tags/)	 — show dedicated tags of OCI artifacts
+* [ocm show versions](/docs/cli-reference/show/versions/)	 — show dedicated versions (semver compliant)
 
diff --git a/content/docs/cli-reference/show/show_tags.md b/content/docs/cli-reference/show/show_tags.md
index 99722e9b..d957d2b8 100644
--- a/content/docs/cli-reference/show/show_tags.md
+++ b/content/docs/cli-reference/show/show_tags.md
@@ -2,7 +2,6 @@
 title: tags
 name: show tags
 url: /docs/cli-reference/show/tags/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -75,5 +74,5 @@ $ oci show tags ghcr.io/mandelsoft/kubelink
 
 ### See Also
 
-* [ocm show](/docs/cli-reference/show)	 — Show tags or versions
+* [ocm show](/docs/cli-reference/show/)	 — Show tags or versions
 
diff --git a/content/docs/cli-reference/show/show_versions.md b/content/docs/cli-reference/show/show_versions.md
index bc283ddb..7260e85c 100644
--- a/content/docs/cli-reference/show/show_versions.md
+++ b/content/docs/cli-reference/show/show_versions.md
@@ -2,7 +2,6 @@
 title: versions
 name: show versions
 url: /docs/cli-reference/show/versions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -83,5 +82,5 @@ $ ocm show versions ghcr.io/mandelsoft/cnudie//github.com/mandelsoft/playground
 
 ### See Also
 
-* [ocm show](/docs/cli-reference/show)	 — Show tags or versions
+* [ocm show](/docs/cli-reference/show/)	 — Show tags or versions
 
diff --git a/content/docs/cli-reference/sign/_index.md b/content/docs/cli-reference/sign/_index.md
index f13fe7f9..8052e2ab 100644
--- a/content/docs/cli-reference/sign/_index.md
+++ b/content/docs/cli-reference/sign/_index.md
@@ -2,7 +2,6 @@
 title: sign
 name: sign
 url: /docs/cli-reference/sign/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,6 +26,6 @@ ocm sign []  ...
 
 ##### Sub Commands
 
-* [ocm sign componentversions](/docs/cli-reference/sign/componentversions)	 — Sign component version
-* [ocm sign hash](/docs/cli-reference/sign/hash)	 — sign hash
+* [ocm sign componentversions](/docs/cli-reference/sign/componentversions/)	 — Sign component version
+* [ocm sign hash](/docs/cli-reference/sign/hash/)	 — sign hash
 
diff --git a/content/docs/cli-reference/sign/sign_componentversions.md b/content/docs/cli-reference/sign/sign_componentversions.md
index ea800d45..bc1b790b 100644
--- a/content/docs/cli-reference/sign/sign_componentversions.md
+++ b/content/docs/cli-reference/sign/sign_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: sign componentversions
 url: /docs/cli-reference/sign/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -156,5 +155,5 @@ $ ocm sign componentversion --signature mandelsoft --private-key=mandelsoft.key
 
 ### See Also
 
-* [ocm sign](/docs/cli-reference/sign)	 — Sign components or hashes
+* [ocm sign](/docs/cli-reference/sign/)	 — Sign components or hashes
 
diff --git a/content/docs/cli-reference/sign/sign_hash.md b/content/docs/cli-reference/sign/sign_hash.md
index 3def637a..0f38f60f 100644
--- a/content/docs/cli-reference/sign/sign_hash.md
+++ b/content/docs/cli-reference/sign/sign_hash.md
@@ -2,7 +2,6 @@
 title: hash
 name: sign hash
 url: /docs/cli-reference/sign/hash/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -41,5 +40,5 @@ $ ocm sign hash key.priv SHA-256:810ff2fb242a5dee4220f2cb0e6a519891fb67f2f828a6c
 
 ### See Also
 
-* [ocm sign](/docs/cli-reference/sign)	 — Sign components or hashes
+* [ocm sign](/docs/cli-reference/sign/)	 — Sign components or hashes
 
diff --git a/content/docs/cli-reference/transfer/_index.md b/content/docs/cli-reference/transfer/_index.md
index 5b605d6f..c906b659 100644
--- a/content/docs/cli-reference/transfer/_index.md
+++ b/content/docs/cli-reference/transfer/_index.md
@@ -2,7 +2,6 @@
 title: transfer
 name: transfer
 url: /docs/cli-reference/transfer/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,8 +26,8 @@ ocm transfer []  ...
 
 ##### Sub Commands
 
-* [ocm transfer artifacts](/docs/cli-reference/transfer/artifacts)	 — transfer OCI artifacts
-* [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive)	 — transfer transport archive
-* [ocm transfer componentarchive](/docs/cli-reference/transfer/componentarchive)	 — transfer component archive to some component repository
-* [ocm transfer componentversions](/docs/cli-reference/transfer/componentversions)	 — transfer component version
+* [ocm transfer artifacts](/docs/cli-reference/transfer/artifacts/)	 — transfer OCI artifacts
+* [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive/)	 — transfer transport archive
+* [ocm transfer componentarchive](/docs/cli-reference/transfer/componentarchive/)	 — transfer component archive to some component repository
+* [ocm transfer componentversions](/docs/cli-reference/transfer/componentversions/)	 — transfer component version
 
diff --git a/content/docs/cli-reference/transfer/transfer_artifacts.md b/content/docs/cli-reference/transfer/transfer_artifacts.md
index 3a6b3468..57aebca9 100644
--- a/content/docs/cli-reference/transfer/transfer_artifacts.md
+++ b/content/docs/cli-reference/transfer/transfer_artifacts.md
@@ -2,7 +2,6 @@
 title: artifacts
 name: transfer artifacts
 url: /docs/cli-reference/transfer/artifacts/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -91,5 +90,5 @@ $ ocm oci artifact transfer /tmp/ctf gcr.io/my-project
 
 ### See Also
 
-* [ocm transfer](/docs/cli-reference/transfer)	 — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/)	 — Transfer artifacts or components
 
diff --git a/content/docs/cli-reference/transfer/transfer_commontransportarchive.md b/content/docs/cli-reference/transfer/transfer_commontransportarchive.md
index be21b7ab..b1767fe9 100644
--- a/content/docs/cli-reference/transfer/transfer_commontransportarchive.md
+++ b/content/docs/cli-reference/transfer/transfer_commontransportarchive.md
@@ -2,7 +2,6 @@
 title: commontransportarchive
 name: transfer commontransportarchive
 url: /docs/cli-reference/transfer/commontransportarchive/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -162,7 +161,7 @@ The uploader name may be a path expression with the following possibilities:
 
 
 
-See [ocm ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) for further details on using
+See [ocm ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) for further details on using
 upload handlers.
 
 
@@ -196,5 +195,5 @@ $ ocm transfer ctf ctf.tgz ghcr.io/mandelsoft/components
 
 ### See Also
 
-* [ocm transfer](/docs/cli-reference/transfer)	 — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/)	 — Transfer artifacts or components
 
diff --git a/content/docs/cli-reference/transfer/transfer_componentarchive.md b/content/docs/cli-reference/transfer/transfer_componentarchive.md
index 701ba0fa..a08cd844 100644
--- a/content/docs/cli-reference/transfer/transfer_componentarchive.md
+++ b/content/docs/cli-reference/transfer/transfer_componentarchive.md
@@ -2,7 +2,6 @@
 title: componentarchive
 name: transfer componentarchive
 url: /docs/cli-reference/transfer/componentarchive/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -94,5 +93,5 @@ with the script option family.
 
 ### See Also
 
-* [ocm transfer](/docs/cli-reference/transfer)	 — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/)	 — Transfer artifacts or components
 
diff --git a/content/docs/cli-reference/transfer/transfer_componentversions.md b/content/docs/cli-reference/transfer/transfer_componentversions.md
index cfd8e291..99910225 100644
--- a/content/docs/cli-reference/transfer/transfer_componentversions.md
+++ b/content/docs/cli-reference/transfer/transfer_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: transfer componentversions
 url: /docs/cli-reference/transfer/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -219,7 +218,7 @@ The uploader name may be a path expression with the following possibilities:
 
 
 
-See [ocm ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) for further details on using
+See [ocm ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) for further details on using
 upload handlers.
 
 
@@ -254,5 +253,5 @@ $ ocm transfer components -t tgz --repo OCIRegistry::ghcr.io mandelsoft/kubelink
 
 ### See Also
 
-* [ocm transfer](/docs/cli-reference/transfer)	 — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/)	 — Transfer artifacts or components
 
diff --git a/content/docs/cli-reference/verify/_index.md b/content/docs/cli-reference/verify/_index.md
index 79010377..7a5d89f6 100644
--- a/content/docs/cli-reference/verify/_index.md
+++ b/content/docs/cli-reference/verify/_index.md
@@ -2,7 +2,6 @@
 title: verify
 name: verify
 url: /docs/cli-reference/verify/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -27,5 +26,5 @@ ocm verify []  ...
 
 ##### Sub Commands
 
-* [ocm verify componentversions](/docs/cli-reference/verify/componentversions)	 — Verify signature of component version
+* [ocm verify componentversions](/docs/cli-reference/verify/componentversions/)	 — Verify signature of component version
 
diff --git a/content/docs/cli-reference/verify/verify_componentversions.md b/content/docs/cli-reference/verify/verify_componentversions.md
index 3d92a63f..5fcd6b68 100644
--- a/content/docs/cli-reference/verify/verify_componentversions.md
+++ b/content/docs/cli-reference/verify/verify_componentversions.md
@@ -2,7 +2,6 @@
 title: componentversions
 name: verify componentversions
 url: /docs/cli-reference/verify/componentversions/
-date: 2024-04-17T18:02:57+02:00
 draft: false
 images: []
 toc: true
@@ -131,5 +130,5 @@ $ ocm verify componentversion --signature mandelsoft --public-key=mandelsoft.key
 
 ### See Also
 
-* [ocm verify](/docs/cli-reference/verify)	 — Verify component version signatures
+* [ocm verify](/docs/cli-reference/verify/)	 — Verify component version signatures