Skip to content

Commit c3d5cf7

Browse files
authored
📖: fix spelling mistakes in document (#3331)
fix spelling mistakes in doc
1 parent 8299d40 commit c3d5cf7

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

docs/book/src/component-config-tutorial/config-type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Then, run `make build` to implement the interface for your API type, which would
1313
<h1>Use --controller=false</h1>
1414

1515
You may notice this command from the `CronJob` tutorial although here we
16-
explicity setting `--controller=false` because `ProjectConfig` is not
16+
explicitly setting `--controller=false` because `ProjectConfig` is not
1717
intended to be an API extension and cannot be reconciled.
1818

1919
</aside>

docs/book/src/component-config-tutorial/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ community has been migrating the core components away from this and toward
1010
using versioned config files, referred to as "component configs".
1111

1212
The rest of this tutorial will show you how to configure your kubebuilder
13-
project with the a component config type then moves on to implementing a custom
13+
project with the component config type then moves on to implementing a custom
1414
type so that you can extend this capability.
1515

1616

docs/book/src/migration/v3vsv4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Projects scaffolded with Kubebuilder v3 release still using the `go.kubebuilder.
4343
<aside class="note warning">
4444
<h1>Project customizations</h1>
4545

46-
After using the CLI to create your project, you are free to customise how you see fit. Bear in mind, that it is not recommended to deviate from the proposed layout unless you know what you are doing.
46+
After using the CLI to create your project, you are free to customize how you see fit. Bear in mind, that it is not recommended to deviate from the proposed layout unless you know what you are doing.
4747

4848
For example, you should refrain from moving the scaffolded files, doing so will make it difficult in upgrading your project in the future. You may also lose the ability to use some of the CLI features and helpers. For further information on the project layout, see the doc [What's in a basic project?][basic-project-doc]
4949

docs/book/src/plugins/kustomize-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ If you are looking to scaffold the kustomize configuration manifests for your ow
5353

5454
If you are looking to define that your language plugin should use kustomize use the [Bundle Plugin][bundle]
5555
to specify that your language plugin is a composition with your plugin responsible for scaffold
56-
all that is laguage specific and kustomize for its configuration, see:
56+
all that is language specific and kustomize for its configuration, see:
5757

5858
```go
5959
// Bundle plugin which built the golang projects scaffold by Kubebuilder go/v3

docs/book/src/plugins/testing-plugins.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Test Your Plugins
22

3-
You can test your plugin in two dimenstion:
3+
You can test your plugin in two dimension:
44

55
1. Validate your plugin behavior through E2E tests
66
2. Generate sample projects based on your plugin that can be placed in `./testdata/`
@@ -18,7 +18,7 @@ You can check [Kubebuilder/v3/test/e2e/utils](https://pkg.go.dev/sigs.k8s.io/kub
1818
Once defined, you can use `TestContext` to:
1919

2020
1. Setup testing environment, e.g:
21-
- Cleanup environment, create temp dir. See [Prepare](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L97)
21+
- Clean up the environment, create temp dir. See [Prepare](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L97)
2222
- Install prerequisites CRDs: See [InstallCertManager](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L138), [InstallPrometheusManager](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.6.0/test/e2e/utils/test_context.go#L171)
2323
2. Validate the plugin behavior, e.g:
2424
- Trigger the plugin's bound subcommands. See [Init](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L213), [CreateAPI](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.6.0/test/e2e/utils/test_context.go#L222)
@@ -39,7 +39,7 @@ It can be straightforward to view content of sample projects generated by your p
3939

4040
For example, Kubebuilder generate [sample projects](https://github.com/kubernetes-sigs/kubebuilder/tree/v3.7.0/testdata) based on different plugins to validate the layouts.
4141

42-
Simiply, you can also use `TextContext` to generate folders of scaffolded projects from your plugin.
42+
Simply, you can also use `TextContext` to generate folders of scaffolded projects from your plugin.
4343
The commands are very similar as mentioned in [creating-plugins](creating-plugins.md#write-e2e-tests).
4444

4545
Following is a general workflow to create a sample by the plugin `go/v3`: (`kbc` is an instance of `TextContext`)

0 commit comments

Comments
 (0)