From 580593faeab5cbb40bd2d5601634701dd53dc015 Mon Sep 17 00:00:00 2001 From: Nic Cope Date: Tue, 5 Aug 2025 21:34:04 -0700 Subject: [PATCH] Address all warnings in content/master I tried to address them everywhere but there are literally thousands. Signed-off-by: Nic Cope --- content/master/cli/_index.md | 2 +- content/master/cli/command-reference.md | 44 +++++++++++- .../composite-resource-definitions.md | 24 +++++++ .../master/composition/composite-resources.md | 8 ++- .../composition/composition-revisions.md | 65 +++++++++--------- content/master/composition/compositions.md | 4 +- .../master/composition/environment-configs.md | 33 +++++---- .../get-started-with-managed-resources.md | 2 +- content/master/get-started/install.md | 16 +++++ .../master/guides/crossplane-with-argo-cd.md | 48 ++++++++----- .../guides/extensions-release-process.md | 6 +- .../guides/function-patch-and-transform.md | 2 +- content/master/guides/metrics.md | 2 +- content/master/guides/self-signed-ca-certs.md | 18 +++-- .../master/guides/troubleshoot-crossplane.md | 63 +++++++++-------- content/master/guides/uninstall-crossplane.md | 10 ++- content/master/learn/_index.md | 18 +++-- content/master/learn/feature-lifecycle.md | 46 +++++++------ content/master/learn/release-cycle.md | 68 +++++++++---------- .../managed-resources/managed-resources.md | 6 +- content/master/managed-resources/usages.md | 4 +- content/master/packages/configurations.md | 32 +++++---- content/master/packages/functions.md | 2 +- content/master/packages/image-configs.md | 8 +-- content/master/packages/providers.md | 34 ++++++---- content/master/whats-crossplane/_index.md | 4 +- .../styles/Crossplane/spelling-exceptions.txt | 4 +- 27 files changed, 356 insertions(+), 217 deletions(-) diff --git a/content/master/cli/_index.md b/content/master/cli/_index.md index 3db4237e..7a7dd26e 100644 --- a/content/master/cli/_index.md +++ b/content/master/cli/_index.md @@ -41,7 +41,7 @@ https://releases.crossplane.io/stable/current/bin {{}} -The CLI is named `crank` in the release repository. Download this file. +The release repository names the CLI `crank`. Download this file. The `crossplane` binary is the Kubernetes Crossplane pod image. diff --git a/content/master/cli/command-reference.md b/content/master/cli/command-reference.md index 9bf35e95..8a9258d3 100644 --- a/content/master/cli/command-reference.md +++ b/content/master/cli/command-reference.md @@ -24,7 +24,11 @@ The following flags are available for all commands. {{< /table >}} + + ## version + + The `crossplane version` command returns the version of Crossplane CLI and the control plane. @@ -35,7 +39,9 @@ Client Version: v1.17.0 Server Version: v1.17.0 ``` + ## render + The `crossplane render` command previews the output of a [composite resource]({{}}) after applying @@ -167,7 +173,7 @@ spec: The schema of the resource isn't validated and may contain any data. -### Mock Extra Resources +### Mock extra resources Extra Resources allow a Composition to request Crossplane Objects on the cluster that aren't part of the Composition. The `--extra-resources` option points at a directory containing @@ -175,13 +181,17 @@ YAML manifests of resources to mock. Use Extra Resources in combination with a f [function-extra-resources](https://github.com/crossplane-contrib/function-extra-resources) or the built-in support in [function-go-templating](https://github.com/crossplane-contrib/function-go-templating?tab=readme-ov-file#extraresources). + ## xpkg + The `crossplane xpkg` commands create, install and update Crossplane -[packages]({{}}) as well as enable authentication +[packages]({{}}) and enable authentication and publishing of Crossplane packages to a Crossplane package registry. + ### xpkg build + Using `crossplane xpkg build` provides automation and simplification to build Crossplane packages. @@ -243,7 +253,7 @@ Include YAML files demonstrating how to use the package with `--examples-root`. #### Include a runtime image Functions and Providers require YAML files describing their dependencies and -settings as well as a container image for their runtime. +settings and a container image for their runtime. Using `--embed-runtime-image-name` runs a specified image and includes the image inside the function or provider package. @@ -258,7 +268,9 @@ Use `docker pull` to download a missing image. The `--embed-runtime-image-tarball` flag includes a local OCI image tarball inside the function or provider package. + ### xpkg init + The `crossplane xpkg init` command populates the current directory with files to build a package. @@ -279,14 +291,18 @@ The `