docs: getting started index (#691)

Signed-off-by: Dario Tranchitella <[email protected]>
clastix · Feb 12, 2025 · abfc65a · abfc65a
1 parent f238820
commit abfc65a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/docs/content/getting-started/index.md b/docs/content/getting-started/index.md
@@ -0,0 +1,6 @@
+# Getting started
+
+This section contains the information on how to get started with Kamaji
+
+- [Getting started with Kamaji](getting-started.md): install the required components and Kamaji on any Kubernetes cluster
+- [Kamaji: Getting started on Kind](kind.md): useful for development environments, create a Kamaji environment on `kind`
diff --git a/docs/content/index.md b/docs/content/index.md
@@ -14,7 +14,7 @@ View [Concepts](concepts.md) for a deeper understanding of principles behind Kam
 
 ## Getting started
 
-Please refer to the [Getting Started guide](getting-started.md) to deploy a minimal setup of Kamaji.
+Please refer to the [Getting Started guide](getting-started/index.md) to deploy a minimal setup of Kamaji.
 
 
 ## FAQs

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -55,7 +55,8 @@ markdown_extensions:
 # Generate navigation bar
 nav:
 - 'Kamaji': index.md
-- 'Getting started': 
+- 'Getting started':
+  - getting-started/index.md
   - getting-started/getting-started.md
   - getting-started/kind.md
 - 'Concepts': concepts.md
-Original file line number
+Diff line change
@@ Expand Up @@
     ## Getting started
-    Please refer to the [Getting Started guide](getting-started.md) to deploy a minimal setup of Kamaji.
+    Please refer to the [Getting Started guide](getting-started/index.md) to deploy a minimal setup of Kamaji.
     ## FAQs
@@ Expand Down @@