(docs/infra): migrate book to mdbook v0.5.0

The migration from mdbook v0.4.40 to v0.5.0
introduces a few nice features that will provide
better UX and DX.

Author: vitorfloriano

docs/book/book.toml

@@ -1,6 +1,5 @@
 [book]
 authors = ["The Kubebuilder Maintainers"]
-multilingual = false
 src = "src"
 title = "The Kubebuilder Book"
 
@@ -17,9 +16,3 @@ command = "./litgo.sh"
 
 [preprocessor.markerdocs]
 command = "./markerdocs.sh"
-
-[context.environment]
-  environment = { GO_VERSION = "1.23" }
-
-[context.deploy-preview.environment]
-  environment = { GO_VERSION = "1.23" }

docs/book/install-and-build.sh

@@ -39,7 +39,7 @@ if [[ ${arch} == "amd64" ]]; then
 elif [[ ${arch} == "x86" ]]; then
     arch="i686"
 elif [[ ${arch} == "arm64" ]]; then
-    # arm64 is not supported for v0.4.40 mdbook, so using x86_64 type. 
+    # arm64 is not supported for v0.4.40 mdbook, so using x86_64 type.
     # Once the mdbook is upgraded to latest, use 'aarch64'
     arch="x86_64"
 fi
@@ -58,7 +58,7 @@ case ${os} in
         ;;
     linux)
         # works for linux, too
-        target="unknown-${os}-gnu"
+        target="unknown-${os}-musl"
         ;;
     *)
         target="unknown-${os}"
@@ -67,7 +67,7 @@ esac
 
 # grab mdbook
 # we hardcode linux/amd64 since rust uses a different naming scheme and it's a pain to tran
-MDBOOK_VERSION="v0.4.40"
+MDBOOK_VERSION="v0.5.0"
 MDBOOK_BASENAME="mdBook-${MDBOOK_VERSION}-${arch}-${target}"
 MDBOOK_URL="https://github.com/rust-lang/mdBook/releases/download/${MDBOOK_VERSION}/${MDBOOK_BASENAME}.${ext}"
 

docs/book/src/introduction.md

@@ -1,7 +1,8 @@
-**Note:** Impatient readers may head straight to [Quick Start](quick-start.md).
+>[!Tip]
+>Impatient readers may head straight to [Quick Start](quick-start.md).
 
