Skip to content

Commit

Permalink
update absolute links to docs pages to ref shortcodes
Browse files Browse the repository at this point in the history
Signed-off-by: Pete Lumbis <pete@upbound.io>
  • Loading branch information
plumbis committed Apr 16, 2024
1 parent 17d910c commit 9c5de44
Show file tree
Hide file tree
Showing 14 changed files with 61 additions and 61 deletions.
4 changes: 2 additions & 2 deletions content/master/concepts/providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -593,12 +593,12 @@ replacement for Controller configuration and is available in v1.14+.

Applying a Crossplane `ControllerConfig` to a Provider changes the settings of
the Provider's pod. The
[Crossplane ControllerConfig schema](https://doc.crds.dev/github.com/crossplane/crossplane/pkg.crossplane.io/ControllerConfig/v1alpha1)
[Crossplane ControllerConfig schema]({{< ref "../api#ControllerConfig-spec" >}})
defines the supported set of ControllerConfig settings.

The most common use case for ControllerConfigs are providing `args` to a
Provider's pod enabling optional services. For example, enabling
[external secret stores](https://docs.crossplane.io../guides/vault-as-secret-store/#enable-external-secret-stores-in-the-provider)
[external secret stores]({{< ref "../guides/vault-as-secret-store#enable-external-secret-stores-in-the-provider" >}})
for a Provider.

Each Provider determines their supported set of `args`.
Expand Down
14 changes: 7 additions & 7 deletions content/master/guides/write-a-composition-function-in-go.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Composition functions (or just functions, for short) are custom programs that
template Crossplane resources. Crossplane calls composition functions to
determine what resources it should create when you create a composite resource
(XR). Read the
[concepts](https://docs.crossplane.io/latest/concepts/composition-functions)
[concepts]{{<ref "../concepts/composition-functions" >}}
page to learn more about composition functions.

You can write a function to template resources using a general purpose
Expand All @@ -22,7 +22,7 @@ conditionals. This guide explains how to write a composition function in

{{< hint "important" >}}
It helps to be familiar with
[how composition functions work](https://docs.crossplane.io/latest/concepts/composition-functions#how-composition-functions-work)
[how composition functions work]{{<ref "../concepts/composition-functions#how-composition-functions-work" >}}
before following this guide.
{{< /hint >}}

Expand Down Expand Up @@ -69,7 +69,7 @@ To write a function in Go you need:

* [Go](https://go.dev/dl/) v1.21 or newer. The guide uses Go v1.21.
* [Docker Engine](https://docs.docker.com/engine/). This guide uses Engine v24.
* The [Crossplane CLI](https://docs.crossplane.io/latest/cli) v1.14 or newer. This guide uses Crossplane
* The [Crossplane CLI]({{<ref "../cli" >}}) v1.14 or newer. This guide uses Crossplane
CLI v1.14.

{{<hint "note">}}
Expand Down Expand Up @@ -134,7 +134,7 @@ should delete the `input` and `package/input` directories.

The `input` directory defines a Go struct that a function can use to take input,
using the `input` field from a Composition. The
[composition functions](https://docs.crossplane.io/latest/concepts/composition-functions)
[composition functions]{{<ref "../concepts/composition-functions" >}}
documentation explains how to pass an input to a composition function.

The `package/input` directory contains an OpenAPI schema generated from the
Expand Down Expand Up @@ -740,7 +740,7 @@ spec:

{{<hint "tip">}}
Read the composition functions documentation to learn more about
[testing composition functions](https://docs.crossplane.io/latest/concepts/composition-functions#test-a-composition-that-uses-functions).
[testing composition functions]({{< ref "../concepts/composition-functions#test-a-composition-that-uses-functions" >}}).
{{</hint>}}

## Build and push the function to a package registry
Expand All @@ -757,7 +757,7 @@ then pushing all the packages to a single tag in the registry.

Pushing your function to a registry allows you to use your function in a
Crossplane control plane. See the
[composition functions documentation](https://docs.crossplane.io/latest/concepts/composition-functions).
[composition functions documentation]{{<ref "../concepts/composition-functions" >}}.
to learn how to use a function in a control plane.

Use Docker to build a runtime for each platform.
Expand Down Expand Up @@ -808,7 +808,7 @@ crossplane xpkg build \

{{<hint "tip">}}
Crossplane packages are special OCI images. Read more about packages in the
[packages documentation](https://docs.crossplane.io/latest/concepts/packages).
[packages documentation]({{< ref "../concepts/packages" >}}).
{{</hint>}}

Push both package files to a registry. Pushing both files to one tag in the
Expand Down
14 changes: 7 additions & 7 deletions content/master/guides/write-a-composition-function-in-python.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Composition functions (or just functions, for short) are custom programs that
template Crossplane resources. Crossplane calls composition functions to
determine what resources it should create when you create a composite resource
(XR). Read the
[concepts](https://docs.crossplane.io/latest/concepts/composition-functions)
[concepts]{{<ref "../concepts/composition-functions" >}}
page to learn more about composition functions.

You can write a function to template resources using a general purpose
Expand All @@ -22,7 +22,7 @@ conditionals. This guide explains how to write a composition function in

{{< hint "important" >}}
It helps to be familiar with
[how composition functions work](https://docs.crossplane.io/latest/concepts/composition-functions#how-composition-functions-work)
[how composition functions work]{{<ref "../concepts/composition-functions#how-composition-functions-work" >}}
before following this guide.
{{< /hint >}}

Expand Down Expand Up @@ -70,7 +70,7 @@ To write a function in Python you need:
* [Python](https://www.python.org/downloads/) v3.11.
* [Hatch](https://hatch.pypa.io/), a Python build tool. This guide uses v1.7.
* [Docker Engine](https://docs.docker.com/engine/). This guide uses Engine v24.
* The [Crossplane CLI](https://docs.crossplane.io/latest/cli) v1.14 or newer. This guide uses Crossplane
* The [Crossplane CLI]({{<ref "../cli" >}}) v1.14 or newer. This guide uses Crossplane
CLI v1.14.

{{<hint "note">}}
Expand Down Expand Up @@ -132,7 +132,7 @@ The `package/input` directory defines the OpenAPI schema for the a function's
input. The function in this guide doesn't accept an input. Delete the
`package/input` directory.

The [composition functions](https://docs.crossplane.io/latest/concepts/composition-functions)
The [composition functions]{{<ref "../concepts/composition-functions" >}}
documentation explains composition function inputs.

{{<hint "tip">}}
Expand Down Expand Up @@ -639,7 +639,7 @@ spec:

{{<hint "tip">}}
Read the composition functions documentation to learn more about
[testing composition functions](https://docs.crossplane.io/latest/concepts/composition-functions#test-a-composition-that-uses-functions).
[testing composition functions]({{< ref "../concepts/composition-functions#test-a-composition-that-uses-functions" >}}).
{{</hint>}}

## Build and push the function to a package registry
Expand All @@ -656,7 +656,7 @@ then pushing all the packages to a single tag in the registry.

Pushing your function to a registry allows you to use your function in a
Crossplane control plane. See the
[composition functions documentation](https://docs.crossplane.io/latest/concepts/composition-functions).
[composition functions documentation]{{<ref "../concepts/composition-functions" >}}.
to learn how to use a function in a control plane.

Use Docker to build a runtime for each platform.
Expand Down Expand Up @@ -715,7 +715,7 @@ crossplane xpkg build \

{{<hint "tip">}}
Crossplane packages are special OCI images. Read more about packages in the
[packages documentation](https://docs.crossplane.io/latest/concepts/packages).
[packages documentation]({{< ref "../concepts/packages" >}}).
{{</hint>}}

Push both package files to a registry. Pushing both files to one tag in the
Expand Down
2 changes: 1 addition & 1 deletion content/master/software/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ For example, in v1.15.0 Crossplane changed the default image registry from
before v1.15.0 updates the default package registry.

Override new defaults by
[customizing the Helm chart](https://docs.crossplane.io/v1.15/software/install/#customize-the-crossplane-helm-chart)
[customizing the Helm chart]({{<ref "install#customize-the-crossplane-helm-chart" >}})
with the upgrade command.

For example, to maintain the original image registry use
Expand Down
2 changes: 1 addition & 1 deletion content/v1.13/concepts/providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ defines the supported set of ControllerConfig settings.

The most common use case for ControllerConfigs are providing `args` to a
Provider's pod enabling optional services. For example, enabling
[external secret stores](https://docs.crossplane.io../guides/vault-as-secret-store/#enable-external-secret-stores-in-the-provider)
[external secret stores]({{< ref "../guides/vault-as-secret-store#enable-external-secret-stores-in-the-provider" >}})
for a Provider.

Each Provider determines their supported set of `args`.
Expand Down
10 changes: 5 additions & 5 deletions content/v1.13/guides/write-a-composition-function-in-go.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Composition functions (or just functions, for short) are custom programs that
template Crossplane resources. Crossplane calls composition functions to
determine what resources it should create when you create a composite resource
(XR). Read the
[concepts](https://docs.crossplane.io/latest/concepts/composition-functions)
[concepts]{{<ref "../concepts/composition-functions" >}}
page to learn more about composition functions.

You can write a function to template resources using a general purpose
Expand All @@ -22,7 +22,7 @@ conditionals. This guide explains how to write a composition function in

{{< hint "important" >}}
It helps to be familiar with
[how composition functions work](https://docs.crossplane.io/latest/concepts/composition-functions#how-composition-functions-work)
[how composition functions work]{{<ref "../concepts/composition-functions#how-composition-functions-work" >}}
before following this guide.
{{< /hint >}}

Expand Down Expand Up @@ -134,7 +134,7 @@ should delete the `input` and `package/input` directories.

The `input` directory defines a Go struct that a function can use to take input,
using the `input` field from a Composition. The
[composition functions](https://docs.crossplane.io/latest/concepts/composition-functions)
[composition functions]{{<ref "../concepts/composition-functions" >}}
documentation explains how to pass an input to a composition function.

The `package/input` directory contains an OpenAPI schema generated from the
Expand Down Expand Up @@ -757,7 +757,7 @@ then pushing all the packages to a single tag in the registry.

Pushing your function to a registry allows you to use your function in a
Crossplane control plane. See the
[composition functions documentation](https://docs.crossplane.io/latest/concepts/composition-functions).
[composition functions documentation]{{<ref "../concepts/composition-functions" >}}.
to learn how to use a function in a control plane.

Use Docker to build a runtime for each platform.
Expand Down Expand Up @@ -808,7 +808,7 @@ crossplane xpkg build \

{{<hint "tip">}}
Crossplane packages are special OCI images. Read more about packages in the
[packages documentation](https://docs.crossplane.io/latest/concepts/packages).
[packages documentation]({{< ref "../concepts/packages" >}}).
{{</hint>}}

Push both package files to a registry. Pushing both files to one tag in the
Expand Down
10 changes: 5 additions & 5 deletions content/v1.13/guides/write-a-composition-function-in-python.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Composition functions (or just functions, for short) are custom programs that
template Crossplane resources. Crossplane calls composition functions to
determine what resources it should create when you create a composite resource
(XR). Read the
[concepts](https://docs.crossplane.io/latest/concepts/composition-functions)
[concepts]{{<ref "../concepts/composition-functions" >}}
page to learn more about composition functions.

You can write a function to template resources using a general purpose
Expand All @@ -22,7 +22,7 @@ conditionals. This guide explains how to write a composition function in

{{< hint "important" >}}
It helps to be familiar with
[how composition functions work](https://docs.crossplane.io/latest/concepts/composition-functions#how-composition-functions-work)
[how composition functions work]{{<ref "../concepts/composition-functions#how-composition-functions-work" >}}
before following this guide.
{{< /hint >}}

Expand Down Expand Up @@ -132,7 +132,7 @@ The `package/input` directory defines the OpenAPI schema for the a function's
input. The function in this guide doesn't accept an input. Delete the
`package/input` directory.

The [composition functions](https://docs.crossplane.io/latest/concepts/composition-functions)
The [composition functions]{{<ref "../concepts/composition-functions" >}}
documentation explains composition function inputs.

{{<hint "tip">}}
Expand Down Expand Up @@ -656,7 +656,7 @@ then pushing all the packages to a single tag in the registry.

Pushing your function to a registry allows you to use your function in a
Crossplane control plane. See the
[composition functions documentation](https://docs.crossplane.io/latest/concepts/composition-functions).
[composition functions documentation]{{<ref "../concepts/composition-functions" >}}.
to learn how to use a function in a control plane.

Use Docker to build a runtime for each platform.
Expand Down Expand Up @@ -715,7 +715,7 @@ crossplane xpkg build \

{{<hint "tip">}}
Crossplane packages are special OCI images. Read more about packages in the
[packages documentation](https://docs.crossplane.io/latest/concepts/packages).
[packages documentation]({{< ref "../concepts/packages" >}}).
{{</hint>}}

Push both package files to a registry. Pushing both files to one tag in the
Expand Down
4 changes: 2 additions & 2 deletions content/v1.14/concepts/providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -584,12 +584,12 @@ replacement for Controller configuration and is available in v1.14+.

Applying a Crossplane `ControllerConfig` to a Provider changes the settings of
the Provider's pod. The
[Crossplane ControllerConfig schema](https://doc.crds.dev/github.com/crossplane/crossplane/pkg.crossplane.io/ControllerConfig/v1alpha1)
[Crossplane ControllerConfig schema]({{< ref "../api#ControllerConfig-spec" >}})
defines the supported set of ControllerConfig settings.

The most common use case for ControllerConfigs are providing `args` to a
Provider's pod enabling optional services. For example, enabling
[external secret stores](https://docs.crossplane.io../guides/vault-as-secret-store/#enable-external-secret-stores-in-the-provider)
[external secret stores]({{< ref "../guides/vault-as-secret-store#enable-external-secret-stores-in-the-provider" >}})
for a Provider.

Each Provider determines their supported set of `args`.
Expand Down
14 changes: 7 additions & 7 deletions content/v1.14/guides/write-a-composition-function-in-go.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Composition functions (or just functions, for short) are custom programs that
template Crossplane resources. Crossplane calls composition functions to
determine what resources it should create when you create a composite resource
(XR). Read the
[concepts](https://docs.crossplane.io/latest/concepts/composition-functions)
[concepts]{{<ref "../concepts/composition-functions" >}}
page to learn more about composition functions.

You can write a function to template resources using a general purpose
Expand All @@ -22,7 +22,7 @@ conditionals. This guide explains how to write a composition function in

{{< hint "important" >}}
It helps to be familiar with
[how composition functions work](https://docs.crossplane.io/latest/concepts/composition-functions#how-composition-functions-work)
[how composition functions work]{{<ref "../concepts/composition-functions#how-composition-functions-work" >}}
before following this guide.
{{< /hint >}}

Expand Down Expand Up @@ -69,7 +69,7 @@ To write a function in Go you need:

* [Go](https://go.dev/dl/) v1.21 or newer. The guide uses Go v1.21.
* [Docker Engine](https://docs.docker.com/engine/). This guide uses Engine v24.
* The [Crossplane CLI](https://docs.crossplane.io/latest/cli) v1.14 or newer. This guide uses Crossplane
* The [Crossplane CLI]({{<ref "../cli" >}}) v1.14 or newer. This guide uses Crossplane
CLI v1.14.

{{<hint "note">}}
Expand Down Expand Up @@ -134,7 +134,7 @@ should delete the `input` and `package/input` directories.

The `input` directory defines a Go struct that a function can use to take input,
using the `input` field from a Composition. The
[composition functions](https://docs.crossplane.io/latest/concepts/composition-functions)
[composition functions]{{<ref "../concepts/composition-functions" >}}
documentation explains how to pass an input to a composition function.

The `package/input` directory contains an OpenAPI schema generated from the
Expand Down Expand Up @@ -740,7 +740,7 @@ spec:

{{<hint "tip">}}
Read the composition functions documentation to learn more about
[testing composition functions](https://docs.crossplane.io/latest/concepts/composition-functions#test-a-composition-that-uses-functions).
[testing composition functions]({{< ref "../concepts/composition-functions#test-a-composition-that-uses-functions" >}}).
{{</hint>}}

## Build and push the function to a package registry
Expand All @@ -757,7 +757,7 @@ then pushing all the packages to a single tag in the registry.

Pushing your function to a registry allows you to use your function in a
Crossplane control plane. See the
[composition functions documentation](https://docs.crossplane.io/latest/concepts/composition-functions).
[composition functions documentation]{{<ref "../concepts/composition-functions" >}}.
to learn how to use a function in a control plane.

Use Docker to build a runtime for each platform.
Expand Down Expand Up @@ -808,7 +808,7 @@ crossplane xpkg build \

{{<hint "tip">}}
Crossplane packages are special OCI images. Read more about packages in the
[packages documentation](https://docs.crossplane.io/latest/concepts/packages).
[packages documentation]({{< ref "../concepts/packages" >}}).
{{</hint>}}

Push both package files to a registry. Pushing both files to one tag in the
Expand Down
14 changes: 7 additions & 7 deletions content/v1.14/guides/write-a-composition-function-in-python.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Composition functions (or just functions, for short) are custom programs that
template Crossplane resources. Crossplane calls composition functions to
determine what resources it should create when you create a composite resource
(XR). Read the
[concepts](https://docs.crossplane.io/latest/concepts/composition-functions)
[concepts]{{<ref "../concepts/composition-functions" >}}
page to learn more about composition functions.

You can write a function to template resources using a general purpose
Expand All @@ -22,7 +22,7 @@ conditionals. This guide explains how to write a composition function in

{{< hint "important" >}}
It helps to be familiar with
[how composition functions work](https://docs.crossplane.io/latest/concepts/composition-functions#how-composition-functions-work)
[how composition functions work]{{<ref "../concepts/composition-functions#how-composition-functions-work" >}}
before following this guide.
{{< /hint >}}

Expand Down Expand Up @@ -70,7 +70,7 @@ To write a function in Python you need:
* [Python](https://www.python.org/downloads/) v3.11.
* [Hatch](https://hatch.pypa.io/), a Python build tool. This guide uses v1.7.
* [Docker Engine](https://docs.docker.com/engine/). This guide uses Engine v24.
* The [Crossplane CLI](https://docs.crossplane.io/latest/cli) v1.14 or newer. This guide uses Crossplane
* The [Crossplane CLI]({{<ref "../cli" >}}) v1.14 or newer. This guide uses Crossplane
CLI v1.14.

{{<hint "note">}}
Expand Down Expand Up @@ -132,7 +132,7 @@ The `package/input` directory defines the OpenAPI schema for the a function's
input. The function in this guide doesn't accept an input. Delete the
`package/input` directory.

The [composition functions](https://docs.crossplane.io/latest/concepts/composition-functions)
The [composition functions]{{<ref "../concepts/composition-functions" >}}
documentation explains composition function inputs.

{{<hint "tip">}}
Expand Down Expand Up @@ -639,7 +639,7 @@ spec:

{{<hint "tip">}}
Read the composition functions documentation to learn more about
[testing composition functions](https://docs.crossplane.io/latest/concepts/composition-functions#test-a-composition-that-uses-functions).
[testing composition functions]({{< ref "../concepts/composition-functions#test-a-composition-that-uses-functions" >}}).
{{</hint>}}

## Build and push the function to a package registry
Expand All @@ -656,7 +656,7 @@ then pushing all the packages to a single tag in the registry.

Pushing your function to a registry allows you to use your function in a
Crossplane control plane. See the
[composition functions documentation](https://docs.crossplane.io/latest/concepts/composition-functions).
[composition functions documentation]{{<ref "../concepts/composition-functions" >}}.
to learn how to use a function in a control plane.

Use Docker to build a runtime for each platform.
Expand Down Expand Up @@ -715,7 +715,7 @@ crossplane xpkg build \

{{<hint "tip">}}
Crossplane packages are special OCI images. Read more about packages in the
[packages documentation](https://docs.crossplane.io/latest/concepts/packages).
[packages documentation]({{< ref "../concepts/packages" >}}).
{{</hint>}}

Push both package files to a registry. Pushing both files to one tag in the
Expand Down
Loading

0 comments on commit 9c5de44

Please sign in to comment.