Skip to content

Commit 580593f

Browse files
committed
Address all warnings in content/master
I tried to address them everywhere but there are literally thousands. Signed-off-by: Nic Cope <[email protected]>
1 parent 331c389 commit 580593f

27 files changed

+356
-217
lines changed

content/master/cli/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ https://releases.crossplane.io/stable/current/bin
4141

4242
{{<hint "important" >}}
4343
<!-- vale write-good.Passive = NO -->
44-
The CLI is named `crank` in the release repository. Download this file.
44+
The release repository names the CLI `crank`. Download this file.
4545
<!-- vale write-good.Passive = YES -->
4646

4747
The `crossplane` binary is the Kubernetes Crossplane pod image.

content/master/cli/command-reference.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@ The following flags are available for all commands.
2424

2525
{{< /table >}}
2626

27+
<!-- vale Google.Headings = NO -->
28+
<!-- vale Microsoft.Headings = NO -->
2729
## version
30+
<!-- vale Google.Headings = YES -->
31+
<!-- vale Microsoft.Headings = YES -->
2832

2933
The `crossplane version` command returns the version of Crossplane CLI
3034
and the control plane.
@@ -35,7 +39,9 @@ Client Version: v1.17.0
3539
Server Version: v1.17.0
3640
```
3741

42+
<!-- vale Google.Headings = NO -->
3843
## render
44+
<!-- vale Google.Headings = YES -->
3945

4046
The `crossplane render` command previews the output of a
4147
[composite resource]({{<ref "../composition/composite-resources">}}) after applying
@@ -167,21 +173,25 @@ spec:
167173

168174
The schema of the resource isn't validated and may contain any data.
169175

170-
### Mock Extra Resources
176+
### Mock extra resources
171177

172178
Extra Resources allow a Composition to request Crossplane Objects on the cluster that aren't
173179
part of the Composition. The `--extra-resources` option points at a directory containing
174180
YAML manifests of resources to mock. Use Extra Resources in combination with a function like
175181
[function-extra-resources](https://github.com/crossplane-contrib/function-extra-resources) or the
176182
built-in support in [function-go-templating](https://github.com/crossplane-contrib/function-go-templating?tab=readme-ov-file#extraresources).
177183

184+
<!-- vale Google.Headings = NO -->
178185
## xpkg
186+
<!-- vale Google.Headings = YES -->
179187

180188
The `crossplane xpkg` commands create, install and update Crossplane
181-
[packages]({{<ref "../packages/configurations">}}) as well as enable authentication
189+
[packages]({{<ref "../packages/configurations">}}) and enable authentication
182190
and publishing of Crossplane packages to a Crossplane package registry.
183191

192+
<!-- vale Google.Headings = NO -->
184193
### xpkg build
194+
<!-- vale Google.Headings = YES -->
185195

186196
Using `crossplane xpkg build` provides automation and simplification to build
187197
Crossplane packages.
@@ -243,7 +253,7 @@ Include YAML files demonstrating how to use the package with `--examples-root`.
243253
#### Include a runtime image
244254

245255
Functions and Providers require YAML files describing their dependencies and
246-
settings as well as a container image for their runtime.
256+
settings and a container image for their runtime.
247257

248258
Using `--embed-runtime-image-name` runs a specified image and
249259
includes the image inside the function or provider package.
@@ -258,7 +268,9 @@ Use `docker pull` to download a missing image.
258268
The `--embed-runtime-image-tarball` flag includes a local OCI image tarball
259269
inside the function or provider package.
260270

271+
<!-- vale Google.Headings = NO -->
261272
### xpkg init
273+
<!-- vale Google.Headings = YES -->
262274

263275
The `crossplane xpkg init` command populates the current directory with
264276
files to build a package.
@@ -279,14 +291,18 @@ The `<template>` value may be one of four well known templates:
279291
Instead of a well known template the `<template>` value can be a git repository
280292
URL.
281293

294+
<!-- vale Google.Headings = NO -->
282295
#### NOTES.txt
296+
<!-- vale Google.Headings = YES -->
283297

284298
If the template repository contains a `NOTES.txt` file in its root directory,
285299
the `crossplane xpkg init` command prints the contents of the file to the
286300
terminal after populating the directory with the template files. This can be
287301
useful for providing information about the template.
288302

303+
<!-- vale Google.Headings = NO -->
289304
#### init.sh
305+
<!-- vale Google.Headings = YES -->
290306

291307
If the template repository contains an `init.sh` file in its root directory, the
292308
`crossplane xpkg init` command starts a dialog after populating the
@@ -305,7 +321,9 @@ personalize the template.
305321
{{< /table >}}
306322

307323

324+
<!-- vale Google.Headings = NO -->
308325
### xpkg install
326+
<!-- vale Google.Headings = YES -->
309327

310328
Download and install packages into Crossplane with `crossplane xpkg install`.
311329

@@ -375,7 +393,9 @@ Read more about
375393
[package revisions]({{< ref "../packages/configurations#configuration-revisions" >}})
376394
in the package documentation.
377395

396+
<!-- vale Google.Headings = NO -->
378397
### xpkg login
398+
<!-- vale Google.Headings = YES -->
379399

380400
Use `xpkg login` to authenticate to registries that host Crossplane packages.
381401

@@ -430,7 +450,9 @@ Authenticate to a registered organization in the Upbound Marketplace with the
430450
For example,
431451
`crossplane xpkg login --account=Upbound --username=my-user --password -`.
432452

453+
<!-- vale Google.Headings = NO -->
433454
### xpkg logout
455+
<!-- vale Google.Headings = YES -->
434456

435457
Use `crossplane xpkg logout` to invalidate the current `crossplane xpkg login`
436458
session.
@@ -440,7 +462,9 @@ Using `crossplane xpkg logout` removes the `session` from the
440462
`~/.crossplane/config.json` file, but doesn't delete the configuration file.
441463
{{< /hint >}}
442464

465+
<!-- vale Google.Headings = NO -->
443466
### xpkg push
467+
<!-- vale Google.Headings = YES -->
444468

445469
Push a Crossplane package file to a package registry.
446470

@@ -478,7 +502,9 @@ DockerHub organization `crossplane-docs/my-package:v0.14.0` use:
478502
| `-f` | `--package-files=PATH` | A comma-separated list of xpkg files to push. |
479503
{{< /table >}}
480504

505+
<!-- vale Google.Headings = NO -->
481506
### xpkg update
507+
<!-- vale Google.Headings = YES -->
482508

483509
The `crossplane xpkg update` command downloads and updates an existing package.
484510

@@ -499,7 +525,9 @@ For example, to update to the latest version of the
499525
`crossplane xpkg update provider xpkg.crossplane.io/crossplane-contrib/provider-aws-s3:v1.21.1`
500526

501527

528+
<!-- vale Google.Headings = NO -->
502529
## beta
530+
<!-- vale Google.Headings = YES -->
503531

504532
Crossplane `beta` commands are experimental. These commands may change the
505533
flags, options or outputs in future releases.
@@ -508,7 +536,9 @@ Crossplane maintainers may promote or remove commands under `beta` in future
508536
releases.
509537

510538

539+
<!-- vale Google.Headings = NO -->
511540
### beta convert
541+
<!-- vale Google.Headings = YES -->
512542

513543
As Crossplane evolves, its APIs and resources may change. To help with the
514544
migration to the new APIs and resources, the `crossplane beta convert` command
@@ -547,7 +577,9 @@ By default the function name is "function-patch-and-transform."
547577
{{< /table >}}
548578

549579

580+
<!-- vale Google.Headings = NO -->
550581
### beta top
582+
<!-- vale Google.Headings = YES -->
551583

552584
The command `crossplane beta top` shows CPU and memory usage of Crossplane
553585
related pods.
@@ -591,7 +623,9 @@ running the `top` command may produce an error, for example,
591623
`crossplane: error: error adding metrics to pod, check if metrics-server is running or wait until metrics are available for the pod: the server is currently unable to handle the request (get pods.metrics.k8s.io crossplane-contrib-provider-helm-b4cc4c2c8db3-6d787f9686-qzmz2)`
592624

593625

626+
<!-- vale Google.Headings = NO -->
594627
### beta trace
628+
<!-- vale Google.Headings = YES -->
595629

596630
Use the `crossplane beta trace` command to display a visual relationship of
597631
Crossplane objects. The `trace` command supports XRs, compositions,
@@ -826,7 +860,9 @@ Configuration/platform-ref-aws v0.9.0 True
826860
# Removed for brevity
827861
```
828862

