docs: reorganize

padok-team · Jul 19, 2024 · 4199788 · 4199788
1 parent a9df138
commit 4199788
Show file tree

Hide file tree

Showing 10 changed files with 77 additions and 26 deletions.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1 @@
+# TODO - contributing.md
diff --git a/docs/faq.md b/docs/faq.md
@@ -0,0 +1,26 @@
+# Overview
+
+## What is burrito?
+
+**Burrito** is a TACoS (**T**erraform **A**utomation **Co**llaboration **S**oftware) Kubernetes Operator.
+
+![demo](assets/demo/demo.gif)
+
+## Why burrito?
+
+[`terraform`](https://www.terraform.io/) is a tremendous tool to manage your infrastructure in IaC.
+However, it lacks built-in solutions for managing [state drift](https://developer.hashicorp.com/terraform/tutorials/state/resource-drift).
+
+Additionally, configuring a CI/CD pipeline for Terraform can be challenging and often varies depending on the selected tools
+
+Finally, currently, there is no easy way to navigate your Terraform state to truly understand the modifications it undergoes when running `terraform apply`.
+
+`burrito` aims to tackle those issues by:
+
+- Planning continuously your Terraform code and run applies if needed
+- Offering an out of the box PR/MR integration so you do not have to write CI/CD pipelines for Terraform ever again
+- Showing your state's modifications in a simple Web UI
+
+## Getting started
+
+Follow our [getting started guide](./getting-started.md). Further user oriented [documentation](./user-guide/) is provided for additional features.
diff --git a/docs/getting-started/iac-drift-detection.md b/docs/getting-started/iac-drift-detection.md
@@ -0,0 +1 @@
+# TODO - IAC Drift Detection tutorial
diff --git a/docs/getting-started/pr-mr-workflow.md b/docs/getting-started/pr-mr-workflow.md
@@ -0,0 +1 @@
+# TODO - PR/MR plan/apply workflow
diff --git a/docs/getting-started/ui.md b/docs/getting-started/ui.md
@@ -0,0 +1 @@
+# TODO - UI Overview
diff --git a/docs/index.md b/docs/index.md
@@ -1,26 +1,11 @@
-# Overview
+# Burrito Documentation
 
-## What is burrito?
+This is the home of the Burrito documentation. Here you will find all the information you need to get started with Burrito.
 
-**Burrito** is a TACoS (**T**erraform **A**utomation **Co**llaboration **S**oftware) Kubernetes Operator.
-
-![demo](assets/demo/demo.gif)
-
-## Why burrito?
-
-[`terraform`](https://www.terraform.io/) is a tremendous tool to manage your infrastructure in IaC.
-However, it lacks built-in solutions for managing [state drift](https://developer.hashicorp.com/terraform/tutorials/state/resource-drift).
-
-Additionally, configuring a CI/CD pipeline for Terraform can be challenging and often varies depending on the selected tools
-
-Finally, currently, there is no easy way to navigate your Terraform state to truly understand the modifications it undergoes when running `terraform apply`.
-
-`burrito` aims to tackle those issues by:
-
-- Planning continuously your Terraform code and run applies if needed
-- Offering an out of the box PR/MR integration so you do not have to write CI/CD pipelines for Terraform ever again
-- Showing your state's modifications in a simple Web UI
-
-## Getting started
-
-Follow our [getting started guide](./getting-started.md). Further user oriented [documentation](./user-guide/) is provided for additional features.
+- [Overview](./overview.md) helps you understand what Burrito is all about.
+- [Getting Started](./getting-started.md) is a step-by-step guide to help you get started with Burrito.
+- [Operator Manual](./operator-manual/) is a detailed guide to help you understand how to install and configure Burrito.
+- [User Guide](./user-guide/) is a detailed guide to help you understand how to setup and use Burrito resources.
+- [Reference](./reference/) provides detailed information about the Burrito CRDs and their specifications.
+- [FAQ](./faq.md) answers some of the most frequently asked questions about Burrito.
+- [Contributing](./contributing.md) provides information on how to contribute to the Burrito project.
diff --git a/docs/overview.md b/docs/overview.md
@@ -0,0 +1,26 @@
+# Overview
+
+## What is burrito?
+
+**Burrito** is a TACoS (**T**erraform **A**utomation **Co**llaboration **S**oftware) Kubernetes Operator.
+
+![demo](assets/demo/demo.gif)
+
+## Why burrito?
+
+[`terraform`](https://www.terraform.io/) is a tremendous tool to manage your infrastructure in IaC.
+However, it lacks built-in solutions for managing [state drift](https://developer.hashicorp.com/terraform/tutorials/state/resource-drift).
+
+Additionally, configuring a CI/CD pipeline for Terraform can be challenging and often varies depending on the selected tools
+
+Finally, currently, there is no easy way to navigate your Terraform state to truly understand the modifications it undergoes when running `terraform apply`.
+
+`burrito` aims to tackle those issues by:
+
+- Planning continuously your Terraform code and run applies if needed
+- Offering an out of the box PR/MR integration so you do not have to write CI/CD pipelines for Terraform ever again
+- Showing your state's modifications in a simple Web UI
+
+## Getting started
+
+Follow our [getting started guide](./getting-started.md). Further user oriented [documentation](./user-guide/) is provided for additional features.
diff --git a/docs/reference/api.md b/docs/reference/api.md
diff --git a/docs/reference/crds.md b/docs/reference/crds.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -10,8 +10,12 @@ markdown_extensions:
 - toc:
     permalink: true
 nav:
-- Overview: index.md
-- Getting Started: getting-started.md
+- Home: index.md
+- Overview: overview.md
+- Getting Started:
+  - IaC Drift Detection: getting-started/iac-drift-detection.md
+  - PR/MR Workflow: getting-started/pr-mr-workflow.md
+  - UI Overview: getting-started/ui.md
 - Operator Manual:
   - Install:
     - With static manifests: operator-manual/install/with-static-manifests.md
@@ -31,3 +35,9 @@ nav:
   - user-guide/terraform-version.md
   - user-guide/private-modules.md
   - user-guide/additionnal-trigger-path.md
+- Reference:
+  - reference/api.md
+  - reference/crds.md
+- FAQ: faq.md
+- Contributing:
+  - contributing.md