Feat: Add status page docs (#207)

* feat: add status page docs Signed-off-by: Joshua Irmer <[email protected]> * add new deployment docs Signed-off-by: Joshua Irmer <[email protected]> * split openapi and api docs Signed-off-by: Joshua Irmer <[email protected]> * fix broken link Point status page link to status page category Signed-off-by: Joshua Irmer <[email protected]> * add openapi overview to concepts category Signed-off-by: Joshua Irmer <[email protected]> * add all API docs Signed-off-by: Joshua Irmer <[email protected]> * add admin authentication docs Signed-off-by: Joshua Irmer <[email protected]> * add monitoring deployment docs Signed-off-by: Joshua Irmer <[email protected]> --------- Signed-off-by: Joshua Irmer <[email protected]>
SovereignCloudStack · Jul 16, 2024 · 6f68569 · 6f68569
1 parent 3797288
commit 6f68569
Show file tree

Hide file tree

Showing 3 changed files with 79 additions and 9 deletions.
diff --git a/docs.package.json b/docs.package.json
@@ -46,7 +46,19 @@
     "repo": "SovereignCloudStack/status-page-openapi",
     "source": "docs",
     "target": "docs/04-operating-scs/components",
-    "label": "status-page"
+    "label": "status-page-openapi"
+  },
+  {
+    "repo": "SovereignCloudStack/status-page-api",
+    "source": "docs",
+    "target": "docs/04-operating-scs/components",
+    "label": "status-page-api"
+  },
+  {
+    "repo": "SovereignCloudStack/status-page-deployment",
+    "source": "docs",
+    "target": "docs/04-operating-scs/components",
+    "label": "status-page-deployment"
   },
   {
     "repo": "SovereignCloudStack/k8s-observability",

diff --git a/sidebarsDocs.js b/sidebarsDocs.js
@@ -214,15 +214,70 @@ const sidebarsDocs = {
           items: [
             {
               type: 'category',
-              label: 'Status Page API',
+              label: 'Status Page',
               link: {
                 type: 'generated-index'
               },
               items: [
-                'operating-scs/components/status-page/docs/overview',
-                'operating-scs/components/status-page/docs/component_overview',
-                'operating-scs/components/status-page/docs/components',
-                'operating-scs/components/status-page/docs/levels_of_consensus'
+                {
+                  type: 'category',
+                  label: 'Concepts',
+                  link: {
+                    type: 'generated-index'
+                  },
+                  items: [
+                    'operating-scs/components/status-page-openapi/docs/overview',
+                    'operating-scs/components/status-page-openapi/docs/components',
+                    'operating-scs/components/status-page-openapi/docs/levels_of_consensus',
+                    'operating-scs/components/status-page-openapi/docs/component_overview'
+                  ]
+                },
+                {
+                  type: 'category',
+                  label: 'API',
+                  link: {
+                    type: 'generated-index'
+                  },
+                  items: [
+                    'operating-scs/components/status-page-api/docs/overview',
+                    'operating-scs/components/status-page-api/docs/requirements',
+                    'operating-scs/components/status-page-api/docs/quickstart',
+                    'operating-scs/components/status-page-api/docs/configuration',
+                    'operating-scs/components/status-page-api/docs/requests',
+                    'operating-scs/components/status-page-api/docs/example-requests',
+                    'operating-scs/components/status-page-api/docs/contribute'
+                  ]
+                },
+                {
+                  type: 'category',
+                  label: 'Deployment',
+                  link: {
+                    type: 'generated-index'
+                  },
+                  items: [
+                    'operating-scs/components/status-page-deployment/docs/overview',
+                    'operating-scs/components/status-page-deployment/docs/requirements',
+                    'operating-scs/components/status-page-deployment/docs/quickstart',
+                    {
+                      type: 'category',
+                      label: 'Configuration',
+                      link: {
+                        type: 'generated-index'
+                      },
+                      items: [
+                        'operating-scs/components/status-page-deployment/docs/configuration',
+                        'operating-scs/components/status-page-deployment/docs/kind',
+                        'operating-scs/components/status-page-deployment/docs/k3s',
+                        'operating-scs/components/status-page-deployment/docs/scs-public'
+                      ]
+                    },
+                    'operating-scs/components/status-page-deployment/docs/usage',
+                    'operating-scs/components/status-page-deployment/docs/monitoring',
+                    'operating-scs/components/status-page-deployment/docs/contribute',
+                    'operating-scs/components/status-page-deployment/docs/admin-authentication',
+                    'operating-scs/components/status-page-deployment/docs/faq'
+                  ]
+                }
               ]
             },
             {
@@ -267,7 +322,7 @@ const sidebarsDocs = {
                 'operating-scs/components/automated-pentesting/overview',
                 'operating-scs/components/automated-pentesting/tools'
               ]
-            },
+            }
           ]
         },
         {
@@ -354,7 +409,10 @@ const sidebarsDocs = {
           link: {
             type: 'generated-index'
           },
-          items: ['iam/domain-manager-setup-and-usage', 'iam/SCS-example-setup-configuration-description']
+          items: [
+            'iam/domain-manager-setup-and-usage',
+            'iam/SCS-example-setup-configuration-description'
+          ]
         },
         'iam/intra-SCS-federation-setup-description-for-osism-doc-operations'
       ]

diff --git a/static/data/architecturalOverviewData.json b/static/data/architecturalOverviewData.json
@@ -8,7 +8,7 @@
       "components": [
         {
           "title": "Status Page",
-          "url": "/docs/operating-scs/components/status-page/docs/overview",
+          "url": "/docs/category/status-page",
           "mandatory": "true",
           "stable": "true"
         },