863+
<!-- vale Google.Headings = NO -->
829864
### beta validate
865+
<!-- vale Google.Headings = YES -->
830866

831867
The `crossplane beta validate` command validates
832868
[compositions]({{<ref "../composition/compositions">}}) against provider or XRD
@@ -953,7 +989,9 @@ crossplane render xr.yaml composition.yaml function.yaml --include-full-xr | cro
953989
Total 5 resources: 0 missing schemas, 4 success cases, 1 failure cases
954990
```
955991

992+
<!-- vale Google.Headings = NO -->
956993
#### Validate Common Expression Language rules
994+
<!-- vale Google.Headings = YES -->
957995

958996
XRDs can define [validation rules](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#validation-rules) expressed in the Common Expression Language
959997
([CEL](https://kubernetes.io/docs/reference/using-api/cel/)).

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,11 @@ Crossplane XRDs are like
3030
XRDs require fewer fields and add options related to Crossplane, like connection
3131
secrets.
3232

33+
<!-- vale Google.Headings = NO -->
34+
<!-- vale Microsoft.Headings = NO -->
3335
## Creating a CompositeResourceDefinition
36+
<!-- vale Google.Headings = YES -->
37+
<!-- vale Microsoft.Headings = YES -->
3438

3539
Creating a CompositeResourceDefinition consists of:
3640
* [Defining a custom API group](#xrd-groups).
@@ -88,7 +92,11 @@ recreate the XRD to change the
8892
{{<hover label="xrd1" line="7">}}names{{</hover>}}.
8993
{{</hint >}}
9094

95+
<!-- vale Google.Headings = NO -->
96+
<!-- vale Microsoft.Headings = NO -->
9197
### XRD groups
98+
<!-- vale Google.Headings = YES -->
99+
<!-- vale Microsoft.Headings = YES -->
92100

93101
Groups define a collection of related API endpoints. The `group` can be any
94102
value, but common convention is to map to a fully qualified domain name.
@@ -98,7 +106,11 @@ Many XRDs may use the same `group` to create a logical collection of APIs.
98106
<!-- vale write-good.Weasel = YES -->
99107
For example a `database` group may have a `relational` and `nosql` kinds.
100108

109+
<!-- vale Google.Headings = NO -->
110+
<!-- vale Microsoft.Headings = NO -->
101111
### XRD names
112+
<!-- vale Google.Headings = YES -->
113+
<!-- vale Microsoft.Headings = YES -->
102114

103115
The `names` field defines how to refer to this specific XRD.
104116
The required name fields are:
@@ -137,7 +149,11 @@ spec:
137149
```
138150
{{</hint >}}
139151

