Skip to content

Commit d908e83

Browse files
authored
Merge pull request #4534 from SaphMB/master
📖 fix: correct minor typos in documentation
2 parents 74ab2da + a64bab9 commit d908e83

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

RELEASE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The releases occur in an account in the Google Cloud (See [here](https://console
6868
### To build the Kubebuilder CLI binaries:
6969

7070
A trigger GitHub action [release](.github/workflows/release.yml) is trigged when a new tag is pushed.
71-
This action will caall the job [./build/.goreleaser.yml](./build/.goreleaser.yml).
71+
This action will call the job [./build/.goreleaser.yml](./build/.goreleaser.yml).
7272

7373
### (Deprecated) - To build the Kubebuilder-tools: (Artifacts required to use ENV TEST)
7474

@@ -93,7 +93,7 @@ see: https://github.com/kubernetes-sigs/kubebuilder/discussions/3907
9393
These images are built from the project [brancz/kube-rbac-proxy](https://github.com/brancz/kube-rbac-proxy).
9494
The projects built with Kubebuilder creates a side container with `kube-rbac-proxy` to protect the Manager.
9595

96-
These images are can be checked in the consolse, see [here](https://console.cloud.google.com/gcr/images/kubebuilder/GLOBAL/kube-rbac-proxy).
96+
These images can be checked in the console, see [here](https://console.cloud.google.com/gcr/images/kubebuilder/GLOBAL/kube-rbac-proxy).
9797

9898
The project `kube-rbac-proxy` is in the process to be donated to the k8s org. However, it is going on for a long time and then,
9999
we have no ETA for that to occur. When that occurs we can automate this process. But until there we need to generate these images

docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ controller(s), and webhook(s) in order to compare the generated configuration wi
198198
199199
Also, after all updates you would run the following commands:
200200
201-
- `make manifests` (to re-generate the files using the latest version of the contrller-gen after you update the Makefile)
201+
- `make manifests` (to re-generate the files using the latest version of the controller-gen after you update the Makefile)
202202
- `make all` (to ensure that you are able to build and perform all operations)
203203
204204
[v3vsv4]: v3vsv4.md

docs/book/src/reference/metrics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ By using this method, you ensure that the endpoint is accessible only to those w
102102

103103
In this way, only Pods using the `ServiceAccount` token are authorized to read the metrics endpoint. For example:
104104

105-
```ymal
105+
```yaml
106106
apiVersion: v1
107107
kind: Pod
108108
metadata:
@@ -324,7 +324,7 @@ var (
324324
goobers = prometheus.NewCounter(
325325
prometheus.CounterOpts{
326326
Name: "goobers_total",
327-
Help: "Number of goobers proccessed",
327+
Help: "Number of goobers processed",
328328
},
329329
)
330330
gooberFailures = prometheus.NewCounter(

docs/book/src/reference/platform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can inspect the images using a ManifestList of supported platforms using the
2121
[docker manifest inspect <image>][docker-manifest], i.e.:
2222

2323
```shell
24-
$ docker manifest inspect myresgystry/example/myimage:v0.0.1
24+
$ docker manifest inspect myregistry/example/myimage:v0.0.1
2525
{
2626
"schemaVersion": 2,
2727
"mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",

docs/book/src/reference/pprof-tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ While [Pprof][github] is an excellent tool for profiling and debugging, it is no
5252
go tool pprof -http=:8080 ./cpu-profile.out
5353
```
5454

55-
Visualizaion results will vary depending on the deployed workload, and the Controller's behavior.
55+
Visualization results will vary depending on the deployed workload, and the Controller's behavior.
5656
However, you'll see the result on your browser similar to this one:
5757

5858
![pprof-result-visualization](./images/pprof-result-visualization.png)

docs/book/src/reference/submodule-layouts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ go.work
170170
go.work.sum
171171
```
172172

173-
When releasing with a present `go.work` file, make sure to set the environment variable `GOWORK=off` (verifiable with `go env GOWORK`) to make sure the release process does not get impeded by a potentially commited `go.work` file.
173+
When releasing with a present `go.work` file, make sure to set the environment variable `GOWORK=off` (verifiable with `go env GOWORK`) to make sure the release process does not get impeded by a potentially committed `go.work` file.
174174

175175
#### Adjusting the Dockerfile
176176

@@ -231,7 +231,7 @@ go mod edit -dropreplace YOUR_GO_PATH/test-operator/api/v1alpha1 # this will dro
231231
git push origin main v1.0.0 api/v1.0.0
232232
```
233233

234-
After this, your modules will be available in VCS and you do not need a local replacement anymore. However if youre making local changes,
234+
After this, your modules will be available in VCS and you do not need a local replacement anymore. However if you're making local changes,
235235
make sure to adopt your behavior with `replace` directives accordingly.
236236

237237
### Reusing your extracted API module

docs/kubebuilder_annotation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Delimiter symbols are distinguished to work in different levels from top-down fo
3030

3131
- **Equal sign**
3232

33-
Equal sign `=` is the 3rd level delimiter (to annotation) for identifying key and value. Since the `key=value` parts are splitted from single token (2nd level), its inner delimiter `=` works for next level (3rd level)
33+
Equal sign `=` is the 3rd level delimiter (to annotation) for identifying key and value. Since the `key=value` parts are split from single token (2nd level), its inner delimiter `=` works for next level (3rd level)
3434

3535
- **Semicolon sign**
3636

0 commit comments

Comments
 (0)