Skip to content

Commit 7e763c4

Browse files
committed
Clean up some typos and links in CAPI book
1 parent c680942 commit 7e763c4

22 files changed

+65
-65
lines changed

docs/book/src/clusterctl/developers.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ If you want to create a local artifact, follow these instructions:
3333

3434
### Build artifacts locally
3535

36-
In order to build artifacts for the CAPI core provider, the kubeadm bootstrap provider, the kubeadm control plane provider and the docker infrastructure provider:
36+
In order to build artifacts for the CAPI core provider, the kubeadm bootstrap provider, the kubeadm control plane provider and the Docker infrastructure provider:
3737

3838
```bash
3939
make docker-build REGISTRY=gcr.io/k8s-staging-cluster-api PULL_POLICY=IfNotPresent
@@ -96,7 +96,7 @@ during your dev session.
9696
The above config file changes the location of the [overrides layer] folder thus ensuring
9797
you dev session isn't hijacked by other local artifacts.
9898

99-
With the only exception of the docker provider, the local repository folder does not contain cluster templates,
99+
With the only exception of the Docker provider, the local repository folder does not contain cluster templates,
100100
so the `clusterctl generate cluster` command will fail.
101101

102102
</aside>
@@ -126,11 +126,11 @@ please note that each `provider_repo` should have its own `clusterctl-settings.j
126126
## Create a kind management cluster
127127

128128
[kind] can provide a Kubernetes cluster to be used as a management cluster.
129-
See [Install and/or configure a kubernetes cluster] for more information.
129+
See [Install and/or configure a Kubernetes cluster] for more information.
130130

131131
*Before* running clusterctl init, you must ensure all the required images are available in the kind cluster.
132132

133-
This is always the case for images published in some image repository like docker hub or gcr.io, but it can't be
133+
This is always the case for images published in some image repository like Docker Hub or gcr.io, but it can't be
134134
the case for images built locally; in this case, you can use `kind load` to move the images built locally. e.g.
135135

136136
```bash
@@ -148,7 +148,7 @@ script.
148148

149149
Optionally, you may want to check if the components are running properly. The
150150
exact components are dependent on which providers you have initialized. Below
151-
is an example output with the docker provider being installed.
151+
is an example output with the Docker provider being installed.
152152

153153
```bash
154154
kubectl get deploy -A | grep "cap\|cert"
@@ -166,7 +166,7 @@ cert-manager cert-manager-webhook
166166

167167
## Additional Notes for the Docker Provider
168168

169-
### Select the appropriate kubernetes version
169+
### Select the appropriate Kubernetes version
170170

171171
When selecting the `--kubernetes-version`, ensure that the `kindest/node`
172172
image is available.
@@ -205,6 +205,6 @@ sed -i -e "s/server:.*/server: https:\/\/$(docker port capi-quickstart-lb 6443/t
205205
[kind]: https://kind.sigs.k8s.io/
206206
[providers repositories]: configuration.md#provider-repositories
207207
[overrides layer]: configuration.md#overrides-layer
208-
[Install and/or configure a kubernetes cluster]: ../user/quick-start.md#install-andor-configure-a-kubernetes-cluster
208+
[Install and/or configure a Kubernetes cluster]: ../user/quick-start.md#install-andor-configure-a-kubernetes-cluster
209209
[kind-docker-hub]: https://hub.docker.com/r/kindest/node/tags
210210
[issue 3795]: https://github.com/kubernetes-sigs/cluster-api/issues/3795

docs/book/src/clusterctl/provider-contract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ that are compliant with one of the following rules:
436436
* The object is directly or indirectly linked to a `ClusterResourceSet` object (through the `OwnerReference` chain).
437437
* The object is directly or indirectly linked to another object with the `clusterctl.cluster.x-k8s.io/move-hierarchy`
438438
label, e.g. the infrastructure Provider ClusterIdentity objects (linked through the `OwnerReference` chain).
439-
* The object hase the `clusterctl.cluster.x-k8s.io/move` label or the `clusterctl.cluster.x-k8s.io/move-hierarchy` label,
439+
* The object has the `clusterctl.cluster.x-k8s.io/move` label or the `clusterctl.cluster.x-k8s.io/move-hierarchy` label,
440440
e.g. the CPI config secret.
441441

