Skip to content

Commit 9e433c8

Browse files
authored
Merge pull request #2833 from camilamacedo86/change-over
📖 small update plugins doc
2 parents 6915367 + e1f522d commit 9e433c8

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

docs/book/src/SUMMARY.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -106,17 +106,17 @@
106106

107107
- [Plugins][plugins]
108108

109+
- [Available Plugins](./plugins/available-plugins.md)
110+
- [go/v2 (Deprecated)](./plugins/go-v2-plugin.md)
111+
- [go/v3 (Default init scaffold)](./plugins/go-v3-plugin.md)
112+
- [go/v4-alpha](./plugins/go-v4-plugin.md)
113+
- [kustomize/v1](./plugins/kustomize-v1.md)
114+
- [kustomize/v2-alpha](./plugins/kustomize-v2-alpha.md)
115+
- [declarative/v1](./plugins/declarative-v1.md)
116+
- [grafana/v1-alpha](./plugins/grafana-v1-alpha.md)
117+
- [deploy-image/v1-alpha](./plugins/deploy-image-plugin-v1-alpha.md)
109118
- [Extending the CLI](./plugins/extending-cli.md)
110119
- [Creating your own plugins](./plugins/creating-plugins.md)
111-
- [Available Plugins](./plugins/available-plugins.md)
112-
- [go/v2 plugin (Deprecated)](./plugins/go-v2-plugin.md)
113-
- [go/v3 plugin](./plugins/go-v3-plugin.md)
114-
- [go/v4-alpha plugin](./plugins/go-v4-plugin.md)
115-
- [Kustomize V1](./plugins/kustomize-v1.md)
116-
- [Kustomize v2 Alpha](./plugins/kustomize-v2-alpha.md)
117-
- [Declarative V1 (Optional Feature)](./plugins/declarative-v1.md)
118-
- [Grafana V1 Alpha (Optional Feature)](./plugins/grafana-v1-alpha.md)
119-
- [Deploy Image V1 Alpha (Optional Feature)](./plugins/deploy-image-plugin-v1-alpha.md)
120120
- [Plugins Versioning](./plugins/plugins-versioning.md)
121121

122122
---

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,15 @@ This section describes the plugins supported and shipped in with the Kubebuilder
66
| ---------------------------------------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
77
| [go.kubebuilder.io/v2 - (Deprecated)](go-v2-plugin.md) | `go/v2` | Golang plugin responsible for scaffolding the legacy layout provided with Kubebuilder CLI >= `2.0.0` and < `3.0.0`. |
88
| [go.kubebuilder.io/v3 - (Default scaffold with Kubebuilder init)](go-v3-plugin.md) | `go/v3` | Default scaffold used for creating a project when no plugin(s) are provided. Responsible for scaffolding Golang projects and its configurations. |
9+
| [go.kubebuilder.io/v4-alpha - (Add Apple Sillicom Support)](go-v4-plugin.md) | `go/v4` | Scaffold composite by `base.go.kubebuilder.io/v3` and [kustomize.common.kubebuilder.io/v2-alpha](kustomize-v2-alpha.md). Responsible for scaffolding Golang projects and its configurations. |
910
| [declarative.go.kubebuilder.io/v1](declarative-v1.md) | `declarative/v1` | Optional plugin used to scaffold APIs/controllers using the [kubebuilder-declarative-pattern][kubebuilder-declarative-pattern] project. |
1011
| [kustomize.common.kubebuilder.io/v1](kustomize-v1.md) | `kustomize/v1` | Responsible for scaffold all manifests to configure the projects with [kustomize(v3)][kustomize]. (create and update the the `config/` directory). This plugin is used in the composition to create the plugin (`go/v3`). |
1112
| [kustomize.common.kubebuilder.io/v2-alpha](kustomize-v2-alpha.md) | `kustomize/v2-alpha` | It has the same purpose of `kustomize/v1`. However, it works with [kustomize][kustomize] version `v4` and addresses the required changes for future kustomize configurations. It will probably be used with the future `go/v4-alpha` plugin. |
1213
| `base.go.kubebuilder.io/v3` | `base/v3` | Responsible for scaffold all files which specific requires Golang. This plugin is used in the composition to create the plugin (`go/v3`) |
13-
| [grafana.kubebuilder.io/v1-alpha](grafana-v1-alpha.md) | `grafana/v1-alpha` | Optional plugin which can be used to scaffold Grafana Manifests Dashboards for the default metrics which are exported by controller-runtime. |
14+
| [grafana.kubebuilder.io/v1-alpha](grafana-v1-alpha.md) | `grafana/v1-alpha` | Optional helper plugin which can be used to scaffold Grafana Manifests Dashboards for the default metrics which are exported by controller-runtime. |
15+
| [deploy-image.go.kubebuilder.io/v1-alpha](deploy-image-plugin-v1-alpha) | `deploy-image/v1-alpha` | Optional helper plugin which can be used to scaffold APIs and controller with code implementation to Deploy and Manage an Operand(image). |
16+
17+
> Note: **ALPHA** plugins can introduce breaking changes. For further info see [Plugins Versioning](./plugins/plugins-versioning.md).
1418
1519
<aside class="note">
1620

0 commit comments

Comments
 (0)