From 9c5de441945982927a5ca30c346523940fd79ada Mon Sep 17 00:00:00 2001 From: Pete Lumbis Date: Tue, 16 Apr 2024 10:53:52 -0400 Subject: [PATCH] update absolute links to docs pages to ref shortcodes Signed-off-by: Pete Lumbis --- content/master/concepts/providers.md | 4 ++-- .../guides/write-a-composition-function-in-go.md | 14 +++++++------- .../write-a-composition-function-in-python.md | 14 +++++++------- content/master/software/upgrade.md | 2 +- content/v1.13/concepts/providers.md | 2 +- .../guides/write-a-composition-function-in-go.md | 10 +++++----- .../write-a-composition-function-in-python.md | 10 +++++----- content/v1.14/concepts/providers.md | 4 ++-- .../guides/write-a-composition-function-in-go.md | 14 +++++++------- .../write-a-composition-function-in-python.md | 14 +++++++------- content/v1.15/concepts/providers.md | 4 ++-- .../guides/write-a-composition-function-in-go.md | 14 +++++++------- .../write-a-composition-function-in-python.md | 14 +++++++------- content/v1.15/software/upgrade.md | 2 +- 14 files changed, 61 insertions(+), 61 deletions(-) diff --git a/content/master/concepts/providers.md b/content/master/concepts/providers.md index a89586daa..099f28352 100644 --- a/content/master/concepts/providers.md +++ b/content/master/concepts/providers.md @@ -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`. diff --git a/content/master/guides/write-a-composition-function-in-go.md b/content/master/guides/write-a-composition-function-in-go.md index cc0e6cec1..0430957c0 100644 --- a/content/master/guides/write-a-composition-function-in-go.md +++ b/content/master/guides/write-a-composition-function-in-go.md @@ -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]{{}} page to learn more about composition functions. You can write a function to template resources using a general purpose @@ -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]{{}} before following this guide. {{< /hint >}} @@ -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]({{}}) v1.14 or newer. This guide uses Crossplane CLI v1.14. {{}} @@ -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]{{}} documentation explains how to pass an input to a composition function. The `package/input` directory contains an OpenAPI schema generated from the @@ -740,7 +740,7 @@ spec: {{}} 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" >}}). {{}} ## Build and push the function to a package registry @@ -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]{{}}. to learn how to use a function in a control plane. Use Docker to build a runtime for each platform. @@ -808,7 +808,7 @@ crossplane xpkg build \ {{}} 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" >}}). {{}} Push both package files to a registry. Pushing both files to one tag in the diff --git a/content/master/guides/write-a-composition-function-in-python.md b/content/master/guides/write-a-composition-function-in-python.md index db10b7c6c..4a9e63a13 100644 --- a/content/master/guides/write-a-composition-function-in-python.md +++ b/content/master/guides/write-a-composition-function-in-python.md @@ -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]{{}} page to learn more about composition functions. You can write a function to template resources using a general purpose @@ -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]{{}} before following this guide. {{< /hint >}} @@ -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]({{}}) v1.14 or newer. This guide uses Crossplane CLI v1.14. {{}} @@ -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]{{}} documentation explains composition function inputs. {{}} @@ -639,7 +639,7 @@ spec: {{}} 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" >}}). {{}} ## Build and push the function to a package registry @@ -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]{{}}. to learn how to use a function in a control plane. Use Docker to build a runtime for each platform. @@ -715,7 +715,7 @@ crossplane xpkg build \ {{}} 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" >}}). {{}} Push both package files to a registry. Pushing both files to one tag in the diff --git a/content/master/software/upgrade.md b/content/master/software/upgrade.md index b11f3644c..c145cc171 100644 --- a/content/master/software/upgrade.md +++ b/content/master/software/upgrade.md @@ -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]({{}}) with the upgrade command. For example, to maintain the original image registry use diff --git a/content/v1.13/concepts/providers.md b/content/v1.13/concepts/providers.md index d5eb4871c..c02b019e0 100644 --- a/content/v1.13/concepts/providers.md +++ b/content/v1.13/concepts/providers.md @@ -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`. diff --git a/content/v1.13/guides/write-a-composition-function-in-go.md b/content/v1.13/guides/write-a-composition-function-in-go.md index cc0e6cec1..4778b25f2 100644 --- a/content/v1.13/guides/write-a-composition-function-in-go.md +++ b/content/v1.13/guides/write-a-composition-function-in-go.md @@ -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]{{}} page to learn more about composition functions. You can write a function to template resources using a general purpose @@ -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]{{}} before following this guide. {{< /hint >}} @@ -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]{{}} documentation explains how to pass an input to a composition function. The `package/input` directory contains an OpenAPI schema generated from the @@ -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]{{}}. to learn how to use a function in a control plane. Use Docker to build a runtime for each platform. @@ -808,7 +808,7 @@ crossplane xpkg build \ {{}} 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" >}}). {{}} Push both package files to a registry. Pushing both files to one tag in the diff --git a/content/v1.13/guides/write-a-composition-function-in-python.md b/content/v1.13/guides/write-a-composition-function-in-python.md index db10b7c6c..de2f9ff11 100644 --- a/content/v1.13/guides/write-a-composition-function-in-python.md +++ b/content/v1.13/guides/write-a-composition-function-in-python.md @@ -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]{{}} page to learn more about composition functions. You can write a function to template resources using a general purpose @@ -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]{{}} before following this guide. {{< /hint >}} @@ -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]{{}} documentation explains composition function inputs. {{}} @@ -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]{{}}. to learn how to use a function in a control plane. Use Docker to build a runtime for each platform. @@ -715,7 +715,7 @@ crossplane xpkg build \ {{}} 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" >}}). {{}} Push both package files to a registry. Pushing both files to one tag in the diff --git a/content/v1.14/concepts/providers.md b/content/v1.14/concepts/providers.md index cfdecd697..756a2d622 100644 --- a/content/v1.14/concepts/providers.md +++ b/content/v1.14/concepts/providers.md @@ -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`. diff --git a/content/v1.14/guides/write-a-composition-function-in-go.md b/content/v1.14/guides/write-a-composition-function-in-go.md index cc0e6cec1..0430957c0 100644 --- a/content/v1.14/guides/write-a-composition-function-in-go.md +++ b/content/v1.14/guides/write-a-composition-function-in-go.md @@ -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]{{}} page to learn more about composition functions. You can write a function to template resources using a general purpose @@ -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]{{}} before following this guide. {{< /hint >}} @@ -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]({{}}) v1.14 or newer. This guide uses Crossplane CLI v1.14. {{}} @@ -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]{{}} documentation explains how to pass an input to a composition function. The `package/input` directory contains an OpenAPI schema generated from the @@ -740,7 +740,7 @@ spec: {{}} 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" >}}). {{}} ## Build and push the function to a package registry @@ -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]{{}}. to learn how to use a function in a control plane. Use Docker to build a runtime for each platform. @@ -808,7 +808,7 @@ crossplane xpkg build \ {{}} 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" >}}). {{}} Push both package files to a registry. Pushing both files to one tag in the diff --git a/content/v1.14/guides/write-a-composition-function-in-python.md b/content/v1.14/guides/write-a-composition-function-in-python.md index db10b7c6c..4a9e63a13 100644 --- a/content/v1.14/guides/write-a-composition-function-in-python.md +++ b/content/v1.14/guides/write-a-composition-function-in-python.md @@ -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]{{}} page to learn more about composition functions. You can write a function to template resources using a general purpose @@ -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]{{}} before following this guide. {{< /hint >}} @@ -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]({{}}) v1.14 or newer. This guide uses Crossplane CLI v1.14. {{}} @@ -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]{{}} documentation explains composition function inputs. {{}} @@ -639,7 +639,7 @@ spec: {{}} 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" >}}). {{}} ## Build and push the function to a package registry @@ -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]{{}}. to learn how to use a function in a control plane. Use Docker to build a runtime for each platform. @@ -715,7 +715,7 @@ crossplane xpkg build \ {{}} 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" >}}). {{}} Push both package files to a registry. Pushing both files to one tag in the diff --git a/content/v1.15/concepts/providers.md b/content/v1.15/concepts/providers.md index a89586daa..099f28352 100644 --- a/content/v1.15/concepts/providers.md +++ b/content/v1.15/concepts/providers.md @@ -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`. diff --git a/content/v1.15/guides/write-a-composition-function-in-go.md b/content/v1.15/guides/write-a-composition-function-in-go.md index cc0e6cec1..0430957c0 100644 --- a/content/v1.15/guides/write-a-composition-function-in-go.md +++ b/content/v1.15/guides/write-a-composition-function-in-go.md @@ -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]{{}} page to learn more about composition functions. You can write a function to template resources using a general purpose @@ -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]{{}} before following this guide. {{< /hint >}} @@ -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]({{}}) v1.14 or newer. This guide uses Crossplane CLI v1.14. {{}} @@ -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]{{}} documentation explains how to pass an input to a composition function. The `package/input` directory contains an OpenAPI schema generated from the @@ -740,7 +740,7 @@ spec: {{}} 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" >}}). {{}} ## Build and push the function to a package registry @@ -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]{{}}. to learn how to use a function in a control plane. Use Docker to build a runtime for each platform. @@ -808,7 +808,7 @@ crossplane xpkg build \ {{}} 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" >}}). {{}} Push both package files to a registry. Pushing both files to one tag in the diff --git a/content/v1.15/guides/write-a-composition-function-in-python.md b/content/v1.15/guides/write-a-composition-function-in-python.md index db10b7c6c..4a9e63a13 100644 --- a/content/v1.15/guides/write-a-composition-function-in-python.md +++ b/content/v1.15/guides/write-a-composition-function-in-python.md @@ -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]{{}} page to learn more about composition functions. You can write a function to template resources using a general purpose @@ -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]{{}} before following this guide. {{< /hint >}} @@ -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]({{}}) v1.14 or newer. This guide uses Crossplane CLI v1.14. {{}} @@ -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]{{}} documentation explains composition function inputs. {{}} @@ -639,7 +639,7 @@ spec: {{}} 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" >}}). {{}} ## Build and push the function to a package registry @@ -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]{{}}. to learn how to use a function in a control plane. Use Docker to build a runtime for each platform. @@ -715,7 +715,7 @@ crossplane xpkg build \ {{}} 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" >}}). {{}} Push both package files to a registry. Pushing both files to one tag in the diff --git a/content/v1.15/software/upgrade.md b/content/v1.15/software/upgrade.md index b11f3644c..c145cc171 100644 --- a/content/v1.15/software/upgrade.md +++ b/content/v1.15/software/upgrade.md @@ -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]({{}}) with the upgrade command. For example, to maintain the original image registry use