Skip to content

Commit 411a639

Browse files
authored
Merge pull request #3345 from camilamacedo86/fix-go-v4-plugin-doc
📖 fix/update go/v4 plugin page doc after the stabilization
2 parents b20f296 + 05c05e2 commit 411a639

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

docs/book/src/plugins/go-v4-plugin.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# go/v4 (go.kubebuilder.io/v4)
1+
# [Default Scaffold] go/v4 (go.kubebuilder.io/v4)
22

33
Kubebuilder will scaffold using the `go/v4` plugin only if specified when initializing the project.
4-
This plugin is a composition of the plugins ` kustomize.common.kubebuilder.io/v2-alpha` and `base.go.kubebuilder.io/v4`.
4+
This plugin is a composition of the plugins ` kustomize.common.kubebuilder.io/v2` and `base.go.kubebuilder.io/v4`.
55
It scaffolds a project template that helps in constructing sets of [controllers][controller-runtime].
66

77
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
1717

1818
## When to use it ?
1919

20-
- If you are looking to scaffold Golang projects to develop projects using [controllers][controller-runtime]
21-
- If you are looking to experiment with the future default scaffold that will be provided by Kubebuilder CLI
22-
- If your local environment is Apple Silicon (`darwin/arm64`)
23-
- If you are looking to use [kubernetes-sigs/kustomize][kustomize] v5
24-
- If you are looking to have your project update with the latest version available
25-
- if you are not targeting k8s versions < `1.16` and `1.20` if you are using webhooks
26-
- If you are looking to work on with scaffolds which are compatible with k8s `1.25+`
27-
- If you are looking for the new layout following the [Standard Go Project Layout][standard-go-project] where
28-
the "api(s)" are scaffold under the `api` directory, "controller(s)" under `internal`, and the `main.go` under `cmd`
20+
If you are looking to scaffold Golang projects to develop projects using [controllers][controller-runtime]
2921

3022
<aside class="note">
3123

@@ -54,7 +46,7 @@ kubebuilder init --domain tutorial.kubebuilder.io --repo tutorial.kubebuilder.io
5446
## Further resources
5547

5648
- To see the composition of plugins, you can check the source code for the Kubebuilder [main.go][plugins-main].
57-
- Check the code implementation of the [base Golang plugin `base.go.kubebuilder.io/v3`][v3-plugin].
49+
- Check the code implementation of the [base Golang plugin `base.go.kubebuilder.io/v4`][v4-plugin].
5850
- Check the code implementation of the [Kustomize/v2 plugin][kustomize-plugin].
5951
- Check [controller-runtime][controller-runtime] to know more about controllers.
6052

@@ -65,3 +57,4 @@ kubebuilder init --domain tutorial.kubebuilder.io --repo tutorial.kubebuilder.io
6557
[kustomize-plugin]: ../plugins/kustomize-v2.md
6658
[kustomize]: https://github.com/kubernetes-sigs/kustomize
6759
[standard-go-project]: https://github.com/golang-standards/project-layout
60+
[v4-plugin]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/pkg/plugins/golang/v4

0 commit comments

Comments
 (0)