Skip to content

Commit 0314e64

Browse files
authored
Merge pull request #974 from negz/index
Auto-generate child page indexes
2 parents d71867d + d34b276 commit 0314e64

File tree

82 files changed

+215
-85
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+215
-85
lines changed

content/master/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Welcome"
33
weight: -1
4+
description: "Control plane framework for building cloud native platforms"
45
cascade:
56
version: "master"
67
---

content/master/cli/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
weight: 200
33
title: CLI Reference
4-
description: "Documentation for the Crossplane command-line interface"
4+
description: "Command-line tools for Crossplane development"
55
---
66

77
The Crossplane CLI helps simplify some development and administration aspects of

content/master/composition/_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Composition
33
weight: 51
4-
description: Understand Crossplane's core components
4+
description: Build custom APIs by composing Kubernetes resources
55
---
6+
7+
{{< auto-index >}}

content/master/composition/composite-resource-definitions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Composite Resource Definitions
33
weight: 20
4-
description: "Composite Resource Definitions or XRDs define custom API schemas"
4+
description: "Define schemas for composite resources"
55
---
66

77
Composite resource definitions (`XRDs`) define the schema for a custom API.

content/master/composition/composite-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Composite Resources
33
weight: 10
4-
description: "Composite resources, an XR or XRs, represent a collection of related cloud resources."
4+
description: "Custom APIs created by composing Kubernetes resources"
55
---
66

77
A composite resource, or XR, represents a set of Kubernetes resources as a

content/master/composition/composition-revisions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Composition Revisions
33
weight: 35
4+
description: "Manage changes to Compositions with revisions"
45
---
56

67
This guide discusses the use of "Composition Revisions" to make and roll

content/master/composition/compositions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ aliases:
55
- composition
66
- composition-functions
77
- /knowledge-base/guides/composition-functions
8-
description: "Compositions are a template for creating composite resources"
8+
description: "Define which resources to create and how"
99
---
1010

1111
Compositions are a template for creating multiple Kubernetes resources as a
@@ -784,15 +784,15 @@ Function response caching is an alpha feature. Enable it by setting the
784784

785785
Crossplane can cache function responses to improve performance by reducing
786786
repeated function calls. When enabled, Crossplane caches responses from
787-
composition functions that include a Time-To-Live (TTL) value.
787+
composition functions that include a time to live (TTL) value.
788788

789789
The cache works by:
790790
- Storing function responses on disk based on a hash of the request
791-
- Only caching responses with a non-zero TTL
791+
- Only caching responses with a nonzero TTL
792792
- Automatically removing expired cache entries
793793
- Reusing cached responses for identical requests until they expire
794794

795-
This feature is particularly useful for functions that:
795+
This feature helps functions that:
796796
- Perform expensive computations or external API calls
797797
- Return stable results for the same inputs
798798
- Include appropriate TTL values in their responses
@@ -803,6 +803,6 @@ Control the cache behavior with these Crossplane pod arguments:
803803

804804
- `--xfn-cache-max-ttl` - Maximum cache duration (default: 24 hours)
805805

806-
The cache stores files in the `/cache/xfn/` directory within the Crossplane pod.
806+
The cache stores files in the `/cache/xfn/` directory in the Crossplane pod.
807807
For better performance, consider using an in-memory cache by mounting an
808808
emptyDir volume with `medium: Memory`.

content/master/composition/environment-configs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 75
44
state: beta
55
alphaVersion: "1.11"
66
betaVersion: "1.18"
7-
description: "Environment Configs or EnvironmentConfigs are an in-memory datastore used in Compositions"
7+
description: "In-memory data stores for Compositions"
88
---
99

1010
<!--

content/master/get-started/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ weight: 40
44
description: Get started with Crossplane.
55
---
66

7+
{{< auto-index >}}

content/master/get-started/get-started-with-composition.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Get Started With Composition
33
weight: 200
4+
description: "Build custom APIs with Crossplane composition"
45
---
56

67
This guide shows how to create a new kind of custom resource named `App`. When a

0 commit comments

Comments
 (0)