Skip to content

Commit 9c0ca90

Browse files
committed
vale fixes for install from source guide
Signed-off-by: Jared Watts <jbw976@gmail.com>
1 parent 0b4e27d commit 9c0ca90

3 files changed

Lines changed: 16 additions & 10 deletions

File tree

content/master/guides/install-from-source.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ export REGISTRY="your-registry.com/your-org"; \
8181

8282
The build embeds `${VERSION}` into the Crossplane binary and uses it as the
8383
container image tag and Helm chart version. Nix's sandboxed builds only read
84-
from files tracked by git, so `${VERSION}` must be written into `flake.nix`
84+
from files tracked by git, so you must write `${VERSION}` into `flake.nix`
8585
before building:
8686

8787
```shell {copy-lines="all"}
@@ -105,8 +105,10 @@ platforms:
105105
nix build
106106
```
107107

108-
The first run downloads the build toolchain and takes a few minutes. Subsequent
108+
<!-- vale write-good.Weasel = NO -->
109+
The first run downloads the build toolchain and takes a few minutes. Later
109110
runs reuse the Nix store cache and complete in seconds.
111+
<!-- vale write-good.Weasel = YES -->
110112

111113
The build output is under `./result/`:
112114

@@ -116,8 +118,8 @@ The build output is under `./result/`:
116118
- `result/images/linux_<arch>/image.tar.gz` is the container image tarball for
117119
each supported Linux architecture.
118120

119-
The build does not load images into your local Docker daemon. The image
120-
tarballs in `result/images/` are loaded automatically by the push step.
121+
The build doesn't load images into your local Docker daemon. The push step
122+
loads the image tarballs in `result/images/` automatically.
121123

122124
### Push the image to your registry
123125

@@ -134,10 +136,10 @@ nix run .#push-images -- ${REGISTRY}/crossplane
134136
```
135137

136138
{{< hint "note" >}}
137-
If your host Docker is configured with a credential helper (for example
139+
If your host Docker uses a credential helper (for example
138140
Docker Desktop on macOS), the helper isn't available on the sandboxed
139141
`PATH` used by `nix run .#push-images`. Bypass the helper for the login
140-
and push by writing auth directly to a temporary Docker config:
142+
and push by writing auth directly to a temporary Docker configuration:
141143

142144
```shell
143145
export DOCKER_CONFIG=$(mktemp -d)
@@ -232,14 +234,14 @@ v2.0.0-yourtag
232234

233235
### Clean up the working tree
234236

235-
The earlier `sed` step modified `flake.nix`, which is tracked by git. After all
237+
The earlier `sed` step modified `flake.nix`, a file that git tracks. After all
236238
build, push, and install steps are complete, revert the change to keep your
237239
working tree clean:
238240

239241
```shell {copy-lines="all"}
240242
git checkout flake.nix
241243
```
242244

243-
Reverting this file before the push or install steps complete causes Nix to
244-
re-evaluate the flake with `buildVersion = null`, which produces an
245-
auto-generated version that won't match the artifacts you already built.
245+
Reverting this file before completing the push or install steps causes Nix to
246+
rebuild the flake with `buildVersion = null`, which produces a different
247+
version that doesn't match the artifacts you already built.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ syscall
114114
templated
115115
TLS
116116
tolerations
117+
toolchain
117118
TTL
118119
UI
119120
VM

utils/vale/styles/Crossplane/spelling-exceptions.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,14 @@ idempotency
2828
in-depth
2929
in-memory
3030
Job.
31+
language-specific
3132
least-privilege
3233
left-hand
3334
long-running
3435
Long-running
3536
low-risk
3637
low-traffic
38+
multi-arch
3739
multi-cluster
3840
multi-region
3941
Multi-step
@@ -51,6 +53,7 @@ out-of-sync
5153
Operation-level
5254
pattern-based
5355
Pattern-based
56+
per-architecture
5457
per-element
5558
performant
5659
per-object

0 commit comments

Comments
 (0)