-**Using previous version of Kubebuilder v1 or v2?**
-**Check the legacy documentation for [v1](https://book-v1.book.kubebuilder.io), [v2](https://book-v2.book.kubebuilder.io) or [v3](https://book-v3.book.kubebuilder.io)**
+>[!Important]
+>Using previous version of Kubebuilder? Check the legacy documentation for [v1](https://book-v1.book.kubebuilder.io), [v2](https://book-v2.book.kubebuilder.io) or [v3](https://book-v3.book.kubebuilder.io).
 
 ## Who is this for
 

docs/book/src/logos/favicon.png

@@ -60,7 +60,9 @@ mv internal/webhook/* internal/webhook/batch/
 For any new webhook created for a new group, the respective functions will be created under subdirectory `internal/webhook/<group>/`.
 
 <aside class="note">
+
 <h1>If you are using the deprecated layout go/v3</h1>
+
 Then, your layout has not the internal directory. So, you will move the controller(s) under a directory with the name of the API group which it is responsible for manage.
 
 ```bash
@@ -127,6 +129,8 @@ The [CronJob tutorial][cronjob-tutorial] explains each of these changes in
 more detail (in the context of how they're generated by Kubebuilder for
 single-group projects).
 
+</aside>
+
 [multi-group-issue]: https://github.com/kubernetes-sigs/kubebuilder/issues/923 "Kubebuilder Issue #923"
 [cronjob-tutorial]: /cronjob-tutorial/cronjob-tutorial.md "Tutorial: Building CronJob"
 [migration-guide]: /migration/migration_guide_gov3_to_gov4.md "Migration from go/v3 to go/v4"

docs/book/src/logos/kb-icon.svg renamed to docs/book/src/logos/favicon.svg

@@ -18,7 +18,7 @@ The following covers what you need to do to provide the support for one or more
 
 The images used in workloads such as in your Pods/Deployments will need to provide the support for this other platform.
 You can inspect the images using a ManifestList of supported platforms using the command
-[docker manifest inspect <image>][docker-manifest], i.e.:
+[`docker manifest inspect <image>`][docker-manifest], i.e.:
 
 ```shell
 $ docker manifest inspect myregistry/example/myimage:v0.0.1

docs/book/src/migration/multi-group.md

@@ -1,5 +1,5 @@
 /* Adds a thin border to the sidebar (aesthetics) */
-#sidebar {
+#mdbook-sidebar {
     border-right: 1px solid var(--theme-popup-border);
 }
 
@@ -36,6 +36,14 @@ html {
     text-decoration: solid underline var(--links);
 }
 
+/* Hides excessive theme options */
+#mdbook-theme-default_theme,
+#mdbook-theme-rust,
+#mdbook-theme-coal,
+#mdbook-theme-ayu {
+    display: none;
+}
+
 /* custom light theme */
 .light {
     --sidebar-bg: #eef5ff;

docs/book/src/reference/platform.md

@@ -7,6 +7,12 @@
  * extract the actual relevant information.  Theoretically, this'll let us do
  * stuff like transform the information for different screen widths. */
 
+/* Removes the counter from marker definitions */
+dd:has(+ dd)::before,
+dd + dd::before {
+    content: normal;
+}
+
 /* the marker */
 .marker {
     display: flex;
@@ -65,14 +71,14 @@
     font-style: inherit;
 }
 .marker dl.args.summary dt:first-child::before {
-    content: ':';
+    content: ":";
 }
 .marker dl.args.summary dt::before {
-    content: ',';
+    content: ",";
 }
 /* hide in non-summary view */
 .marker dd.args {
-    display: none
+    display: none;
 }
 
 /* the description */
@@ -85,7 +91,7 @@
 
 /* all arguments */
 .marker dl.args dt.argument::after {
-    content: '=';
+    content: "=";
 }
 .marker dl.args dd.type {
     font-style: italic;
@@ -98,14 +104,16 @@
     font-size: 0.875em;
 }
 .marker .literal {
-    font-family: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+    font-family:
+        "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono",
+        monospace, monospace;
     font-size: 0.875em; /* please adjust the ace font size accordingly in editor.js */
 }
 .marker .argument.type::before {
-    content: '‹';
+    content: "‹";
 }
 .marker .argument.type::after {
-    content: '›';
+    content: "›";
 }
 
 /* summary args */
@@ -134,7 +142,7 @@
 }
 
 .marker .type .slice::before {
-    content: '[]';
+    content: "[]";
 }
 
 /* description args */
@@ -158,10 +166,10 @@
 
 /* summary view */
 .markers-summarize:checked ~ dl > .marker dd.args {
-    display: inline-block
+    display: inline-block;
 }
 .markers-summarize:checked ~ dl > .marker dd.description dl.args {
-    display: none
+    display: none;
 }
 .markers-summarize:checked ~ dl > .marker dd.description {
     margin-bottom: 0.25em;
@@ -172,11 +180,11 @@ input.markers-summarize {
 }
 label.markers-summarize::before {
     margin-right: 0.5em;
-    content: '\25bc';
+    content: "\25bc";
     display: inline-block;
 }
 input.markers-summarize:checked ~ label.markers-summarize::before {
-    content: '\25b6';
+    content: "\25b6";
 }
 
 /* misc */
@@ -280,7 +288,6 @@ details.collapse-code > summary::-webkit-details-marker {
     display: none;
 }
 
-
 /* diagrams */
 
 .diagrams {
@@ -296,12 +303,15 @@ details.collapse-code > summary::-webkit-details-marker {
     font-weight: bold;
 }
 
-.diagrams object, .diagrams svg {
+.diagrams object,
+.diagrams svg {
     max-width: 100%;
     max-height: 10em; /* force svg height to behave */
 }
 
-.diagrams path, .diagrams polyline, .diagrams circle {
+.diagrams path,
+.diagrams polyline,
+.diagrams circle {
     stroke: var(--fg);
 }
 
@@ -360,7 +370,9 @@ aside.note.warning > h1::before {
 /* literate source citations */
 cite.literate-source {
     font-size: 75%;
-    font-family: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+    font-family:
+        "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono",
+        monospace, monospace;
 }
 cite.literate-source::before {
     content: "$ ";