442442
Note. `clusterctl.cluster.x-k8s.io/move` and `clusterctl.cluster.x-k8s.io/move-hierarchy` labels could be applied

docs/book/src/developer/architecture/controllers/cluster-topology.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Its main responsibilities are to:
1212

1313
The high level workflow of ClusterTopology reconciliation is shown below.
1414

15-
![ClusterTopology Reconciller Component Diagram](../../../images/cluster-topology-reconciller.png)
15+
![ClusterTopology Reconciler Component Diagram](../../../images/cluster-topology-reconciller.png)
1616

1717
### Additional information
1818

docs/book/src/developer/architecture/controllers/control-plane.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ following fields defined:
180180
introspection by clients, and is used to provide the CRD-based integration
181181
for the scale subresource and additional integrations for things like
182182
kubectl describe. The string will be in the same format as the query-param
183-
syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors
183+
syntax. More info about label selectors: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
184184
</td>
185185
<td></td>
186186
</tr>

docs/book/src/developer/architecture/controllers/machine-pool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The MachinePool controller's main responsibilities are:
1010
* The associated InfrastructureMachinePool object.
1111
* Copy data from `BootstrapConfig.Status.DataSecretName` to `MachinePool.Spec.Template.Spec.Bootstrap.DataSecretName` if
1212
`MachinePool.Spec.Template.Spec.Bootstrap.DataSecretName` is empty.
13-
* Setting NodeRefs on MachinePool instances to be able to associate them with kubernetes nodes.
13+
* Setting NodeRefs on MachinePool instances to be able to associate them with Kubernetes nodes.
1414
* Deleting Nodes in the target cluster when the associated MachinePool instance is deleted.
1515
* Keeping the MachinePool's Status object up to date with the InfrastructureMachinePool's Status object.
1616
* Finding Kubernetes nodes matching the expected providerIDs in the workload cluster.

docs/book/src/developer/architecture/controllers/machine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The Machine controller's main responsibilities are:
1010
* The associated InfrastructureMachine object.
1111
* Copy data from `BootstrapConfig.Status.DataSecretName` to `Machine.Spec.Bootstrap.DataSecretName` if
1212
`Machine.Spec.Bootstrap.DataSecretName` is empty.
13-
* Setting NodeRefs to be able to associate machines and kubernetes nodes.
13+
* Setting NodeRefs to be able to associate machines and Kubernetes nodes.
1414
* Deleting Nodes in the target cluster when the associated machine is deleted.
1515
* Cleanup of related objects.
1616
* Keeping the Machine's Status object up to date with the InfrastructureMachine's Status object.

docs/book/src/developer/e2e.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ test specs for the most common Cluster API use cases.
1818

1919
Each E2E test requires a set of artifacts to be available:
2020

21-
- Binaries & docker images for Kubernetes, CNI, CRI & CSI
22-
- Manifests & docker images for the Cluster API core components
23-
- Manifests & docker images for the Cluster API infrastructure provider; in most cases
21+
- Binaries & Docker images for Kubernetes, CNI, CRI & CSI
22+
- Manifests & Docker images for the Cluster API core components
23+
- Manifests & Docker images for the Cluster API infrastructure provider; in most cases
2424
machine images are also required (AMI, OVA etc.)
2525
- Credentials for the target infrastructure provider
2626
- Other support tools (e.g. kustomize, gsutil etc.)

docs/book/src/developer/logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ We are working to continuously improving this experience, allowing Cluster API d
137137
For the best experience exploring the logs using Tilt:
138138
1. Set `--logging-format=json`.
139139
2. Set a high log verbosity, e.g. `v=5`.
140-
3. Enable promtail, loki, and grafana under deploy_observability.
140+
3. Enable Promtail, Loki, and Grafana under `deploy_observability`.
141141

