From c2533db120ed7e7ab50e1e84246002c5a8752b89 Mon Sep 17 00:00:00 2001 From: Joshua Irmer Date: Mon, 24 Jun 2024 15:52:21 +0200 Subject: [PATCH 1/8] feat: add status page docs Signed-off-by: Joshua Irmer --- docs.package.json | 14 ++++++++++++- sidebarsDocs.js | 52 ++++++++++++++++++++++++++++++++++++++++------- 2 files changed, 58 insertions(+), 8 deletions(-) diff --git a/docs.package.json b/docs.package.json index 9abfd0a90f..f7e78a585c 100644 --- 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 index 3d68410455..2412baf1ab 100644 --- a/sidebarsDocs.js +++ b/sidebarsDocs.js @@ -214,15 +214,50 @@ 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' + 'operating-scs/components/status-page-openapi/docs/overview', + { + type: 'category', + label: 'API', + link: { + type: 'generated-index' + }, + items: [ + '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', + 'operating-scs/components/status-page-api/docs/requests', + 'operating-scs/components/status-page-api/docs/example-requests' + ] + }, + { + type: 'category', + label: 'Deployment', + link: { + type: 'generated-index' + }, + items: [ + 'operating-scs/components/status-page-deployment/docs/overview', + { + 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' + ] + } ] }, { @@ -267,7 +302,7 @@ const sidebarsDocs = { 'operating-scs/components/automated-pentesting/overview', 'operating-scs/components/automated-pentesting/tools' ] - }, + } ] }, { @@ -354,7 +389,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' ] From c495dafcd0c055bf10b36cf04321fe3fa3f2ca71 Mon Sep 17 00:00:00 2001 From: Joshua Irmer Date: Wed, 26 Jun 2024 09:13:02 +0200 Subject: [PATCH 2/8] add new deployment docs Signed-off-by: Joshua Irmer --- sidebarsDocs.js | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/sidebarsDocs.js b/sidebarsDocs.js index 2412baf1ab..f5d936a751 100644 --- a/sidebarsDocs.js +++ b/sidebarsDocs.js @@ -242,6 +242,8 @@ const sidebarsDocs = { }, 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', @@ -255,7 +257,9 @@ const sidebarsDocs = { 'operating-scs/components/status-page-deployment/docs/scs-public' ] }, - 'operating-scs/components/status-page-deployment/docs/usage' + 'operating-scs/components/status-page-deployment/docs/usage', + 'operating-scs/components/status-page-deployment/docs/contribute', + 'operating-scs/components/status-page-deployment/docs/faq' ] } ] From c6e4ea193fd4ae316025a7bf0b9adfa68a47a756 Mon Sep 17 00:00:00 2001 From: Joshua Irmer Date: Wed, 26 Jun 2024 09:34:20 +0200 Subject: [PATCH 3/8] split openapi and api docs Signed-off-by: Joshua Irmer --- sidebarsDocs.js | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/sidebarsDocs.js b/sidebarsDocs.js index f5d936a751..789f63a4fc 100644 --- a/sidebarsDocs.js +++ b/sidebarsDocs.js @@ -222,14 +222,23 @@ const sidebarsDocs = { 'operating-scs/components/status-page-openapi/docs/overview', { type: 'category', - label: 'API', + label: 'Concepts', link: { type: 'generated-index' }, items: [ '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', + '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/requests', 'operating-scs/components/status-page-api/docs/example-requests' ] From 4906014a194de126de9779b0b0a7f36d803c9782 Mon Sep 17 00:00:00 2001 From: Joshua Irmer Date: Wed, 26 Jun 2024 15:58:07 +0200 Subject: [PATCH 4/8] fix broken link Point status page link to status page category Signed-off-by: Joshua Irmer --- static/data/architecturalOverviewData.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/data/architecturalOverviewData.json b/static/data/architecturalOverviewData.json index 2fcbc8d9a0..6de5069e67 100644 --- 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" }, From ea6bfbc224a23eab9e1769d9fa7d580ba2bbc785 Mon Sep 17 00:00:00 2001 From: Joshua Irmer Date: Wed, 26 Jun 2024 15:58:52 +0200 Subject: [PATCH 5/8] add openapi overview to concepts category Signed-off-by: Joshua Irmer --- sidebarsDocs.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sidebarsDocs.js b/sidebarsDocs.js index 789f63a4fc..75ad1334d6 100644 --- a/sidebarsDocs.js +++ b/sidebarsDocs.js @@ -219,7 +219,6 @@ const sidebarsDocs = { type: 'generated-index' }, items: [ - 'operating-scs/components/status-page-openapi/docs/overview', { type: 'category', label: 'Concepts', @@ -227,6 +226,7 @@ const sidebarsDocs = { 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' From a553e63263eb4c1e29f2ffedbd873e2bf1d2084f Mon Sep 17 00:00:00 2001 From: Joshua Irmer Date: Mon, 15 Jul 2024 14:59:49 +0200 Subject: [PATCH 6/8] add all API docs Signed-off-by: Joshua Irmer --- sidebarsDocs.js | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/sidebarsDocs.js b/sidebarsDocs.js index 75ad1334d6..f0219edb6b 100644 --- a/sidebarsDocs.js +++ b/sidebarsDocs.js @@ -239,8 +239,13 @@ const sidebarsDocs = { 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/example-requests', + 'operating-scs/components/status-page-api/docs/contribute' ] }, { From 9bf2b841833eb6c5684c9acfd32788fca383adbe Mon Sep 17 00:00:00 2001 From: Joshua Irmer Date: Mon, 15 Jul 2024 15:00:13 +0200 Subject: [PATCH 7/8] add admin authentication docs Signed-off-by: Joshua Irmer --- sidebarsDocs.js | 1 + 1 file changed, 1 insertion(+) diff --git a/sidebarsDocs.js b/sidebarsDocs.js index f0219edb6b..9d6b8d6d23 100644 --- a/sidebarsDocs.js +++ b/sidebarsDocs.js @@ -273,6 +273,7 @@ const sidebarsDocs = { }, 'operating-scs/components/status-page-deployment/docs/usage', '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' ] } From 15985d78a758fb98cc0ee1543b5969d9b01ff0b7 Mon Sep 17 00:00:00 2001 From: Joshua Irmer Date: Mon, 15 Jul 2024 15:54:10 +0200 Subject: [PATCH 8/8] add monitoring deployment docs Signed-off-by: Joshua Irmer --- sidebarsDocs.js | 1 + 1 file changed, 1 insertion(+) diff --git a/sidebarsDocs.js b/sidebarsDocs.js index 9d6b8d6d23..5198751765 100644 --- a/sidebarsDocs.js +++ b/sidebarsDocs.js @@ -272,6 +272,7 @@ const sidebarsDocs = { ] }, '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'