152+
<!-- vale Google.Headings = NO -->
153+
<!-- vale Microsoft.Headings = NO -->
140154
### XRD versions
155+
<!-- vale Google.Headings = YES -->
156+
<!-- vale Microsoft.Headings = YES -->
141157

142158
<!-- vale gitlab.SentenceLength = NO -->
143159
The XRD `version` is like the
@@ -567,7 +583,11 @@ spec:
567583
# Removed for brevity
568584
```
569585

586+
<!-- vale Google.Headings = NO -->
587+
<!-- vale Microsoft.Headings = NO -->
570588
## Verify a CompositeResourceDefinition
589+
<!-- vale Google.Headings = YES -->
590+
<!-- vale Microsoft.Headings = YES -->
571591

572592
Verify an XRD with `kubectl get compositeresourcedefinition` or the short form,
573593
{{<hover label="getxrd" line="1">}}kubectl get xrd{{</hover>}}.
@@ -581,7 +601,11 @@ xdatabases.custom-api.example.org True True 22m
581601
The `ESTABLISHED` field indicates Crossplane installed the Kubernetes custom
582602
resource definition for this XRD.
583603

604+
<!-- vale Google.Headings = NO -->
605+
<!-- vale Microsoft.Headings = NO -->
584606
### XRD conditions
607+
<!-- vale Google.Headings = YES -->
608+
<!-- vale Microsoft.Headings = YES -->
585609
Crossplane uses a standard set of `Conditions` for XRDs.
586610
View the conditions of a XRD under their `Status` with
587611
`kubectl describe xrd`.

content/master/composition/composite-resources.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -319,15 +319,17 @@ Spec:
319319

320320
### Composite resource conditions
321321

322+
<!-- vale Google.Colons = NO -->
322323
A composite resource has two status conditions: Synced and Ready.
324+
<!-- vale Google.Colons = YES -->
323325

324326
Crossplane sets the Synced status condition to True when it's able to
325327
successfully reconcile the composite resource. If Crossplane can't reconcile the
326-
composite resource it'll report an error in the Synced condition.
328+
composite resource it reports an error in the Synced condition.
327329

328330
Crossplane sets the Ready status condition to True when the composite resource's
329-
composition function pipeline reports that all of its composed resources are
330-
ready. If a composed resource isn't ready Crossplane will report it in the
331+
composition function pipeline reports that all its composed resources are
332+
ready. If a composed resource isn't ready Crossplane reports it in the
331333
Ready condition.
332334

333335
## Composite resource labels

0 commit comments

Comments
 (0)