Skip to content

Commit

Permalink
📖 Update docs for release 3.8.0 (kubernetes-sigs#3109)
Browse files Browse the repository at this point in the history
* Fix nil pointer in Finalizer example

* 📖 fix link for platform support

* update kubebuilder core dependencies for k8s 1.25

Signed-off-by: Bryce Palmer <bpalmer@redhat.com>

* docs: notify deps install to build book

* Update controller-tools version (v0.9.2->v0.10.0)

* 🐛 remove duplicate words and fix spelling mistakes

* ✨ update kubebuilder kubernetes version

* Update the export path of webhook

* 📖 fix broken links

* fixing the kubebuilder install locally curl request

* add dependency bot updates

* 🌱 Bump actions/checkout from 2 to 3

Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v2...v3)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* 🌱 Bump actions/setup-go from 2 to 3

Bumps [actions/setup-go](https://github.com/actions/setup-go) from 2 to 3.
- [Release notes](https://github.com/actions/setup-go/releases)
- [Commits](actions/setup-go@v2...v3)

---
updated-dependencies:
- dependency-name: actions/setup-go
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* 🌱 Bump goreleaser/goreleaser-action from 2 to 3

Bumps [goreleaser/goreleaser-action](https://github.com/goreleaser/goreleaser-action) from 2 to 3.
- [Release notes](https://github.com/goreleaser/goreleaser-action/releases)
- [Commits](goreleaser/goreleaser-action@v2...v3)

---
updated-dependencies:
- dependency-name: goreleaser/goreleaser-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump github.com/spf13/afero from 1.6.0 to 1.9.2

Bumps [github.com/spf13/afero](https://github.com/spf13/afero) from 1.6.0 to 1.9.2.
- [Release notes](https://github.com/spf13/afero/releases)
- [Commits](spf13/afero@v1.6.0...v1.9.2)

---
updated-dependencies:
- dependency-name: github.com/spf13/afero
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump github.com/onsi/gomega from 1.19.0 to 1.20.2

Bumps [github.com/onsi/gomega](https://github.com/onsi/gomega) from 1.19.0 to 1.20.2.
- [Release notes](https://github.com/onsi/gomega/releases)
- [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md)
- [Commits](onsi/gomega@v1.19.0...v1.20.2)

---
updated-dependencies:
- dependency-name: github.com/onsi/gomega
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump github.com/sirupsen/logrus from 1.8.1 to 1.9.0

Bumps [github.com/sirupsen/logrus](https://github.com/sirupsen/logrus) from 1.8.1 to 1.9.0.
- [Release notes](https://github.com/sirupsen/logrus/releases)
- [Changelog](https://github.com/sirupsen/logrus/blob/master/CHANGELOG.md)
- [Commits](sirupsen/logrus@v1.8.1...v1.9.0)

---
updated-dependencies:
- dependency-name: github.com/sirupsen/logrus
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump k8s.io/apimachinery from 0.25.0 to 0.25.2

Bumps [k8s.io/apimachinery](https://github.com/kubernetes/apimachinery) from 0.25.0 to 0.25.2.
- [Release notes](https://github.com/kubernetes/apimachinery/releases)
- [Commits](kubernetes/apimachinery@v0.25.0...v0.25.2)

---
updated-dependencies:
- dependency-name: k8s.io/apimachinery
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump github.com/gobuffalo/flect from 0.2.5 to 0.3.0

Bumps [github.com/gobuffalo/flect](https://github.com/gobuffalo/flect) from 0.2.5 to 0.3.0.
- [Release notes](https://github.com/gobuffalo/flect/releases)
- [Commits](gobuffalo/flect@v0.2.5...v0.3.0)

---
updated-dependencies:
- dependency-name: github.com/gobuffalo/flect
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* docs: describe e2e test towards plugin

Co-authored-by: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com>

* 🌱 remove WORKSPACE file commited by mistake

* remove unused value

* Bump github.com/spf13/cobra from 1.4.0 to 1.5.0

Bumps [github.com/spf13/cobra](https://github.com/spf13/cobra) from 1.4.0 to 1.5.0.
- [Release notes](https://github.com/spf13/cobra/releases)
- [Commits](spf13/cobra@v1.4.0...v1.5.0)

---
updated-dependencies:
- dependency-name: github.com/spf13/cobra
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump github.com/onsi/ginkgo/v2 from 2.1.6 to 2.2.0

Bumps [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) from 2.1.6 to 2.2.0.
- [Release notes](https://github.com/onsi/ginkgo/releases)
- [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md)
- [Commits](onsi/ginkgo@v2.1.6...v2.2.0)

---
updated-dependencies:
- dependency-name: github.com/onsi/ginkgo/v2
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump github.com/cloudflare/cfssl from 1.5.0 to 1.6.3

Bumps [github.com/cloudflare/cfssl](https://github.com/cloudflare/cfssl) from 1.5.0 to 1.6.3.
- [Release notes](https://github.com/cloudflare/cfssl/releases)
- [Changelog](https://github.com/cloudflare/cfssl/blob/master/CHANGELOG)
- [Commits](cloudflare/cfssl@v1.5.0...v1.6.3)

---
updated-dependencies:
- dependency-name: github.com/cloudflare/cfssl
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* update simple-external-plugin-tutorial

* update mdbook

* ⚠️ remove config-gen alpha option

* 📖 clarifies plugins available and its usage

* 📖 update doc samples

* ✨ (go/v4-alpha) : update kustomize version from 4.5.5 to 4.5.7

* ✨ (grafana/v1-alpha) : add custom units for custom grafana dashboards (kubernetes-sigs#2965)

:sparkles: add custom units for custom grafana dashboards

Signed-off-by: Jirka Kremser <jiri.kremser@gmail.com>

Signed-off-by: Jirka Kremser <jiri.kremser@gmail.com>

* cleanup: cert-manager and prometheus installs into e2e tests

* Apply suggestions from code review

* fixed bug for component-config flag

updated testdata

* Make jmrodri and varsha admins

Signed-off-by: jesus m. rodriguez <jesusr@redhat.com>

* Bump github.com/onsi/gomega from 1.20.2 to 1.21.1

Bumps [github.com/onsi/gomega](https://github.com/onsi/gomega) from 1.20.2 to 1.21.1.
- [Release notes](https://github.com/onsi/gomega/releases)
- [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md)
- [Commits](onsi/gomega@v1.20.2...v1.21.1)

---
updated-dependencies:
- dependency-name: github.com/onsi/gomega
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* 📖 Updating doc with Installation steps of cert-manager and prometheus (kubernetes-sigs#2982)

* Adding installing steps for testing webhooks

Adding installing steps for testing webhooks

Adding installing steps for testing webhooks

Adding installing steps for testing webhooks

Adding installing steps for testing webhooks

Adding installing steps for testing webhooks

Adding installing steps for testing webhooks

Adding installing steps for testing webhooks

Adding installing steps for testing webhooks

Adding installing steps for testing webhooks

Adding installing steps for testing webhooks

Adding installing steps for testing webhooks

* Adding installing steps for testing webhooks

* Adding installing steps for testing webhooks

* Adding installing steps for testing webhooks

* 🐛 : leader-elect arg scaffolded should be scaffolded when component config option is not used (kubernetes-sigs#3013)

* updated templates for component config

* updates

* update

* update revert main.go

* update revert main.go

* revert changes and go thru docs once

* Update make build cmd with manifests

* Bump github.com/spf13/cobra from 1.5.0 to 1.6.0

Bumps [github.com/spf13/cobra](https://github.com/spf13/cobra) from 1.5.0 to 1.6.0.
- [Release notes](https://github.com/spf13/cobra/releases)
- [Commits](spf13/cobra@v1.5.0...v1.6.0)

---
updated-dependencies:
- dependency-name: github.com/spf13/cobra
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump golang.org/x/text from 0.3.7 to 0.4.0

Bumps [golang.org/x/text](https://github.com/golang/text) from 0.3.7 to 0.4.0.
- [Release notes](https://github.com/golang/text/releases)
- [Commits](golang/text@v0.3.7...v0.4.0)

---
updated-dependencies:
- dependency-name: golang.org/x/text
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* :seeding: update CLI deps

* golangci-lint: add recommended revive checks to linter-settings but disable checks with to many findings. Fix findings

* Improve rendering of the documentation

This fixes various rendering issues:

* Wrong or uninterpreted formatting
* Some missing links
* Incorrect markup
* Missing documentation pages

This doesn't fix all the links but at least the initial ones.

* update cronjob to use batchv1 api

* Fix grammar in comment

Change `these is` to `these are`

* Enable revive unused-parameter check and fix findings

* Bump github.com/onsi/ginkgo/v2 from 2.3.1 to 2.4.0

Bumps [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) from 2.3.1 to 2.4.0.
- [Release notes](https://github.com/onsi/ginkgo/releases)
- [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md)
- [Commits](onsi/ginkgo@v2.3.1...v2.4.0)

---
updated-dependencies:
- dependency-name: github.com/onsi/ginkgo/v2
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump github.com/spf13/cobra from 1.6.0 to 1.6.1

Bumps [github.com/spf13/cobra](https://github.com/spf13/cobra) from 1.6.0 to 1.6.1.
- [Release notes](https://github.com/spf13/cobra/releases)
- [Commits](spf13/cobra@v1.6.0...v1.6.1)

---
updated-dependencies:
- dependency-name: github.com/spf13/cobra
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update github workflow to use same golangci-lint minor version as Makefile

* fix docker buildx args

Signed-off-by: Mikhail Sidorov <mixity@yandex.ru>

* 🐛 (kustomize/v2-alpha): Fix typo issue in the labels added to the manifests (kubernetes-sigs#3047)

* Fix typo in kubernets (missing 'e')

* make generate

* Add KB project git-repo and edit icons

* Add doc FAQ section

* docs: supplement plugin creation

* Update joelanford/go-apidiff (v0.4.0 -> v0.5.0)

* Bump github.com/onsi/gomega from 1.22.1 to 1.23.0

Bumps [github.com/onsi/gomega](https://github.com/onsi/gomega) from 1.22.1 to 1.23.0.
- [Release notes](https://github.com/onsi/gomega/releases)
- [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md)
- [Commits](onsi/gomega@v1.22.1...v1.23.0)

---
updated-dependencies:
- dependency-name: github.com/onsi/gomega
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump github.com/onsi/gomega from 1.23.0 to 1.24.0

Bumps [github.com/onsi/gomega](https://github.com/onsi/gomega) from 1.23.0 to 1.24.0.
- [Release notes](https://github.com/onsi/gomega/releases)
- [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md)
- [Commits](onsi/gomega@v1.23.0...v1.24.0)

---
updated-dependencies:
- dependency-name: github.com/onsi/gomega
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump github.com/onsi/ginkgo/v2 from 2.4.0 to 2.5.0

Bumps [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) from 2.4.0 to 2.5.0.
- [Release notes](https://github.com/onsi/ginkgo/releases)
- [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md)
- [Commits](onsi/ginkgo@v2.4.0...v2.5.0)

---
updated-dependencies:
- dependency-name: github.com/onsi/ginkgo/v2
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump github.com/spf13/afero from 1.9.2 to 1.9.3

Bumps [github.com/spf13/afero](https://github.com/spf13/afero) from 1.9.2 to 1.9.3.
- [Release notes](https://github.com/spf13/afero/releases)
- [Commits](spf13/afero@v1.9.2...v1.9.3)

---
updated-dependencies:
- dependency-name: github.com/spf13/afero
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump golang.org/x/tools from 0.2.0 to 0.3.0

Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.2.0 to 0.3.0.
- [Release notes](https://github.com/golang/tools/releases)
- [Commits](golang/tools@v0.2.0...v0.3.0)

---
updated-dependencies:
- dependency-name: golang.org/x/tools
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump github.com/onsi/gomega from 1.24.0 to 1.24.1

Bumps [github.com/onsi/gomega](https://github.com/onsi/gomega) from 1.24.0 to 1.24.1.
- [Release notes](https://github.com/onsi/gomega/releases)
- [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md)
- [Commits](onsi/gomega@v1.24.0...v1.24.1)

---
updated-dependencies:
- dependency-name: github.com/onsi/gomega
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* fix typo in Makefile

* ✨ add version check for makefile template tools (kubernetes-sigs#3077)

* add version check for makefile template tools

Prevent running controller-gen and kustomize commands with a version that does
not match the one specified in the corresponding CONTROLLER_TOOLS_VERSION or
KUSTOMIZE_VERSION vars

Addresses kubernetes-sigs#3068

* Update makefile target descriptions

* Updated descriptions for `kustomize` and `controller-gen` targets.
* Reformatted `controller-gen` recipe to reduce line length

Signed-off-by: Eduardo Coria <emcoria@us.ibm.com>

* update makefile samples

Signed-off-by: Eduardo Coria <emcoria@us.ibm.com>

Signed-off-by: Eduardo Coria <emcoria@us.ibm.com>

* fix unexpected end of file error in makefiles

Signed-off-by: Eduardo Coria <emcoria@us.ibm.com>

* ✨ Add go/v4 base and migration guide

Co-authored-by: Varsha <varshaprasad96@gmail.com>

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

Co-authored-by: Varsha <varshaprasad96@gmail.com>

* Update docs/book/src/migration/legacy.md

Co-authored-by: Varsha <varshaprasad96@gmail.com>

* Update docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md

Co-authored-by: Varsha <varshaprasad96@gmail.com>

* Update docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md

Co-authored-by: Varsha <varshaprasad96@gmail.com>

* Update docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md

Co-authored-by: Varsha <varshaprasad96@gmail.com>

* (go/v3,go/v4-alpha): Upgrade controller-runtime version from 1.13.0 to 1.13.1

* 📖 : suggest specify plugin for pr

* Bump github.com/onsi/ginkgo/v2 from 2.5.0 to 2.5.1

Bumps [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) from 2.5.0 to 2.5.1.
- [Release notes](https://github.com/onsi/ginkgo/releases)
- [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md)
- [Commits](onsi/ginkgo@v2.5.0...v2.5.1)

---
updated-dependencies:
- dependency-name: github.com/onsi/ginkgo/v2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* docs: fix typo in the component config tutorial

Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com>

* 🌱: refact testdata

* ✨ (kustomize/v2-alpha): add kustomize file to track crd sample info

* add action to lint yaml

and fix existing yamllint failures

Signed-off-by: Bryce Palmer <bpalmer@redhat.com>

* update yamllint to now be run via Makefile

Signed-off-by: Bryce Palmer <bpalmer@redhat.com>

* run yamllint target as part of lint target

Signed-off-by: Bryce Palmer <bpalmer@redhat.com>

* add yamllint job back as the lint job only runs golangci-lint

Signed-off-by: Bryce Palmer <bpalmer@redhat.com>

* bump proxy image

* fix: Remove trailing space making yamllint fail on new project

* (kustomize/v2-alpha): change kustomization file to track samples to use marker instead of overwritting

* (deployimage/v1-alpha): fix error to scaffold go/v4-alpha projects

* Replace restricted-access ComponentConfig design doc link with the public one

Signed-off-by: Michail Resvanis <mresvani@redhat.com>

Signed-off-by: Bryce Palmer <bpalmer@redhat.com>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Jirka Kremser <jiri.kremser@gmail.com>
Signed-off-by: jesus m. rodriguez <jesusr@redhat.com>
Signed-off-by: Mikhail Sidorov <mixity@yandex.ru>
Signed-off-by: Eduardo Coria <emcoria@us.ibm.com>
Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com>
Signed-off-by: Michail Resvanis <mresvani@redhat.com>
Co-authored-by: Simon Jürgensmeyer <6493966+sj14@users.noreply.github.com>
Co-authored-by: Kubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com>
Co-authored-by: Camila Macedo <cmacedo@redhat.com>
Co-authored-by: Bryce Palmer <bpalmer@redhat.com>
Co-authored-by: Tony <kavinjsir@gmail.com>
Co-authored-by: Oscar Utbult <oscar.utbult@gmail.com>
Co-authored-by: Yash Singh <syash@vmware.com>
Co-authored-by: Abhishek koserwal <akoserwa@redhat.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jirka Kremser <535866+jkremser@users.noreply.github.com>
Co-authored-by: laxmikantbpandhare <laxmikantpandhare@gmail.com>
Co-authored-by: jesus m. rodriguez <jesusr@redhat.com>
Co-authored-by: Phillip Wittrock <Phil.Wittrock@gmail.com>
Co-authored-by: Yash Singh <99066083+yashsingh74@users.noreply.github.com>
Co-authored-by: Laxmikant Bhaskar Pandhare <47066536+laxmikantbpandhare@users.noreply.github.com>
Co-authored-by: astraw99 <wangchengiscool@gmail.com>
Co-authored-by: Jonathan Ballet <jon@multani.info>
Co-authored-by: Krishna Indani <indanikrishna@gmail.com>
Co-authored-by: Nicholas Seemiller <seemiller@gmail.com>
Co-authored-by: Mikhail Sidorov <mixity@yandex.ru>
Co-authored-by: Marc Villacorta <h0tbird@github.com>
Co-authored-by: Shunsuke Ise <ise@ebiiim.com>
Co-authored-by: Eduardo M Coria <coriaedu@gmail.com>
Co-authored-by: Eduardo Coria <emcoria@us.ibm.com>
Co-authored-by: Varsha <varshaprasad96@gmail.com>
Co-authored-by: Andreas Gerstmayr <agerstmayr@redhat.com>
Co-authored-by: Erik Godding Boye <egboye@gmail.com>
Co-authored-by: Michail Resvanis <mresvani@redhat.com>
  • Loading branch information
1 parent 7f49590 commit 78d9fe6
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
- [Migration by updating the files](migration/legacy/manually_migration_guide_v2_v3.md)
- [From v3.0.0 with plugins](./migration/v3-plugins.md)
- [go/v3 vs go/v4-alpha](migration/v3vsv4.md)

- [Migration Guide](migration/migration_guide_gov3_to_gov4.md)
- [Migration by updating the files](migration/manually_migration_guide_gov3_to_gov4.md)
- [Single Group to Multi-Group](./migration/multi-group.md)
Expand Down
18 changes: 9 additions & 9 deletions docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ The recommended upgrade approach is to follow the [Migration Guide go/v3 to go/v

## Migration from project config version "go/v3" to "go/v4"

Update the `PROJECT` file layout which stores information about the resources that are used to enable plugins make
Update the `PROJECT` file layout which stores information about the resources that are used to enable plugins make
useful decisions while scaffolding. The `layout` field indicates the scaffolding and the primary plugin version in use.

### Steps to migrate

#### Migrate the layout version into the PROJECT file

The following steps describe the manual changes required to bring the project configuration file (`PROJECT`).
The following steps describe the manual changes required to bring the project configuration file (`PROJECT`).
These change will add the information that Kubebuilder would add when generating the file. This file can be found in the root directory.

Update the PROJECT file by replacing:
Expand Down Expand Up @@ -64,7 +64,7 @@ Therefore, you can check the changes in the layout results into:

- Create a new directory `cmd` and move the `main.go` under it.
- If your project support multi-group the APIs are scaffold under a directory called `apis`. Rename this directory to `api`
- Move the `controllers` directory under the `internal` and rename it for `controller`
- Move the `controllers` directory under the `internal` and rename it for `controller`
- Now ensure that the imports will be updated accordingly by:
- Update the `main.go` imports to look for the new path of your controllers under the `pkg` directory

Expand Down Expand Up @@ -136,17 +136,17 @@ Note that if your project has multiple groups (`multigroup:true`) then the above
The PROJECT tracks the paths of all APIs used in your project. Ensure that they now point to `api/...` as the following example:

Before update:
group: crew
kind: Captain
path: sigs.k8s.io/kubebuilder/testdata/project-v4/apis/crew/v1
group: crew
kind: Captain
path: sigs.k8s.io/kubebuilder/testdata/project-v4/apis/crew/v1
```
After Update:
```
group: crew
kind: Captain
path: sigs.k8s.io/kubebuilder/testdata/project-v4/api/crew/v1
group: crew
kind: Captain
path: sigs.k8s.io/kubebuilder/testdata/project-v4/api/crew/v1
```
### Update kustomize manifests with the changes made so far
Expand Down
4 changes: 2 additions & 2 deletions docs/book/src/migration/v3vsv4.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ The details of all changes (breaking or otherwise) can be found in:
- no longer scaffold webhook test files with `"k8s.io/api/admission/v1beta1"` the k8s API which is no longer served since k8s `1.25`. By default
webhooks test files are scaffolding using `"k8s.io/api/admission/v1"` which is support from k8s `1.20`
- no longer provide backwards compatible support with k8s versions < `1.16`
- change the layout to accommodate the community request to follow the [Standard Go Project Layout][standard-go-project]
by moving the api(s) under a new directory called `api`, controller(s) under a new directory called `internal` and the `main.go` under a new directory named `cmd`
- change the layout to accommodate the community request to follow the [Standard Go Project Layout][standard-go-project]
by moving the api(s) under a new directory called `api`, controller(s) under a new directory called `internal` and the `main.go` under a new directory named `cmd`

<aside class="note">
<H1> TL;DR of the New `go/v4-alpha` Plugin </H1>
Expand Down
12 changes: 6 additions & 6 deletions docs/book/src/plugins/creating-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ In this way, currently, you can [Extend the CLI][extending-cli] and use the `Bun

```go
mylanguagev1Bundle, _ := plugin.NewBundle(language.DefaultNameQualifier, plugin.Version{Number: 1},
kustomizecommonv1.Plugin{}, // extend the common base from Kubebuilder
mylanguagev1.Plugin{}, // your plugin language which will do the scaffolds for the specific language on top of the common base
)
kustomizecommonv1.Plugin{}, // extend the common base from Kubebuilder
mylanguagev1.Plugin{}, // your plugin language which will do the scaffolds for the specific language on top of the common base
)
```

If you do not want to develop your plugin using Golang, you can follow its standard by using the binary as follows:
Expand Down Expand Up @@ -170,9 +170,9 @@ Alternatively, you can create a plugin bundle to include the target plugins. For

```go
mylanguagev1Bundle, _ := plugin.NewBundle(language.DefaultNameQualifier, plugin.Version{Number: 1},
kustomizecommonv1.Plugin{}, // extend the common base from Kuebebuilder
mylanguagev1.Plugin{}, // your plugin language which will do the scaffolds for the specific language on top of the common base
)
kustomizecommonv1.Plugin{}, // extend the common base from Kuebebuilder
mylanguagev1.Plugin{}, // your plugin language which will do the scaffolds for the specific language on top of the common base
)
```

[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
Expand Down
14 changes: 7 additions & 7 deletions docs/book/src/plugins/go-v4-plugin.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# go/v4-alpha (go.kubebuilder.io/v4-alpha)

Kubebuilder will scaffold using the `go/v4-alpha` 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-alpha`.
It scaffolds a project template that helps in constructing sets of [controllers][controller-runtime].
Kubebuilder will scaffold using the `go/v4-alpha` 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-alpha`.
It scaffolds a project template that helps in constructing sets of [controllers][controller-runtime].

It scaffolds boilerplate code to create and design controllers.
It scaffolds boilerplate code to create and design controllers.
Note that by following the [quickstart][quickstart] you will be using this plugin.
<aside class="note">

<h1>Examples</h1>

You can check samples using this plugin by looking at the `project-v4-<options>` projects
You can check samples using this plugin by looking at the `project-v4-<options>` projects
under the [testdata][testdata] directory on the root directory of the Kubebuilder project.

</aside>
Expand All @@ -24,8 +24,8 @@ under the [testdata][testdata] directory on the root directory of the Kubebuilde
- 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 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`

<aside class="note">

Expand Down

0 comments on commit 78d9fe6

Please sign in to comment.