Skip to content

Commit c005bb3

Browse files
committed
Address vale warnings and errors
These weren't introduced by this PR - I think they were missed in recent ones. Signed-off-by: Nic Cope <nicc@rk0n.org>
1 parent dc1c242 commit c005bb3

File tree

4 files changed

+11
-10
lines changed

4 files changed

+11
-10
lines changed

content/master/composition/compositions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -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/guides/pods.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Kubernetes API server when a composed resource changes. For example, when
137137
a provider sets the `Ready` condition to `true`.
138138

139139
{{<hint "important" >}}
140-
Real time compositions are a beta feature. Beta features are enabled by
140+
Real time compositions are a beta feature. Crossplane enables beta features by
141141
default.
142142
{{< /hint >}}
143143

content/master/operations/operation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -304,17 +304,17 @@ Function response caching is an alpha feature. Enable it by setting the
304304
`--enable-function-response-cache` feature flag.
305305
{{< /hint >}}
306306

307-
Operations can benefit from function response caching to improve performance,
308-
especially for operations that:
309-
- Call the same functions repeatedly with identical inputs
307+
Operations can use function response caching to improve performance
308+
for operations that:
309+
- Call the same functions often with identical inputs
310310
- Use functions that perform expensive computations or external API calls
311311
- Run frequently through CronOperation or WatchOperation
312312

313313
The cache works the same way as for Compositions - function responses with
314-
time to live values are cached and reused for identical requests until
314+
time to live values cache and reuse identical requests until
315315
they expire.
316316

317-
This is particularly useful for Operations that:
317+
Function response caching helps Operations that:
318318
- Validate configurations using expensive checks
319319
- Query external systems for status information
320320
- Perform complex calculations that don't change frequently

utils/vale/styles/Crossplane/allowed-jargon.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ syscall
108108
templated
109109
TLS
110110
tolerations
111+
TTL
111112
UI
112113
VM
113114
walkthrough

0 commit comments

Comments
 (0)