Skip to content

Commit f7c2887

Browse files
committed
vale fixes for build from source guide
Signed-off-by: Jared Watts <[email protected]>
1 parent 00e97bd commit f7c2887

File tree

3 files changed

+23
-15
lines changed

3 files changed

+23
-15
lines changed

content/master/get-started/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,5 +121,5 @@ args='{"--enable-composition-functions","--enable-composition-webhook-schema-val
121121
## Build and install from source
122122

123123
Building Crossplane from the source code gives you complete control over the build and
124-
installation process. Full instructions for this advanced installation path can
125-
be found in the [install from source code guide]({{<ref "../guides/install-from-source.md">}}).
124+
installation process. Full instructions for this advanced installation path is in the
125+
[install from source code guide]({{<ref "../guides/install-from-source.md">}}).

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

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ code, push the image to your own registry, and install to your Kubernetes
1212
cluster.
1313

1414
{{< hint "important" >}}
15-
This is an advanced installation path for users who
15+
Installing Crossplane from source is an advanced installation path for users who
1616
require complete control over the build and deployment process. Most users
1717
should follow the [standard installation instructions]({{<ref "../get-started/install.md">}})
1818
{{< /hint >}}
1919

2020
This approach is useful when you want to:
2121
- Control the entire build and deployment pipeline
2222
- Use your own container registry and cluster
23-
- Deploy to air-gapped or restricted environments
23+
- Deploy to offline or restricted environments
2424
- Build from a specific commit or branch
2525

2626
### Prerequisites
@@ -32,20 +32,20 @@ Building Crossplane from source requires:
3232
- [kubectl](https://kubernetes.io/docs/tasks/tools/) configured for your target cluster
3333
- An actively [supported Kubernetes version](https://kubernetes.io/releases/patch-releases/#support-period)
3434
- [Helm](https://helm.sh/docs/intro/install/) version `v3.2.0` or later
35-
- Access to a container registry (Docker Hub, GHCR, Harbor, or any OCI-compliant
35+
- Access to a container registry (Docker Hub, GHCR, Harbor, or any OCI compliant
3636
registry)
3737

3838
### Clone the Crossplane repository
3939

40-
Clone the Crossplane repository and optionally check out a specific release.
40+
Clone the Crossplane repository and optionally checkout a specific release.
4141

4242
```shell {copy-lines="all"}
4343
git clone https://github.com/crossplane/crossplane.git
4444
cd crossplane
4545
```
4646

4747
{{< hint "tip" >}}
48-
To build a specific release, check out the release tag before building.
48+
To build a specific release, checkout the release tag before building.
4949

5050
```shell
5151
git checkout v2.0.2
@@ -54,9 +54,9 @@ git checkout v2.0.2
5454

5555
### Determine your cluster architecture
5656

57-
Identify your cluster's CPU architecture before building. Crossplane must be
58-
built for the same architecture as your cluster nodes. Here is one possible way to check the
59-
architecture of your cluster:
57+
Identify your cluster's CPU architecture before building. You must build
58+
Crossplane for the same architecture as your cluster nodes. Here is one possible
59+
way to find the architecture of your cluster:
6060

6161
```shell {copy-lines="1"}
6262
kubectl get nodes -o jsonpath='{.items[0].status.nodeInfo.architecture}'
@@ -71,8 +71,10 @@ export CLUSTER_ARCH=<your cluster arch>
7171

7272
### Determine artifacts destination
7373

74-
Identify the registry and version tag where you will be pushing your built
74+
<!-- vale gitlab.FutureTense = NO -->
75+
Identify the registry and version tag where you will push your built
7576
software artifacts and save them in environment variables:
77+
<!-- vale gitlab.FutureTense = YES -->
7678

7779
```shell {copy-lines="all"}
7880
export REGISTRY="your-registry.com/your-org"; \
@@ -105,7 +107,10 @@ chart under `_output/bin` and `_output/charts/` respectively.
105107

106108
### Push the image to your registry
107109

108-
Log in to your registry of choice and push the Crossplane image that we built in the previous steps.
110+
<!-- vale write-good.Passive = NO -->
111+
Log in to your registry of choice and push the Crossplane image that was built
112+
in the previous steps.
113+
<!-- vale write-good.Passive = YES -->
109114

110115
{{< hint "tip" >}}
111116
Ensure you log into your registry before attempting to `push`.
@@ -172,9 +177,9 @@ your-registry.com/your-org/crossplane:v2.0.0-yourtag
172177

173178
### Optional: Build the Crossplane CLI
174179

175-
The `crossplane` CLI provides additional commands for managing Crossplane
176-
resources. You can optionally build this binary from source code for your local
177-
machine and use it to manage your control plane.
180+
The `crossplane` CLI provides commands for managing Crossplane resources. You
181+
can optionally build this binary from source code for your local machine and use
182+
it to manage your control plane.
178183

179184
Build the CLI for your local machine.
180185

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
64-bit
33
API's
44
APIs
5+
ARM64
56
autoscaler
67
backoff
78
backported
@@ -40,6 +41,7 @@ Env
4041
EOL
4142
ESS
4243
float64
44+
GHCR
4345
GitOps
4446
Go
4547
godoc
@@ -58,6 +60,7 @@ kube-controller-manager
5860
kubectl
5961
kv
6062
KV
63+
macOS
6164
main.go
6265
metrics-server
6366
MiB

0 commit comments

Comments
 (0)