142142
A minimal example of a tilt-settings.yaml file that deploys a ready-to-use logging suite looks like:
143143
```yaml

docs/book/src/developer/providers/contracts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Cluster API defines a contract which requires providers to implement certain fie
55
Cluster API defines the following contracts:
66

77
- [Infrastructure provider contract](./cluster-infrastructure.md)
8-
- [Boostrap provider contract](./bootstrap.md)
8+
- [Bootstrap provider contract](./bootstrap.md)
99
- [Control Plane provider contract](../../developer/architecture/controllers/control-plane.md#crd-contracts)
1010
- [Machine provider contract](./machine-infrastructure.md)
1111
- [clusterctl provider contract](../../clusterctl/provider-contract.md#clusterctl-provider-contract)
@@ -14,7 +14,7 @@ Cluster API defines the following contracts:
1414
## API version labels
1515
Providers MUST set `cluster.x-k8s.io/<version>` label on all Custom Resource Definitions related to Cluster API starting with v1alpha3.
1616
The label is a map from an API Version of Cluster API (contract) to your Custom Resource Definition versions.
17-
The value is a underscore-delimited (_) list of versions.
17+
The value is an underscore-delimited (_) list of versions.
1818
Each value MUST point to an available version in your CRD Spec.
1919

2020
The label allows Cluster API controllers to perform automatic conversions for object references, the controllers will pick the last available version in the list if multiple versions are found.
@@ -33,4 +33,4 @@ An example of this is in the [Kubeadm Bootstrap provider](https://github.com/kub
3333
3434
## Improving and contributing to the contract
3535
36-
The definition of the contract between Cluster API and providers may be changed in future versions of Cluster API. The Cluster API maintainers welcome feedback and contributions to the contract in order to improve how it's defined, its clarity and visibility to provider implementers and its suitability across the different kinds of Cluster API providers. To provide feedback or open a discussion about the provider contract please [open an issue on the Cluster API](https://github.com/kubernetes-sigs/cluster-api/issues/new?assignees=&labels=&template=feature_request.md) repo or add an item to the agenda in the [Cluster API community meeting](http://git.k8s.io/community/sig-cluster-lifecycle/README.md#cluster-api).
36+
The definition of the contract between Cluster API and providers may be changed in future versions of Cluster API. The Cluster API maintainers welcome feedback and contributions to the contract in order to improve how it's defined, its clarity and visibility to provider implementers and its suitability across the different kinds of Cluster API providers. To provide feedback or open a discussion about the provider contract please [open an issue on the Cluster API](https://github.com/kubernetes-sigs/cluster-api/issues/new?assignees=&labels=&template=feature_request.md) repo or add an item to the agenda in the [Cluster API community meeting](https://git.k8s.io/community/sig-cluster-lifecycle/README.md#cluster-api).

docs/book/src/developer/providers/v0.3-to-v0.4.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
- The `test` folder now ships with its own Go module `sigs.k8s.io/cluster-api/test`.
2424
- The module is going to be tagged and versioned as part of the release.
25-
- Folks importing the test e2e framework or the docker infrastructure provider need to import the new module.
25+
- Folks importing the test e2e framework or the Docker infrastructure provider need to import the new module.
2626
- When imported, the test module version should always match the Cluster API one.
2727
- Add the following line in `go.mod` to replace the cluster-api dependency in the test module (change the version to your current Cluster API version):
2828
```
@@ -199,7 +199,7 @@ should be executed before this changes.
199199
200200
**Changes in the `/config/default` folder:**
201201
202-
1. Edit the `/config/default/kustomization.yaml` file and replace all the occurencies of
202+
1. Edit the `/config/default/kustomization.yaml` file and replace all the occurrences of
203203
```
204204
kind: Certificate
205205
group: cert-manager.io

0 commit comments

Comments
 (0)