Update sidebar to organize tutorials + other minor improvements (apac…

…he#16184) Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com> Co-authored-by: Victoria Lim <vtlim@users.noreply.github.com>
gianm · May 10, 2024 · f0bb08f · f0bb08f
1 parent 8799b7c
commit f0bb08f
Show file tree

Hide file tree

Showing 3 changed files with 117 additions and 60 deletions.
diff --git a/docs/tutorials/tutorial-jdbc.md b/docs/tutorials/tutorial-jdbc.md
@@ -1,7 +1,7 @@
 ---
 id: tutorial-jdbc
 title: Use the JDBC driver to query Druid
-sidebar_label: JDBC connector
+sidebar_label: JDBC connector tutorial
 ---
 
 <!--

diff --git a/docs/tutorials/tutorial-sketches-theta.md b/docs/tutorials/tutorial-sketches-theta.md
@@ -1,7 +1,7 @@
 ---
 id: tutorial-sketches-theta
 title: Approximations with Theta sketches
-sidebar_label: Theta sketches
+sidebar_label: Theta sketches tutorial
 ---
 
 <!--

diff --git a/website/sidebars.json b/website/sidebars.json
@@ -1,35 +1,56 @@
 {
-  "docs": {
-    "Getting started": [
-      "design/index",
-      "tutorials/index",
+  "docs": [
+    "design/index",
+    {"type": "category",
+    "label": "Getting started",
+    "link": {
+      "type": "doc",
+      "id": "tutorials/index"
+    },
+    "items":[
       "operations/single-server",
-      "tutorials/cluster"
-    ],
-    "Tutorials": [
-      "tutorials/tutorial-msq-extern",
-      "tutorials/tutorial-kafka",
-      "tutorials/tutorial-batch-hadoop",
-      "tutorials/tutorial-query",
-      "tutorials/tutorial-rollup",
-      "tutorials/tutorial-sketches-theta",
-      "tutorials/tutorial-retention",
-      "tutorials/tutorial-append-data",
-      "tutorials/tutorial-update-data",
-      "tutorials/tutorial-compaction",
-      "tutorials/tutorial-delete-data",
-      "tutorials/tutorial-ingestion-spec",
-      "tutorials/tutorial-transform-spec",
-      "tutorials/tutorial-msq-convert-spec",
       "tutorials/docker",
-      "tutorials/tutorial-kerberos-hadoop",
-      "tutorials/tutorial-sql-query-view",
-      "tutorials/tutorial-sql-null",
-      "tutorials/tutorial-unnest-arrays",
-      "tutorials/tutorial-query-deep-storage",
-      "tutorials/tutorial-jdbc"
-    ],
-    "Design": [
+      "tutorials/cluster",
+      {"type": "category",
+      "label": "Ingestion tutorials",
+      "items": [
+        "tutorials/tutorial-msq-extern",
+        "tutorials/tutorial-kafka",
+        "tutorials/tutorial-rollup",
+        "tutorials/tutorial-ingestion-spec",
+        "tutorials/tutorial-transform-spec",
+        "tutorials/tutorial-msq-convert-spec"
+              ]},
+      {"type": "category",
+       "label": "Data management tutorials",
+       "items": [
+        "tutorials/tutorial-retention",
+        "tutorials/tutorial-append-data",
+        "tutorials/tutorial-update-data",
+        "tutorials/tutorial-compaction",
+        "tutorials/tutorial-delete-data"]
+       },
+      {"type": "category",
+        "label": "Querying tutorials",
+        "items": [  
+          "tutorials/tutorial-query",
+          "tutorials/tutorial-sql-query-view",
+          "tutorials/tutorial-unnest-arrays",
+          "tutorials/tutorial-query-deep-storage"]
+      },
+    "tutorials/tutorial-sketches-theta",
+    "tutorials/tutorial-jdbc",
+    {"type": "category",
+    "label": "Hadoop tutorials",
+    "items": [  
+      "tutorials/tutorial-batch-hadoop",
+      "tutorials/tutorial-kerberos-hadoop"]
+    }]
+}
+    ,
+    {"type": "category",
+    "label":"Design",
+    "items": [
       "design/architecture",
       {
         "type": "category",
@@ -50,9 +71,14 @@
       "design/deep-storage",
       "design/metadata-storage",
       "design/zookeeper"
-    ],
-    "Ingestion": [
-      "ingestion/index",
+    ]},
+    {"type": "category",
+    "label": "Ingestion",
+    "link": {
+      "type": "doc",
+      "id": "ingestion/index"
+    },
+    "items":[
       {
         "type": "category",
         "label": "Ingestion concepts",
@@ -99,9 +125,15 @@
       "ingestion/schema-design",
       "ingestion/concurrent-append-replace",
       "ingestion/faq"
-    ],
-    "Data management": [
-      "data-management/index",
+    ]
+    },
+    {"type":"category",
+    "label": "Data management" ,
+    "link": {
+      "type": "doc",
+      "id": "data-management/index"
+    },
+    "items": [
       "data-management/update",
       "data-management/delete",
       "data-management/schema-changes",
@@ -117,8 +149,11 @@
            "data-management/manual-compaction"
          ]
        }
-    ],
-    "Querying": [
+    ]},
+    {
+      "type":"category",
+      "label": "Querying",
+      "items": [
       {
         "type": "category",
         "label": "Druid SQL",
@@ -160,7 +195,6 @@
           "querying/query-context"
         ]
       },
-
       {
         "type": "category",
         "label": "Native query types",
@@ -193,9 +227,14 @@
           "querying/geo"
         ]
       }
-    ],
-    "API reference":[
-      "api-reference/api-reference",
+    ]},
+    { "type": "category",
+    "label": "API reference",
+    "link": {
+      "type": "doc",
+      "id": "api-reference/api-reference"
+    },
+    "items":[
       {
         "type": "category",
         "label": "HTTP APIs",
@@ -221,14 +260,24 @@
           "api-reference/sql-jdbc"
         ]
       }
-
-    ],
-    "Configuration": [
-      "configuration/index",
+    ]
+    },
+    {"type":"category",
+    "label":"Configuration",
+    "link": {
+      "type": "doc",
+      "id": "configuration/index"
+    },
+    "items":[
       "configuration/extensions",
       "configuration/logging"
-    ],
-    "Operations": [
+    ]
+  },
+    {
+      "type":"category",
+    "label": "Operations",
+    "items":[
+      "api-reference/automatic-compaction-api",
       "operations/web-console",
       "operations/java",
       "operations/durable-storage",
@@ -283,22 +332,30 @@
           "operations/use_sbt_to_build_fat_jar"
         ]
       }
-    ],
-    "Development": [
-      "development/overview",
+    ]},
+    {
+      "type":"category",
+      "label": "Development",
+      "link": {
+        "type": "doc",
+        "id": "development/overview"
+      },
+      "items": [
       "development/modules",
       "development/javascript",
       "development/build",
       "development/versioning",
       "development/contribute-to-docs",
       "development/experimental"
-    ],
-    "Misc": [
-      "misc/papers-and-talks"
-    ],
-    "Release info": [
-      "release-info/release-notes",
-      "release-info/upgrade-notes"
     ]
-  }
+  },
+  {"type":"category",
+  "label": "Release info",
+  "items":
+  [
+    "release-info/release-notes",
+    "release-info/upgrade-notes"
+  ]},
+  "misc/papers-and-talks"
+  ]
 }