diff --git a/docs/book/src/plugins/go-v4-plugin.md b/docs/book/src/plugins/go-v4-plugin.md index 432f19f7f1..6d7da044c2 100644 --- a/docs/book/src/plugins/go-v4-plugin.md +++ b/docs/book/src/plugins/go-v4-plugin.md @@ -1,7 +1,7 @@ -# go/v4 (go.kubebuilder.io/v4) +# [Default Scaffold] go/v4 (go.kubebuilder.io/v4) Kubebuilder will scaffold using the `go/v4` plugin only if specified when initializing the project. -This plugin is a composition of the plugins ` kustomize.common.kubebuilder.io/v2-alpha` and `base.go.kubebuilder.io/v4`. +This plugin is a composition of the plugins ` kustomize.common.kubebuilder.io/v2` and `base.go.kubebuilder.io/v4`. It scaffolds a project template that helps in constructing sets of [controllers][controller-runtime]. It scaffolds boilerplate code to create and design controllers. @@ -17,15 +17,7 @@ under the [testdata][testdata] directory on the root directory of the Kubebuilde ## When to use it ? -- If you are looking to scaffold Golang projects to develop projects using [controllers][controller-runtime] -- If you are looking to experiment with the future default scaffold that will be provided by Kubebuilder CLI -- If your local environment is Apple Silicon (`darwin/arm64`) -- If you are looking to use [kubernetes-sigs/kustomize][kustomize] v5 -- If you are looking to have your project update with the latest version available -- if you are not targeting k8s versions < `1.16` and `1.20` if you are using webhooks -- If you are looking to work on with scaffolds which are compatible with k8s `1.25+` -- If you are looking for the new layout following the [Standard Go Project Layout][standard-go-project] where -the "api(s)" are scaffold under the `api` directory, "controller(s)" under `internal`, and the `main.go` under `cmd` +If you are looking to scaffold Golang projects to develop projects using [controllers][controller-runtime]