Fix broken links (#476)

<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it
Fix broken external and internal links. Convert all external links to
own ocm.software website back to internal links as in the future we can
use [htmltest](https://github.com/wjdp/htmltest/tree/master) to test
both external and internal links. GH action replacing current HTML
verify comes with next PR.

---------

Signed-off-by: Gerald Morrison (SAP) <[email protected]>
Co-authored-by: Gerald Morrison (SAP) <[email protected]>

Author: morri-son

.github/config/wordlist.txt

@@ -73,6 +73,7 @@ crd
 creationtime
 credentialrequest
 credentialsspec
+creds
 crossplatform
 crypto
 cryptographic
@@ -406,4 +407,4 @@ yaml
 yitsushi
 yml
 yy
-yyyy
+yyyy

config/_default/menus/menus.en.toml

@@ -5,7 +5,7 @@
 
 [[main]]
   name = "Community"
-  url = "/community"
+  url = "/community/community"
   weight = 20
 
 [[main]]

content/community/_index.md

@@ -1,7 +1,7 @@
 ---
 title : "Community"
 layout: community
-description: "Community"
+url: "/community/"
 weight: 90
 lead: ""
 draft: false

content/community/call_history.md

@@ -1,6 +1,6 @@
 ---
 title: "Community Calls History"
-description: "Community Calls History"
+url: /community/call_history/
 lead: true
 draft: false
 images: []

content/community/community.md

@@ -1,7 +1,7 @@
 ---
 title: "The OCM Community"
 description: "The OCM Community"
-url: community
+url: "/community/community/"
 lead: true
 draft: false
 images: []
@@ -86,7 +86,7 @@ To see all announcements and join the group, please visit the [OCM Announcements
 #### Recordings and Slides
 
 All calls will be recorded and uploaded publicly to the [OCM YouTube channel](https://www.youtube.com/@OpenComponentModel).
-Slides and agenda from prior community calls are stored [here](https://ocm.software/community/community-calls-history/).
+Slides and agenda from prior community calls are stored [here](/community/call_history/).
 
 {{<callout context="note" title="Meeting Recordings">}}If you do not consent to being recorded, please do not enable your microphone or camera, or do not join the meetings.{{</callout>}}
 

content/docs/controller/ocm-controller-api.md

@@ -35,7 +35,7 @@ Resource Types:
 <td>
 <code>metadata</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -468,7 +468,7 @@ string
 <td>
 <code>metadata</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -708,7 +708,7 @@ github.com/open-component-model/ocm/pkg/contexts/ocm/compdesc/meta/v1.Labels
 <td>
 <code>metadata</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -773,7 +773,7 @@ github.com/fluxcd/kustomize-controller/api/v1beta2.KustomizationSpec
 <td>
 <code>helmReleaseTemplate</code><br>
 <em>
-<a href="https://pkg.go.dev/github.com/fluxcd/helm-controller/api/v2betapkg1#HelmReleaseSpec">
+<a href="https://pkg.go.dev/github.com/fluxcd/helm-controller/api/v2#HelmReleaseSpec">
 github.com/fluxcd/helm-controller/api/v2beta1.HelmReleaseSpec
 </a>
 </em>
@@ -860,7 +860,7 @@ github.com/fluxcd/kustomize-controller/api/v1beta2.KustomizationSpec
 <td>
 <code>helmReleaseTemplate</code><br>
 <em>
-<a href="https://pkg.go.dev/github.com/fluxcd/helm-controller/api/v2betapkg1#HelmReleaseSpec">
+<a href="https://pkg.go.dev/github.com/fluxcd/helm-controller/api/v2#HelmReleaseSpec">
 github.com/fluxcd/helm-controller/api/v2beta1.HelmReleaseSpec
 </a>
 </em>
@@ -1011,7 +1011,7 @@ string
 <td>
 <code>metadata</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -1581,7 +1581,7 @@ string
 <td>
 <code>secretRef</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#localobjectreference-v1-core">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -1759,7 +1759,7 @@ MUST NOT CONTAIN THE SCHEME.</p>
 <td>
 <code>secretRef</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#localobjectreference-v1-core">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -1790,7 +1790,7 @@ Kubernetes core/v1.LocalObjectReference
 <td>
 <code>metadata</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -1887,7 +1887,7 @@ ResourceStatus
 <td>
 <code>metadata</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -2644,7 +2644,7 @@ Kubernetes meta/v1.Duration
 <td>
 <code>metadata</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -3017,7 +3017,7 @@ string
 <td>
 <code>secretRef</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#localobjectreference-v1-core">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>

content/docs/getting-started/component-descriptor-example.md

@@ -1,5 +1,6 @@
 ---
 title: "Example of a component descriptor"
+url: "/docs/getting-started/component-descriptor-example/"
 description: ""
 lead: ""
 draft: false

content/docs/getting-started/create-component-version.md

@@ -1,5 +1,6 @@
 ---
 title: "Create a Component Version"
+url: "/docs/getting-started/create-component-version/"
 description: ""
 lead: ""
 draft: false
@@ -39,7 +40,7 @@ helm pull --untar podinfo/podinfo
 
 Create a file `component-constructor.yaml`, which describes all elements of the component. You can use our public configuration schema to validate the configuration. The schema is available at `https://ocm.software/schemas/configuration-schema.yaml` and can be used in your editor to validate the configuration (e.g., in Visual Studio Code).
 
-Component versions need to have at least a `name`, `version` and `provider` attribute. All other attributes are optional. Check out an [example component descriptor](https://ocm.software/docs/component-descriptors/version-2) or the [OCM Specification](https://github.com/open-component-model/ocm-spec/blob/main/README.md) to see all available attributes.
+Component versions need to have at least a `name`, `version` and `provider` attribute. All other attributes are optional. Check out an [example component descriptor](/docs/getting-started/component-descriptor-example/) or the [OCM Specification](https://github.com/open-component-model/ocm-spec/blob/main/README.md) to see all available attributes.
 
 As mentioned before our example component will just contain a Helm Chart and a Docker image as resources:
 
@@ -77,9 +78,9 @@ The type field is used to specify the kind of access.
 If the resource content is taken from local resources, the field `input` is used to specify
 the access to the local resources. Similarly to the `access` attribute, the kind of the input source is described by the field `type`.
 
-Available access and input types are described [here](https://ocm.software/docs/tutorials/input-and-access-types).
+Available access and input types are described [here](/docs/tutorials/input-and-access-types/).
 
-For more complex scenarios, the description files might use variable substitution (templating), see [Best Practices](/docs/tutorials/best-practices#templating-the-resources).
+For more complex scenarios, the description files might use variable substitution (templating), see [Best Practices](/docs/tutorials/best-practices/#templating-the-resources).
 
 ### Add Component Version to CTF archive
 

content/docs/getting-started/installation.md

@@ -1,5 +1,6 @@
 ---
 title: "Installing the OCM CLI"
+url: "/docs/getting-started/installation/"
 description: ""
 lead: ""
 draft: false
@@ -58,7 +59,6 @@ see: [Flakes](https://nixos.wiki/wiki/Flakes)
 
 ## Install from AUR (Arch Linux User Repository)
 
-[git-url](https://aur.archlinux.org/ocm-cli.git)  
 [package-url](https://aur.archlinux.org/packages/ocm-cli)
 
 ```shell

content/docs/getting-started/prerequisites.md

@@ -1,5 +1,6 @@
 ---
 title: "Prerequisites"
+url: /docs/getting-started/prerequisites/
 description: ""
 lead: ""
 draft: false
@@ -15,7 +16,7 @@ To follow the steps described in this section, you will need to:
 
 ## Install the OCM Command Line Interface (CLI)
 
-The CLI is used to interact with component versions and registries. Install it like described in [Installing the OCM CLI](https://ocm.software/docs/getting-started/installing-the-ocm-cli).
+The CLI is used to interact with component versions and registries. Install it like described in [Installing the OCM CLI](/docs/getting-started/installation/).
 
 ## Obtain Access to an OCM Repository
 
@@ -64,4 +65,4 @@ configurations:
 ```
 
 More information on the credentials topic can be seen by running the OCM CLI help topic command `ocm credential-handling`
-and [in this guide](https://ocm.software/docs/examples/credentials-in-an-ocmconfig-file/) with many examples for different repository types.
+and [in this guide](/docs/tutorials/creds-in-ocmconfig/) with many examples for different repository types.

content/docs/getting-started/sign-component-versions.md

@@ -18,7 +18,7 @@ component version is used for signing. See [Signing Process and Normalization](h
 Currently, only signing according to the
 [RSA PKCS #1 v1.5 signature algorithm](https://datatracker.ietf.org/doc/html/rfc3447) is supported.
 
-To follow the examples, one must follow the instructions from the section [Create a Component Version](https://ocm.software/docsgetting-started/getting-started-with-ocm/create-a-component-version).
+To follow the examples, one must follow the instructions from the section [Create a Component Version](/docs/getting-started/create-component-version/).
 
 Create a key pair using the OCM CLI:
 

content/docs/getting-started/transport-component-versions.md

@@ -8,7 +8,7 @@ weight: 26
 toc: true
 ---
 
-The section [Bundle Composed Components](https://ocm.software/docs/getting-started/getting-started-with-ocm/create-a-component-version#bundle-composed-components) explained how to bundle multiple component version into a transport archive.
+The section [Add Component Version to CTF archive](/docs/getting-started/create-component-version/#add-component-version-to-ctf-archive/) explained how to store component versions in a CTF archive.
 
 During the transfer, it is possible to include component references as local blobs. It is also possible to include references in a recursive way.
 

content/docs/tutorials/best-practices-with-ocm.md renamed to content/docs/tutorials/best-practices.md

@@ -27,7 +27,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](/schemas/configuration-schema.yaml).
+This schema is available at [https://ocm.software/schemas/configuration-schema.yaml](https://ocm.software/schemas/configuration-schema.yaml).
 
 To use this schema in your IDE, you can add the following line to your component constructor file:
 
@@ -336,7 +336,7 @@ example can be found in the sample Github repository.
 
 ## Static and Dynamic Variable Substitution
 
-Looking at the [settings file](https://ocm.software/docs/tutorials/build-deploy-applications-using-helm-charts-and-ocm/#building-the-common-transport-archive-ctf) shows that
+Looking at the [settings file](/docs/tutorials/build-deploy-applications-using-helm-charts-and-ocm/#building-the-common-transport-archive-ctf) shows that
 some variables like the `version` or the `commit` change with every build
 or release. In many cases, these variables will be auto-generated during the build.
 

content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md

@@ -123,7 +123,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:

content/docs/tutorials/complex-component-structure-deployment.md

@@ -9,16 +9,16 @@ toc: true
 
 ## Introduction
 
-In this tutorial software products are comprised of logical units called [**components**](https://ocm.software/docs/overview/important-terms/#components-in-ocm). A component version consists of a set of technical [artifacts](https://github.com/open-component-model/ocm-spec/blob/main/doc/04-extensions/01-artifact-types/README.md) (e.g., Docker images, Helm charts, binaries, configuration data, etc.). Such artifacts are called **resources** in this specification. Resources are usually built from something, e.g., code in a git repo. Those are named **sources** in this specification.
+In this tutorial software products are comprised of logical units called [*components*](/docs/overview/important-terms/#components-in-ocm). A component version consists of a set of technical [*artifacts*](https://github.com/open-component-model/ocm-spec/blob/main/doc/04-extensions/01-artifact-types/README.md) (e.g., Docker images, Helm charts, binaries, configuration data, etc.). Such artifacts are called *resources* in this specification. Resources are usually built from something, e.g., code in a git repo. Those are named *sources* in this specification.
 
-OCM introduces a **Component Version** for every component version that
+OCM introduces a *Component Version* for every component version that
 describes the resources, sources, and other component versions belonging to a particular
 component version and how to access them.
 
 Usually, however, real-life applications are composed of multiple components. For
 example, an application might consist of a frontend, a backend, a database, and a web server.
 During the software development process new
-[**component versions**](https://github.com/open-component-model/ocm-spec/blob/main/doc/01-model/02-elements-toplevel.md#components-and-component-versions)
+[*component versions*](https://github.com/open-component-model/ocm-spec/blob/main/doc/01-model/02-elements-toplevel.md#components-and-component-versions)
 are created and third-party components might be consumed from a public registry and
 updated from time to time.
 
@@ -44,7 +44,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/) section, as this guide discusses a more complex scenario.
+We assume that you have already read the guides in the [Getting Started](/docs/getting-started/) section, as this guide discusses a more complex scenario.
 
 ## Constructing the Component
 

content/docs/tutorials/creds-in-ocmconfig.md

@@ -1,7 +1,6 @@
 ---
-title: "Credentials in .ocmconfig file"
-description: ""
-summary: ""
+Title: "Credentials in .ocmconfig file"
+url: "/docs/tutorials/creds-in-ocmconfig"
 draft: false
 weight: 72
 toc: true

content/docs/tutorials/input_and_access.md renamed to content/docs/tutorials/input-and-access-types.md

@@ -1,5 +1,6 @@
 ---
 title: "Input and Access Types"
+url: /docs/tutorials/input-and-access-types/
 draft: false
 weight: 68
 toc: true

content/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-and-flux.md

@@ -257,7 +257,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](/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications) guide to see how you can use the `ocm-controller` to configure your 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 you can use the `ocm-controller` to configure your application at runtime and solve exactly this kind of problem!
 
 ### Conclusion
 

content/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-and-gitops.md

@@ -20,7 +20,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/prerequisites/).
 
 ## Table of Contents
 
@@ -214,5 +214,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 our other guides on this topic:
 
-- [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/)

layouts/index.html

@@ -72,7 +72,7 @@ <h3 class="h3 text-default">{{ .title }}</h3>
       {{ end }}
     </div>
     <div class="text-center mt-4">
-      <a class="btn btn-primary btn-lg rounded-pill px-5" href="docs/tutorials/ocm-and-gitops" role="button">
+      <a class="btn btn-primary btn-lg rounded-pill px-5" href="/docs/tutorials/ocm-and-gitops/" role="button">
         {{ .Params.how_ocm_cta }}
       </a>
     </div>