📖 Minor Documentation Improvements: Add Links, Fix Typos, and Clarify Instructions (#4093)

This pull request includes several small but important improvements to the documentation, aimed at enhancing clarity and providing additional resources:

- Added a link to the CronJob Tutorial in the "Next Steps" section of the Getting Started guide.
- Fixed minor issues with documentation headings and improved consistency in the Quick Start guide.
- Clarified the need to push images in the Running guide with an added note.
- Recommended using Kind for testing in the Getting Started guide.
- Corrected a typo in the link to the Kind guide.
- Added a brief note in the "Next Steps" section about the Deploy Image plugin to offer further guidance.

Author: camilamacedo86

docs/book/src/cronjob-tutorial/running-webhook.md

@@ -23,7 +23,7 @@ You can directly load your local image into your specified Kind cluster:
 kind load docker-image <your-image-name>:tag --name <your-kind-cluster-name>
 ```
 
-To now more see: [Kind for Dev & CI](./../reference/kind.md)
+To know more, see: [Using Kind For Development Purposes and CI](./../reference/kind.md)
 
 </aside>
 

docs/book/src/cronjob-tutorial/running.md

@@ -74,11 +74,26 @@ make deploy IMG=<some-registry>/<project-name>:tag
 ```
 
 <aside class="note">
-<h1>registry permission</h1>
+<h1>Registry Permission</h1>
 
 This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment.
 Make sure you have the proper permission to the registry if the above commands don't work.
 
+Consider incorporating Kind into your workflow for a faster, more efficient local development and CI experience.
+Note that, if you're using a Kind cluster, there's no need to push your image to a remote container registry.
+You can directly load your local image into your specified Kind cluster:
+
+```bash
+kind load docker-image <your-image-name>:tag --name <your-kind-cluster-name>
+```
+
+To know more, see: [Using Kind For Development Purposes and CI](./../reference/kind.md)
+
+<h1>RBAC errors</h1>
+
+If you encounter RBAC errors, you may need to grant yourself cluster-admin
+privileges or be logged in as admin. See [Prerequisites for using Kubernetes RBAC on GKE cluster v1.11.x and older][pre-rbc-gke] which may be your case.
+
 </aside>
 
 If we list cronjobs again like we did before, we should see the controller

docs/book/src/getting-started.md

@@ -510,11 +510,40 @@ By executing `make build IMG=myregistry/example:1.0.0`, you'll build the image f
 public registry. This ensures easy accessibility, eliminating the need for additional configurations. Once that's done, you can deploy the image
 to the cluster using the `make deploy IMG=myregistry/example:1.0.0` command.
 
+<aside class="note">
+<h1>Consider use Kind</h1>
+
+This image ought to be published in the personal registry you specified. And it is required to have access to pull the image
+from the working environment. Make sure you have the proper permission
+to the registry if the above commands don't work.
+
+Consider incorporating Kind into your workflow for a faster, more efficient local development and CI experience.
+Note that, if you're using a Kind cluster, there's no need to push your image to a remote container registry.
+You can directly load your local image into your specified Kind cluster:
+
+```bash
+kind load docker-image <your-image-name>:tag --name <your-kind-cluster-name>
+```
+
+For further information, see: [Using Kind For Development Purposes and CI](./reference/kind.md)
+
+</aside>
+
 ## Next Steps
 
-- To delve deeper into developing your solution, consider going through the provided tutorials.
+- To delve deeper into developing your solution, consider going through the [CronJob Tutorial][cronjob-tutorial]
 - For insights on optimizing your approach, refer to the [Best Practices][best-practices] documentation.
 
+<aside class="note">
+<h1> Using Deploy Image plugin to generate APIs and source code </h1>
+
+Now that you have a better understanding, you might want to check out the [Deploy Image][deploy-image] Plugin.
+This plugin allows users to scaffold APIs/Controllers to deploy and manage an Operand (image) on the cluster.
+It will provide scaffolds similar to the ones in this guide, along with additional features such as tests
+implemented for your controller.
+
+</aside>
+
 [k8s-operator-pattern]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/
 [controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
 [group-kind-oh-my]: ./cronjob-tutorial/gvks.md
@@ -527,3 +556,5 @@ to the cluster using the `make deploy IMG=myregistry/example:1.0.0` command.
 [options-manager]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/manager#Options
 [quick-start]: ./quick-start.md
 [best-practices]: ./reference/good-practices.md
+[cronjob-tutorial]: https://book.kubebuilder.io/cronjob-tutorial/cronjob-tutorial.html
+[deploy-image]: ./plugins/deploy-image-plugin-v1-alpha.md

docs/book/src/quick-start.md

@@ -220,7 +220,7 @@ make deploy IMG=<some-registry>/<project-name>:tag
 ```
 
 <aside class="note">
-<h1>Registry permission</h1>
+<h1>Registry Permission</h1>
 
 This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment.
 Make sure you have the proper permission to the registry if the above commands don't work.
@@ -233,7 +233,7 @@ You can directly load your local image into your specified Kind cluster:
 kind load docker-image <your-image-name>:tag --name <your-kind-cluster-name>
 ```
 
-To now more see: [Kind for Dev & CI](./reference/kind.md)
+To know more, see: [Using Kind For Development Purposes and CI](./reference/kind.md)
 
 <h1>RBAC errors</h1>
 
@@ -260,8 +260,8 @@ make undeploy
 
 ## Next Step
 
-Now, take a look at the [Architecture Concept Diagram][architecture-concept-diagram] for a clearer overview.
-Next, proceed with the [Getting Started Guide][getting-started], which should take no more than 30 minutes and will
+- Now, take a look at the [Architecture Concept Diagram][architecture-concept-diagram] for a clearer overview.
+- Next, proceed with the [Getting Started Guide][getting-started], which should take no more than 30 minutes and will
 provide a solid foundation. Afterward, dive into the [CronJob Tutorial][cronjob-tutorial] to deepen your
 understanding by developing a demo project.