Improve kaas documentation (#234)

* feat(cluster-stacks): add csctl Signed-off-by: Jan Schoone <[email protected]> * chore(container layer): switch cluster stacks and k8s-cluster-api-provider Signed-off-by: Jan Schoone <[email protected]> * feat(cluster-stacks): add cluster stacks itself Signed-off-by: Jan Schoone <[email protected]> * feat(cluster-stacks): add cluster-stack-operator card Signed-off-by: Jan Schoone <[email protected]> * changed: CSO structure Signed-off-by: Danny Eiselt <[email protected]> * added: predefined cluster stacks Signed-off-by: Danny Eiselt <[email protected]> --------- Signed-off-by: Jan Schoone <[email protected]> Signed-off-by: Danny Eiselt <[email protected]> Co-authored-by: Danny Eiselt <[email protected]>
SovereignCloudStack · Aug 28, 2024 · e39c09b · e39c09b
1 parent b98d106
commit e39c09b
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 21 deletions.
diff --git a/docs.package.json b/docs.package.json
@@ -41,7 +41,6 @@
     "target": "docs/03-container/components",
     "label": "container-registry"
   },
-
   {
     "repo": "SovereignCloudStack/status-page-openapi",
     "source": "docs",
@@ -74,7 +73,12 @@
   },
   {
     "repo": "SovereignCloudStack/scs-health-monitor",
-    "source": ["docs/overview.md", "docs/Workflow.md", "docs/Testflow.md", "docs/ObservabilityStack/SetupObservabilityStack.md"],
+    "source": [
+      "docs/overview.md",
+      "docs/Workflow.md",
+      "docs/Testflow.md",
+      "docs/ObservabilityStack/SetupObservabilityStack.md"
+    ],
     "target": "docs/04-operating-scs/components",
     "label": "scs-health-monitor"
   },
@@ -95,5 +99,23 @@
     "source": "docs/images/*.png",
     "target": "docs/04-operating-scs/components",
     "label": "automated-pentesting/images"
+  },
+  {
+    "repo": "SovereignCloudStack/csctl",
+    "source": "docs/*.md",
+    "target": "docs/03-container/components/cluster-stacks/components",
+    "label": "csctl"
+  },
+  {
+    "repo": "SovereignCloudStack/cluster-stacks",
+    "source": "docs/*",
+    "target": "docs/03-container/components/cluster-stacks/components",
+    "label": "cluster-stacks"
+  },
+  {
+    "repo": "SovereignCloudStack/cluster-stack-operator",
+    "source": ["docs/*"],
+    "target": "docs/03-container/components/cluster-stacks/components",
+    "label": "cluster-stack-operator"
   }
 ]
diff --git a/sidebarsDocs.js b/sidebarsDocs.js
@@ -120,6 +120,60 @@ const sidebarsDocs = {
             type: 'generated-index'
           },
           items: [
+            {
+              type: 'category',
+              label: 'Cluster Stacks',
+              link: {
+                type: 'generated-index'
+              },
+              items: [
+                'container/components/cluster-stacks/components/cluster-stacks/overview',
+                {
+                  type: 'category',
+                  label: 'Cluster Stack Operator',
+                  items: [
+                    'container/components/cluster-stacks/components/cluster-stack-operator/architecture/overview',
+                    'container/components/cluster-stacks/components/cluster-stack-operator/topics/quickstart',
+                    'container/components/cluster-stacks/components/cluster-stack-operator/topics/troubleshoot',
+                    'container/components/cluster-stacks/components/cluster-stack-operator/develop/develop'
+                  ]
+                },
+                {
+                  type: 'category',
+                  label: 'Cluster Stack Provider OpenStack',
+                  items: [
+                    'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/overview',
+                    'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/quickstart',
+                    'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/controllers',
+                    'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/develop'
+                  ]
+                },
+                {
+                  type: 'category',
+                  label: 'csctl',
+                  items: [
+                    'container/components/cluster-stacks/components/csctl/overview',
+                    'container/components/cluster-stacks/components/csctl/quickstart',
+                    'container/components/cluster-stacks/components/csctl/getting_started',
+                    'container/components/cluster-stacks/components/csctl/developing-and-testing-csctl'
+                  ]
+                },
+                {
+                  type: 'category',
+                  label: 'Predefined Cluster Stacks',
+                  items: [
+                    {
+                      type: 'category',
+                      label: 'Openstack',
+                      items: [
+                        'container/components/cluster-stacks/components/cluster-stacks/providers/openstack/quickstart',
+                        'container/components/cluster-stacks/components/cluster-stacks/providers/openstack/configuration'
+                      ]
+                    }
+                  ]
+                }
+              ]
+            },
             {
               type: 'category',
               label: 'K8s Cluster API Provider',
@@ -157,25 +211,6 @@ const sidebarsDocs = {
                 }
               ]
             },
-            {
-              type: 'category',
-              label: 'Cluster Stacks',
-              link: {
-                type: 'generated-index'
-              },
-              items: [
-                {
-                  type: 'category',
-                  label: 'Cluster Stack Provider OpenStack',
-                  items: [
-                    'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/overview',
-                    'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/quickstart',
-                    'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/controllers',
-                    'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/develop'
-                  ]
-                }
-              ]
-            },
             {
               type: 'category',
               label: 'Container Registry',