Skip to content

Commit 7b9f47e

Browse files
committed
lint: fix all vale errors in environment config docs
Signed-off-by: Jared Watts <[email protected]>
1 parent ff712f0 commit 7b9f47e

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

content/master/concepts/environment-configs.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ TODO: Add Policies
1111
-->
1212

1313

14-
A Crossplane EnvironmentConfig is a cluster-scoped, strongly-typed,
14+
A Crossplane EnvironmentConfig is a cluster-scoped, strongly typed,
1515
[ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/)-like
1616
resource used by Compositions. Compositions can use the environment to store
1717
information from individual resources or to apply patches.
@@ -65,7 +65,7 @@ data:
6565
## Access EnvironmentConfigs
6666
6767
`EnvironmentConfigs` can be accessed by [Composition Functions] supporting
68-
[extra-resources], e.g. [function-environment-configs] or
68+
[extra-resources], for example [function-environment-configs] or
6969
[function-go-templating].
7070

7171
## Migration from Alpha Composition Environment
@@ -97,7 +97,7 @@ Select the EnvironmentConfigs to use through [function-environment-configs]'s `I
9797

9898
The `environmentConfigs` field is a list of `EnvironmentConfigs` we want
9999
retrieved, merged and passed to the next step in the pipeline through the
100-
[Context] at a well-known key, `apiextensions.crossplane.io/environment`.
100+
[Context] at a well known key, `apiextensions.crossplane.io/environment`.
101101

102102
Select an environment by `Reference` or by `Selector`:
103103

@@ -174,7 +174,7 @@ Select an `EnvironmentConfig` by labels with a `type: Selector`.
174174
Define `selector.matchLabels` to a list of selectors either of type `Value`, or `FromCompositeFieldPath`.
175175

176176
When matching the label's value, provide an exact value with a
177-
`type: Value and provide the value to match in the `value` field.
177+
`type: Value` and provide the value to match in the `value` field.
178178

179179
[function-environment-configs] can also match a label's value based on an input
180180
in the composite resource. Use `type: FromCompositeFieldPath` and provide the
@@ -263,7 +263,7 @@ with `maxMatch` and define the maximum number to select.
263263

264264
Use `minMatch` and define the minimum number of environments returned.
265265

266-
The Function sorts the returned environments alphabetically by name by defaul.
266+
The Function sorts the returned environments alphabetically by name by default.
267267
Sort the environments on a different field with `sortByFieldPath` and define
268268
the field to sort by.
269269

@@ -392,7 +392,7 @@ value.
392392

393393
`EnvironmentConfigs` selected as explained above, are then merged in an
394394
`in-memory environment` by [function-environment-configs] and passed to the
395-
next function in the pipeline at a well-known key,
395+
next function in the pipeline at a well known key,
396396
`apiextensions.crossplane.io/environment`.
397397

398398
[function-patch-and-transform] can be used to read or write data between the in-memory environment and
@@ -407,11 +407,10 @@ resources. Read about EnvironmentConfig patch types in the
407407
### Patch between Composite resource and environment
408408

409409
To patch between Composite resource and environment define patches at
410-
`spec.environment.patches` in [function-patch-and-transform]'s `Resources`
411-
input.
410+
`spec.environment.patches` in the `Resources` input of [function-patch-and-transform].
412411

413412
Use the `ToCompositeFieldPath` patch type to copy data from the in-memory
414-
environment to the Composite resource. Use the `FromCompositeFieldPath` to
413+
environment to the Composite resource. Use the `FromCompositeFieldPath` to
415414
copy data from the Composite resource to the in-memory environment.
416415

417416
```yaml {label="xrpatch",copy-lines="none"}
@@ -450,7 +449,7 @@ Composite resource, respectively.
450449

451450
To patch between individual resources and the in-memory environment, inside the
452451
patches of the resource, use `ToEnvironmentFieldPath` to copy data from the
453-
resource to the in-memory environment. Use `FromEnvironmentFieldPath` to copy
452+
resource to the in-memory environment. Use `FromEnvironmentFieldPath` to copy
454453
data to the resource from the in-memory environment.
455454

456455
```yaml {label="envpatch",copy-lines="none"}

utils/vale/styles/Crossplane/crossplane-words.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,16 @@ DeploymentRuntimeConfigs
3232
EnvironmentConfig
3333
EnvironmentConfigs
3434
external-name
35+
extra-resources
3536
finalizer
3637
finalizers
3738
FromCompositeFieldPath
3839
FromEnvironmentFieldPath
3940
fromFieldPath
41+
function-environment-configs
42+
function-extra-resources
43+
function-go-templating
44+
function-patch-and-transform
4045
HealthyPackageRevision
4146
Helm-like
4247
InactivePackageRevision
@@ -73,7 +78,3 @@ XRD
7378
XRD's
7479
XRDs
7580
XRs
76-
function-extra-resources
77-
function-go-templating
78-
function-patch-and-transform
79-

0 commit comments

Comments
 (0)