Refine information about compatibility and supportability of dependencies

Author: camilamacedo86

README.md

@@ -121,7 +121,7 @@ Before starting any work, please either comment on an existing issue, or file a
 
 ## Operating Systems Supported
 
-Currently, Kubebuilder officially supports macOS and Linux platforms. If you are using a Windows OS, you may encounter issues. 
+Currently, Kubebuilder officially supports macOS and Linux platforms. If you are using a Windows OS, you may encounter issues.
 Contributions towards supporting Windows are welcome.
 
 ## Versions Compatibility and Supportability
@@ -132,15 +132,25 @@ Projects created by Kubebuilder contain a `Makefile` that installs tools at vers
 - [controller-gen](https://github.com/kubernetes-sigs/controller-tools)
 - [setup-envtest](https://github.com/kubernetes-sigs/controller-runtime/tree/main/tools/setup-envtest)
 
-Additionally, these projects include a `go.mod` file specifying dependency versions. Kubebuilder relies on [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime) and its Go and Kubernetes dependencies. Therefore, the versions defined in the `Makefile` and `go.mod` files are the ones that have been tested, supported, and recommended.
+Additionally, these projects include a `go.mod` file specifying dependency versions.
+Kubebuilder relies on [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime) and its Go and Kubernetes dependencies.
+Therefore, the versions defined in the `Makefile` and `go.mod` files are the ones that have been tested, supported, and recommended.
 
-Each minor version of Kubebuilder is tested with a specific minor version of client-go. While a Kubebuilder minor version *may* be compatible with other client-go minor versions, this compatibility is not guaranteed, supported, or tested. Typically, a new minor version of Kubebuilder is created for each minor version of client-go and other k8s.io/* dependencies and tools.
+Each minor version of Kubebuilder is tested with a specific minor version of client-go.
+While a Kubebuilder minor version *may* be compatible with other client-go minor versions,
+or other tools this compatibility is not guaranteed, supported, or tested.
 
-The minimum Go version required by Kubebuilder is determined by the highest minimum Go version required by its dependencies. This is usually aligned with the minimum Go version required by the corresponding k8s.io/* dependencies.
+The minimum Go version required by Kubebuilder is determined by the highest minimum
+Go version required by its dependencies. This is usually aligned with the minimum
+Go version required by the corresponding `k8s.io/*` dependencies.
 
-Compatible k8s.io/* versions, client-go versions, and minimum Go versions can be found in the `go.mod` file scaffolded for each project for each tag release.
+Compatible `k8s.io/*` versions, client-go versions, and minimum Go versions can be found in the `go.mod`
+file scaffolded for each project for each [tag release](https://github.com/kubernetes-sigs/kubebuilder/tags).
 
-**Example:** For the `4.1.1` release, the minimum Go version compatibility is `1.22`. You can refer to the samples in the testdata directory of the tag released [v4.1.1](https://github.com/kubernetes-sigs/kubebuilder/tree/v4.1.1/testdata), such as the [go.mod](https://github.com/kubernetes-sigs/kubebuilder/blob/v4.1.1/testdata/project-v4/go.mod#L3) file for `project-v4`. You can also check the tools versions supported and tested for this release by examining the [Makefile](https://github.com/kubernetes-sigs/kubebuilder/blob/v4.1.1/testdata/project-v4/Makefile#L160-L165).
+**Example:** For the `4.1.1` release, the minimum Go version compatibility is `1.22`.
+You can refer to the samples in the testdata directory of the tag released [v4.1.1](https://github.com/kubernetes-sigs/kubebuilder/tree/v4.1.1/testdata),
+such as the [go.mod](https://github.com/kubernetes-sigs/kubebuilder/blob/v4.1.1/testdata/project-v4/go.mod#L3) file for `project-v4`. You can also check the tools versions supported and
+tested for this release by examining the [Makefile](https://github.com/kubernetes-sigs/kubebuilder/blob/v4.1.1/testdata/project-v4/Makefile#L160-L165).
 
 ## Community Meetings
 

docs/book/src/quick-start.md

@@ -15,13 +15,34 @@ This Quick Start guide will cover:
 - Access to a Kubernetes v1.11.3+ cluster.
 
 <aside class="note">
-<h1>Versions and Supportability</h1>
+<h1>Versions Compatibility and Supportability</h1>
+
+Projects created by Kubebuilder contain a `Makefile` that installs tools at versions defined during project creation.
+The main tools included are:
 
-Projects created by Kubebuilder contain a Makefile that will install tools at versions defined at creation time. Those tools are:
 - [kustomize](https://github.com/kubernetes-sigs/kustomize)
 - [controller-gen](https://github.com/kubernetes-sigs/controller-tools)
+- [setup-envtest](https://github.com/kubernetes-sigs/controller-runtime/tree/main/tools/setup-envtest)
+
+Additionally, these projects include a `go.mod` file specifying dependency versions.
+Kubebuilder relies on [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime) and its Go and Kubernetes dependencies.
+Therefore, the versions defined in the `Makefile` and `go.mod` files are the ones that have been tested, supported, and recommended.
+
+Each minor version of Kubebuilder is tested with a specific minor version of client-go.
+While a Kubebuilder minor version *may* be compatible with other client-go minor versions,
+or other tools this compatibility is not guaranteed, supported, or tested.
+
+The minimum Go version required by Kubebuilder is determined by the highest minimum
+Go version required by its dependencies. This is usually aligned with the minimum
+Go version required by the corresponding `k8s.io/*` dependencies.
+
+Compatible `k8s.io/*` versions, client-go versions, and minimum Go versions can be found in the `go.mod`
+file scaffolded for each project for each [tag release](https://github.com/kubernetes-sigs/kubebuilder/tags).
 
-The versions which are defined in the `Makefile` and `go.mod` files are the versions tested and therefore is recommended to use the specified versions.
+**Example:** For the `4.1.1` release, the minimum Go version compatibility is `1.22`.
+You can refer to the samples in the testdata directory of the tag released [v4.1.1](https://github.com/kubernetes-sigs/kubebuilder/tree/v4.1.1/testdata),
+such as the [go.mod](https://github.com/kubernetes-sigs/kubebuilder/blob/v4.1.1/testdata/project-v4/go.mod#L3) file for `project-v4`. You can also check the tools versions supported and
+tested for this release by examining the [Makefile](https://github.com/kubernetes-sigs/kubebuilder/blob/v4.1.1/testdata/project-v4/Makefile#L160-L165).
 
 </aside>