Skip to content

Commit

Permalink
make changes based on suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
Ashwin901 committed Apr 2, 2022
1 parent 7149ba4 commit 3eb61b1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
4 changes: 4 additions & 0 deletions docs/book/src/plugins/go-v2-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Only if you are looking to scaffold a project with the legacy layout. Otherwise,

<aside class="note warning">

<h1> Note </h1>

Be aware that this plugin version does not provide a scaffold compatible with the latest versions of the dependencies used in order to keep its backwards compatibility.

</aside>
Expand All @@ -27,6 +29,8 @@ kubebuilder init --domain tutorial.kubebuilder.io --repo tutorial.kubebuilder.io
```
<aside class="note">

<h1> Note </h1>

By creating a project with this plugin, the PROJECT file scaffold will be using the previous schema (_project version 2_). So that Kubebuilder CLI knows what plugin version was used and will call its subcommands such as `create api` and `create webhooks`. Note that further Golang plugins versions use the new Project file schema, which tracks the information about what plugins and versions have been used so far.

</aside>
Expand Down
6 changes: 3 additions & 3 deletions docs/book/src/plugins/go-v3-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Kubebuilder tool will scaffold the go/v3 plugin by default. This plugin is a composition of the plugins ` kustomize.common.kubebuilder.io/v1` and `base.go.kubebuilder.io/v3`. By using you can scaffold the default project which is a helper to construct sets of [controllers][controller-runtime].

It basically scaffolds all the boilerplate code required to create <b>and</b> design controllers. Note that by following the [quickstart][quickstart] you will be using this plugin.
It basically scaffolds all the boilerplate code required to create and design controllers. Note that by following the [quickstart][quickstart] you will be using this plugin.

<aside class="note">

Expand All @@ -14,7 +14,7 @@ Samples are provided under the [testdata][testdata] directory of the Kubebuilder

## When to use it

- <b>If</b> you are looking to scaffold Golang projects to develop projects using [controllers][controller-runtime]
- If you are looking to scaffold Golang projects to develop projects using [controllers][controller-runtime]

## How to use it ?

Expand All @@ -31,7 +31,7 @@ All the other subcommands supported by the go/v3 plugin can be executed similarl

<h1>Note</h1>

Also, <b>if</b> you need you can explicitly inform the plugin via the option provided `--plugins=go/v3`.
Also, if you need you can explicitly inform the plugin via the option provided `--plugins=go/v3`.

</aside>

Expand Down

0 comments on commit 3eb61b1

Please sign in to comment.