From abfc65a5460806dc93a3cc1e519019822347ee77 Mon Sep 17 00:00:00 2001 From: Dario Tranchitella Date: Wed, 12 Feb 2025 11:08:27 +0100 Subject: [PATCH] docs: getting started index (#691) Signed-off-by: Dario Tranchitella --- docs/content/getting-started/index.md | 6 ++++++ docs/content/index.md | 2 +- docs/mkdocs.yml | 3 ++- 3 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 docs/content/getting-started/index.md diff --git a/docs/content/getting-started/index.md b/docs/content/getting-started/index.md new file mode 100644 index 0000000..77947fe --- /dev/null +++ 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 index 2511f68..875f975 100644 --- 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 index 17d712b..ce84dc9 100644 --- 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