Merge pull request #487 from furkatgofurov7/doc-improvements

📖 Improvements to book
kubernetes-sigs · Apr 10, 2024 · 6a8bcff · 6a8bcff
2 parents b8643e6 + 07d5594
commit 6a8bcff
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 6 deletions.
diff --git a/docs/book/README.md b/docs/book/README.md
@@ -0,0 +1,23 @@
+# Preview book changes locally
+
+It is easy to preview your local changes to the book before submitting a PR:
+
+1. Build the local copy of the book from the `docs/book` path:
+
+    ```shell
+    make build
+    ```
+
+1. To preview the book contents run:
+
+    ```shell
+    make serve
+    ```
+
+This should serve the book at [localhost:3000](http://localhost:3000/). You can keep running `make serve` and continue making doc changes. mdBook will detect your changes, render them and refresh your browser page automatically.
+
+1. Clean mdBook auto-generated content from `docs/book/book` path once you have finished local preview:
+
+    ```shell
+    make clean
+    ```
diff --git a/docs/book/src/00_introduction.md b/docs/book/src/00_introduction.md
@@ -14,8 +14,8 @@ This operator leverages a declarative API and extends the capabilities of the `c
 
 ## Getting started
 
-* [Quick Start](./user/quick-start.md)
-* [Concepts](./user/concepts.md)
-* [Developer guide](./developer/guide.md)
-* [Contributing](./CONTRIBUTING.md)
+* [Quick Start](./01_user/02_quick-start.md)
+* [Concepts](./01_user/01_concepts.md)
+* [Developer guide](./04_developer/02_guide.md)
+* [Contributing](./05_reference/04_contributing.md)
 
diff --git a/docs/book/src/04_developer/00.md b/docs/book/src/04_developer/00.md
@@ -3,4 +3,4 @@
 This section contains regular developer tasks, such as:
 - Release
 - Development guide
-- Migration guide
+- Version migration
diff --git a/docs/book/src/04_developer/01_version_migration/00.md b/docs/book/src/04_developer/01_version_migration/00.md
@@ -0,0 +1,5 @@
+# Version migration
+
+This section provides an overview of relevant changes between versions of Cluster API Operator and their direct successors.
+
+- [v1alpha1 to v1alpha2](./01_v1alpha1-to-v1alpha2.md)
diff --git a/...c/04_developer/03_v1alpha1-to-v1alpha2.md → ...sion_migration/01_v1alpha1-to-v1alpha2.md b/...c/04_developer/03_v1alpha1-to-v1alpha2.md → ...sion_migration/01_v1alpha1-to-v1alpha2.md
@@ -1,4 +1,4 @@
-# Cluster API Operator v1alpha1 API compared to v1alpha2 API
+# Cluster API Operator v1alpha1 compared to v1alpha2
 
 This document provides an overview over relevant changes between Cluster API Operator API v1alpha1 and v1alpha2 for consumers of our Go API.