diff --git a/content/master/_index.md b/content/master/_index.md index 7d6d54a1..4a426272 100644 --- a/content/master/_index.md +++ b/content/master/_index.md @@ -1,6 +1,7 @@ --- title: "Welcome" weight: -1 +description: "Control plane framework for building cloud native platforms" cascade: version: "master" --- diff --git a/content/master/cli/_index.md b/content/master/cli/_index.md index 824e2be0..3316a1c8 100644 --- a/content/master/cli/_index.md +++ b/content/master/cli/_index.md @@ -1,7 +1,7 @@ --- weight: 200 title: CLI Reference -description: "Documentation for the Crossplane command-line interface" +description: "Command-line tools for Crossplane development" --- The Crossplane CLI helps simplify some development and administration aspects of diff --git a/content/master/composition/_index.md b/content/master/composition/_index.md index e81d8c38..f2486cd7 100644 --- a/content/master/composition/_index.md +++ b/content/master/composition/_index.md @@ -1,7 +1,7 @@ --- title: Composition weight: 51 -description: Understand Crossplane's core components +description: Build custom APIs by composing Kubernetes resources --- {{< auto-index >}} diff --git a/content/master/composition/composite-resource-definitions.md b/content/master/composition/composite-resource-definitions.md index b76d2a8e..0eb242be 100644 --- a/content/master/composition/composite-resource-definitions.md +++ b/content/master/composition/composite-resource-definitions.md @@ -1,7 +1,7 @@ --- title: Composite Resource Definitions weight: 20 -description: "Composite Resource Definitions or XRDs define custom API schemas" +description: "Define schemas for composite resources" --- Composite resource definitions (`XRDs`) define the schema for a custom API. diff --git a/content/master/composition/composite-resources.md b/content/master/composition/composite-resources.md index 31a6e43c..cf93addc 100644 --- a/content/master/composition/composite-resources.md +++ b/content/master/composition/composite-resources.md @@ -1,7 +1,7 @@ --- title: Composite Resources weight: 10 -description: "Composite resources, an XR or XRs, represent a collection of related cloud resources." +description: "Custom APIs created by composing Kubernetes resources" --- A composite resource, or XR, represents a set of Kubernetes resources as a diff --git a/content/master/composition/composition-revisions.md b/content/master/composition/composition-revisions.md index 9fe2897f..b9695f6f 100644 --- a/content/master/composition/composition-revisions.md +++ b/content/master/composition/composition-revisions.md @@ -1,6 +1,7 @@ --- title: Composition Revisions weight: 35 +description: "Manage changes to Compositions with revisions" --- This guide discusses the use of "Composition Revisions" to make and roll diff --git a/content/master/composition/compositions.md b/content/master/composition/compositions.md index 0bdba343..c92915e3 100644 --- a/content/master/composition/compositions.md +++ b/content/master/composition/compositions.md @@ -5,7 +5,7 @@ aliases: - composition - composition-functions - /knowledge-base/guides/composition-functions -description: "Compositions are a template for creating composite resources" +description: "Define which resources to create and how" --- Compositions are a template for creating multiple Kubernetes resources as a diff --git a/content/master/composition/environment-configs.md b/content/master/composition/environment-configs.md index 50d67221..542c2d01 100644 --- a/content/master/composition/environment-configs.md +++ b/content/master/composition/environment-configs.md @@ -4,7 +4,7 @@ weight: 75 state: beta alphaVersion: "1.11" betaVersion: "1.18" -description: "Environment Configs or EnvironmentConfigs are an in-memory datastore used in Compositions" +description: "In-memory data stores for Compositions" --- diff --git a/content/master/guides/extensions-release-process.md b/content/master/guides/extensions-release-process.md index 4a976959..e7f76c3d 100644 --- a/content/master/guides/extensions-release-process.md +++ b/content/master/guides/extensions-release-process.md @@ -1,8 +1,7 @@ --- title: Releasing Crossplane Extensions weight: 80 -description: "Configuring build pipelines for Crossplane extensions with GitHub -Actions" +description: "Build pipelines for Crossplane extensions" --- diff --git a/content/master/guides/function-patch-and-transform.md b/content/master/guides/function-patch-and-transform.md index d4046066..ca8b2362 100644 --- a/content/master/guides/function-patch-and-transform.md +++ b/content/master/guides/function-patch-and-transform.md @@ -1,7 +1,7 @@ --- title: Function Patch and Transform weight: 70 -description: "A function that use patches and transforms to change inputs from composite resources before creating managed resources" +description: "Write legacy Compositions" --- Function Patch and Transform allows you to write a Composition that specifies diff --git a/content/master/guides/implementing-safe-start.md b/content/master/guides/implementing-safe-start.md index b8c36a21..21d08b32 100644 --- a/content/master/guides/implementing-safe-start.md +++ b/content/master/guides/implementing-safe-start.md @@ -3,8 +3,7 @@ title: Implementing safe-start in Providers weight: 90 state: alpha alphaVersion: 2.0 -description: Guide for provider developers to add safe-start capability for - selective resource activation +description: Add selective resource activation to providers --- This guide shows provider developers how to implement safe-start capability in diff --git a/content/master/guides/metrics.md b/content/master/guides/metrics.md index c8a67ead..255d584e 100644 --- a/content/master/guides/metrics.md +++ b/content/master/guides/metrics.md @@ -1,7 +1,7 @@ --- title: Metrics weight: 60 -description: "Metrics are essential for monitoring Crossplane's operations, helping to identify and resolve potential issues." +description: "Monitor Crossplane operations with metrics" --- Crossplane produces [Prometheus style metrics](https://prometheus.io/docs/introduction/overview/#what-are-metrics) for effective monitoring and alerting in your environment. diff --git a/content/master/guides/pods.md b/content/master/guides/pods.md index b1d2f0f3..792245e7 100644 --- a/content/master/guides/pods.md +++ b/content/master/guides/pods.md @@ -1,7 +1,7 @@ --- title: Crossplane Pods weight: 1 -description: Background on the components installed with Crossplane and their functions. +description: Components installed with Crossplane --- The base Crossplane installation consists of two pods, the `crossplane` pod and diff --git a/content/master/guides/self-signed-ca-certs.md b/content/master/guides/self-signed-ca-certs.md index 38696688..c79de817 100644 --- a/content/master/guides/self-signed-ca-certs.md +++ b/content/master/guides/self-signed-ca-certs.md @@ -2,7 +2,8 @@ --- title: Self-signed CA certs -weight: 270 +weight: 270 +description: "Configure Crossplane with self-signed certificates" --- diff --git a/content/master/guides/troubleshoot-crossplane.md b/content/master/guides/troubleshoot-crossplane.md index f36f9623..99f1d37f 100644 --- a/content/master/guides/troubleshoot-crossplane.md +++ b/content/master/guides/troubleshoot-crossplane.md @@ -1,6 +1,7 @@ --- title: Troubleshoot Crossplane weight: 306 +description: "Debug common Crossplane issues" --- ## Requested resource not found diff --git a/content/master/guides/uninstall-crossplane.md b/content/master/guides/uninstall-crossplane.md index e4d17769..b6045343 100644 --- a/content/master/guides/uninstall-crossplane.md +++ b/content/master/guides/uninstall-crossplane.md @@ -1,6 +1,7 @@ --- title: Uninstall Crossplane weight: 500 +description: "Remove Crossplane from your cluster" --- {{}} diff --git a/content/master/guides/upgrade-crossplane.md b/content/master/guides/upgrade-crossplane.md index c899658d..7aee892d 100644 --- a/content/master/guides/upgrade-crossplane.md +++ b/content/master/guides/upgrade-crossplane.md @@ -1,6 +1,7 @@ --- title: Upgrade Crossplane weight: 400 +description: "Upgrade Crossplane to newer versions" --- The recommended upgrade method for an existing Crossplane install is to use 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 c40e415b..87283b25 100644 --- a/content/master/guides/write-a-composition-function-in-go.md +++ b/content/master/guides/write-a-composition-function-in-go.md @@ -1,7 +1,7 @@ --- title: Write a Composition Function in Go weight: 80 -description: "Composition functions allow you to template resources using Go" +description: "Build composition functions in Go" --- Composition functions (or just functions, for short) are custom programs that 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 81b55876..bb4e102c 100644 --- a/content/master/guides/write-a-composition-function-in-python.md +++ b/content/master/guides/write-a-composition-function-in-python.md @@ -1,7 +1,7 @@ --- title: Write a Composition Function in Python weight: 81 -description: "Composition functions allow you to template resources using Python" +description: "Build composition functions in Python" --- Composition functions (or just functions, for short) are custom programs that diff --git a/content/master/learn/feature-lifecycle.md b/content/master/learn/feature-lifecycle.md index 8f3934ce..2da306da 100644 --- a/content/master/learn/feature-lifecycle.md +++ b/content/master/learn/feature-lifecycle.md @@ -3,6 +3,7 @@ title: Feature Lifecycle toc: true weight: 309 indent: true +description: "Crossplane's feature development process" --- # Feature lifecycle diff --git a/content/master/learn/release-cycle.md b/content/master/learn/release-cycle.md index f9d650e4..92e2af6a 100644 --- a/content/master/learn/release-cycle.md +++ b/content/master/learn/release-cycle.md @@ -1,6 +1,7 @@ --- title: Release Cycle weight: 308 +description: "When and how Crossplane releases are cut" --- Starting with the v1.10.0 release, Crossplane releases on a quarterly (13 diff --git a/content/master/managed-resources/_index.md b/content/master/managed-resources/_index.md index a1004397..dd2d59ae 100644 --- a/content/master/managed-resources/_index.md +++ b/content/master/managed-resources/_index.md @@ -1,7 +1,7 @@ --- title: Managed Resources weight: 52 -description: Understand Crossplane's managed resources and selective activation +description: Manage cloud resources in Kubernetes --- -{{< auto-index >}} \ No newline at end of file +{{< auto-index >}} diff --git a/content/master/managed-resources/managed-resource-activation-policies.md b/content/master/managed-resources/managed-resource-activation-policies.md index 0d15583b..8c6229ea 100644 --- a/content/master/managed-resources/managed-resource-activation-policies.md +++ b/content/master/managed-resources/managed-resource-activation-policies.md @@ -3,9 +3,7 @@ title: Managed Resource Activation Policies weight: 20 state: alpha alphaVersion: 2.0 -description: ManagedResourceActivationPolicies control which - ManagedResourceDefinitions activate for selective provider resource - installation +description: Choose which provider resources Crossplane activates --- {{}} diff --git a/content/master/managed-resources/managed-resource-definitions.md b/content/master/managed-resources/managed-resource-definitions.md index 248a9b52..9756beb6 100644 --- a/content/master/managed-resources/managed-resource-definitions.md +++ b/content/master/managed-resources/managed-resource-definitions.md @@ -3,8 +3,7 @@ title: Managed Resource Definitions weight: 15 state: alpha alphaVersion: 2.0 -description: ManagedResourceDefinitions enable selective activation of provider - resources and reduce CRD overhead +description: Enable selective activation of provider resources --- {{}} diff --git a/content/master/managed-resources/managed-resources.md b/content/master/managed-resources/managed-resources.md index cb797fe9..279b160f 100644 --- a/content/master/managed-resources/managed-resources.md +++ b/content/master/managed-resources/managed-resources.md @@ -1,7 +1,7 @@ --- title: Managed Resources weight: 10 -description: "Managed resources are the Crossplane representation of external provider resources" +description: "Kubernetes representations of cloud resources" --- A _managed resource_ (`MR`) represents an external service in a Provider. When diff --git a/content/master/managed-resources/usages.md b/content/master/managed-resources/usages.md index c2944cb6..69a94b4c 100644 --- a/content/master/managed-resources/usages.md +++ b/content/master/managed-resources/usages.md @@ -4,7 +4,7 @@ weight: 30 state: beta alphaVersion: "1.14" betaVersion: "1.19" -description: "Usage indicates a resource is in use" +description: "Block deletion of in-use resources" --- A `Usage` indicates a resource is in use. Two main use cases for Usages are @@ -288,4 +288,4 @@ spec: resourceRef: name: importantresources.example.crossplane.io reason: "Very important CRD - should never be deleted!" -``` \ No newline at end of file +``` diff --git a/content/master/operations/_index.md b/content/master/operations/_index.md index 3870e523..508f4765 100644 --- a/content/master/operations/_index.md +++ b/content/master/operations/_index.md @@ -3,7 +3,7 @@ title: Operations weight: 52 state: alpha alphaVersion: 2.0 -description: Understand Crossplane's Operations feature +description: Run operational tasks with Crossplane --- {{< auto-index >}} \ No newline at end of file diff --git a/content/master/operations/cronoperation.md b/content/master/operations/cronoperation.md index 45327cf2..ee37d3ce 100644 --- a/content/master/operations/cronoperation.md +++ b/content/master/operations/cronoperation.md @@ -3,7 +3,7 @@ title: Cron Operations weight: 120 state: alpha alphaVersion: 2.0 -description: CronOperations create Operations on a schedule for recurring tasks +description: Run function pipelines on a schedule --- A `CronOperation` creates [Operations]({{}}) on a schedule, diff --git a/content/master/operations/operation.md b/content/master/operations/operation.md index 94ffc761..631ae295 100644 --- a/content/master/operations/operation.md +++ b/content/master/operations/operation.md @@ -3,7 +3,7 @@ title: Operations weight: 110 state: alpha alphaVersion: 2.0 -description: Operations run function pipelines once to completion for operational tasks +description: Run function pipelines once to completion --- An `Operation` runs a function pipeline once to completion to perform operational diff --git a/content/master/operations/watchoperation.md b/content/master/operations/watchoperation.md index 1e8a651b..a0678ee3 100644 --- a/content/master/operations/watchoperation.md +++ b/content/master/operations/watchoperation.md @@ -3,7 +3,7 @@ title: Watch Operations weight: 130 state: alpha alphaVersion: 2.0 -description: WatchOperations create Operations when watched resources change +description: Run function pipelines on resource changes --- A `WatchOperation` creates [Operations]({{}}) when watched diff --git a/content/master/packages/_index.md b/content/master/packages/_index.md index 637831f0..d65b572a 100644 --- a/content/master/packages/_index.md +++ b/content/master/packages/_index.md @@ -1,7 +1,7 @@ --- title: Packages weight: 53 -description: Understand Crossplane's core components +description: Extend Crossplane with packages --- {{< auto-index >}} \ No newline at end of file diff --git a/content/master/packages/configurations.md b/content/master/packages/configurations.md index d2997980..c2e71d63 100644 --- a/content/master/packages/configurations.md +++ b/content/master/packages/configurations.md @@ -1,6 +1,6 @@ --- title: Configurations -description: "Packages combine multiple Crossplane resources into a single, portable, OCI image." +description: "Portable packages of Crossplane resources" altTitle: "Crossplane Packages" weight: 200 --- diff --git a/content/master/packages/image-configs.md b/content/master/packages/image-configs.md index 58999a64..6ed9bc7a 100644 --- a/content/master/packages/image-configs.md +++ b/content/master/packages/image-configs.md @@ -1,7 +1,7 @@ --- title: Image Configs weight: 400 -description: "Image Configs is an API for centralized control of the configuration of Crossplane package images." +description: "Centralized control of package image configuration" ---