switch to autogenerated sidebars and new directory structure (#7)

sahajsoft · Jul 31, 2023 · f528702 · f528702
1 parent bb2cfa5
commit f528702
Show file tree

Hide file tree

Showing 15 changed files with 16 additions and 31 deletions.
diff --git a/docs/hummingbird.md → docs/01-Introduction/index.md b/docs/hummingbird.md → docs/01-Introduction/index.md
@@ -1,7 +1,7 @@
 ---
 id: hummingbird
 title: hummingbird
-sidebar_label: hummingbird
+sidebar_label: Introduction
 ---
 # What is hummingbird?
 
@@ -25,4 +25,4 @@ There are few challenges in standardising infra and automating this task
 * the control plane can change at any given time. For instance client may change cloud provider, or move from managed to self-managed service.
 * Some services which we want to deploy are not wanted in the project or may already exist in the project.
 
-`hummingbird` is designed keeping all of this in mind. Read about how [here](getting-started/architecture)
+`hummingbird` is designed keeping all of this in mind. Read about how [here](/docs/04-Architecture)
diff --git a/docs/02-Before you get started/01-pre-requisites.md b/docs/02-Before you get started/01-pre-requisites.md
@@ -0,0 +1 @@
+# Prerequisites
diff --git a/docs/02-Before you get started/02-versions.md b/docs/02-Before you get started/02-versions.md
@@ -0,0 +1 @@
+# Versions
diff --git a/docs/03-Getting started/01-running-control-plane-in-minikube.md b/docs/03-Getting started/01-running-control-plane-in-minikube.md
@@ -0,0 +1 @@
+# Running control plane in minikube
diff --git a/docs/03-Getting started/02-running-charts-in-local.md b/docs/03-Getting started/02-running-charts-in-local.md
@@ -0,0 +1 @@
+# Running charts in local
diff --git a/docs/03-Getting started/index.md b/docs/03-Getting started/index.md
@@ -0,0 +1 @@
+# Getting started
diff --git a/docs/getting-started/architecture.md → docs/04-Architecture/index.md b/docs/getting-started/architecture.md → docs/04-Architecture/index.md
@@ -1,5 +1,4 @@
 ---
-id: architecture
 title: Architecture
 sidebar_label: Architecture
 ---

diff --git a/docs/get-involved/contribute.md → docs/05-Get Involved/contribute.md b/docs/get-involved/contribute.md → docs/05-Get Involved/contribute.md
diff --git a/docs/get-involved/faq.md → docs/05-Get Involved/faq.md b/docs/get-involved/faq.md → docs/05-Get Involved/faq.md
diff --git a/docs/get-involved/index.md → docs/05-Get Involved/index.md b/docs/get-involved/index.md → docs/05-Get Involved/index.md
diff --git a/docs/get-involved/roadmap.md → docs/05-Get Involved/roadmap.md b/docs/get-involved/roadmap.md → docs/05-Get Involved/roadmap.md
diff --git a/docs/get-involved/suggest.md → docs/05-Get Involved/suggest.md b/docs/get-involved/suggest.md → docs/05-Get Involved/suggest.md
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -77,12 +77,12 @@ const config = {
         items: [
           {
             label: "About",
-            to: "docs/hummingbird",
+            to: "docs/Introduction",
             position: "right",
           },
           {
             label: "Getting Started",
-            to: "docs/getting-started/architecture",
+            to: "docs/Getting Started",
             position: "right",
           },
           // {

diff --git a/package-lock.json b/package-lock.json
diff --git a/sidebars.js b/sidebars.js
@@ -1,29 +1,10 @@
-/**
- * Creating a sidebar enables you to:
- - create an ordered group of docs
- - render a sidebar for each doc of that group
- - provide next/previous navigation
-
- The sidebars can be generated from the filesystem, or explicitly defined here.
-
- Create as many sidebars as you want.
- */
-
-// @ts-check
-
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
-  docs: {
-    Introduction: ["hummingbird", "tech-decisions"],
-    "Getting Started": ["getting-started/architecture"],
-    // Tutorial: ["tutorial/tutorial"],
-    "Get Involved": [
-      "get-involved/suggest-feature",
-      // "get-involved/contribute",
-      "get-involved/roadmap",
-      // "get-involved/faq",
-    ],
-  },
+  autoGeneratedSidebar: [
+    {
+      type: 'autogenerated',
+      dirName: '.',
+    },
+  ]
 };
 
 module.exports = sidebars;