Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摉: fix spelling mistakes in document #3331

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/book/src/component-config-tutorial/config-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Then, run `make build` to implement the interface for your API type, which would
<h1>Use --controller=false</h1>

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

</aside>
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/component-config-tutorial/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ community has been migrating the core components away from this and toward
using versioned config files, referred to as "component configs".

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


Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/migration/v3vsv4.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Projects scaffolded with Kubebuilder v3 release still using the `go.kubebuilder.
<aside class="note warning">
<h1>Project customizations</h1>

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.
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.

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]

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/plugins/kustomize-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ If you are looking to scaffold the kustomize configuration manifests for your ow

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

```go
// Bundle plugin which built the golang projects scaffold by Kubebuilder go/v3
Expand Down
6 changes: 3 additions & 3 deletions docs/book/src/plugins/testing-plugins.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Test Your Plugins

You can test your plugin in two dimenstion:
You can test your plugin in two dimension:

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

1. Setup testing environment, e.g:
- Cleanup environment, create temp dir. See [Prepare](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L97)
- 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)
- 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)
2. Validate the plugin behavior, e.g:
- 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)
Expand All @@ -39,7 +39,7 @@ It can be straightforward to view content of sample projects generated by your p

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.

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

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