Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/docs/getting-started/create-component-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,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](/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.
Component versions need to have at least a `name`, `version` and `provider` attribute. All other attributes are optional. Check out an [example component descriptor]({{< relref "docs/tutorials/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:

Expand Down Expand Up @@ -76,9 +76,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](/docs/tutorials/input-and-access-types/).
Available access and input types are described [here]({{< relref "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]({{< relref "docs/tutorials/best-practices#templating-the-resources" >}}).

### Add Component Version to CTF archive

Expand Down
6 changes: 3 additions & 3 deletions content/docs/getting-started/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,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](/docs/getting-started/installation/).
The CLI is used to interact with component versions and registries. Install it like described in [Installing the OCM CLI]({{< relref "docs/getting-started/ocm-cli-installation" >}}).

## Obtain Access to an OCM Repository

Expand Down Expand Up @@ -50,7 +50,7 @@ Alternatively, you can use basic authentication. Create a file named `.ocmconfig
```yaml
type: generic.config.ocm.software/v1
configurations:
- type: credentials.config.ocm.software
- type: credentials.config.ocm.software
consumers:
- identity:
type: ociRegistry
Expand All @@ -63,4 +63,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](/docs/tutorials/creds-in-ocmconfig/) with many examples for different repository types.
and [in this guide]({{< relref "docs/tutorials/creds-in-ocmconfig" >}}) with many examples for different repository types.
2 changes: 1 addition & 1 deletion content/docs/getting-started/sign-component-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,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](/docs/getting-started/create-component-version/).
To follow the examples, one must follow the instructions from the section [Create a Component Version]({{< relref "docs/getting-started/create-component-version" >}}).

Create a key pair using the OCM CLI:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 26
toc: true
---

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.
The section [Add Component Version to CTF archive]({{< relref "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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,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](/docs/getting-started/) section, as this guide discusses a more complex scenario.
We assume that you have already read the guides in the [Getting Started]({{< relref "docs/getting-started" >}}) section, as this guide discusses a more complex scenario.

## Constructing the Component

Expand Down
4 changes: 2 additions & 2 deletions layouts/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ <h2 class="h2 font-italic mb-5 mt-0 text-muted">{{ .Params.subheadline }}</h2>
<p class="lead mb-2 text-default">{{ .Params.intro1 }}</p>
<p class="lead mb-2 text-default"><strong>{{ .Params.intro2 }}</strong></p>
<p class="lead mb-5 text-default">{{ .Params.intro3 }}</p>
<a class="btn btn-primary btn-lg rounded-pill px-5 mb-6" href="/docs/getting-started/" role="button">{{ .Params.cta_text }}</a>
<a class="btn btn-primary btn-lg rounded-pill px-5 mb-6" href="{{ ref . "docs/getting-started/" }}" role="button">{{ .Params.cta_text }}</a>
</section>
</div>
</div>
Expand All @@ -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="{{ ref . "docs/tutorials/" }}" role="button">
{{ .Params.how_ocm_cta }}
</a>
</div>
Expand Down