Skip to content

Commit 6f68569

Browse files
joshuai96joshuai96
authored
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]>
1 parent 3797288 commit 6f68569

File tree

3 files changed

+79
-9
lines changed

3 files changed

+79
-9
lines changed

‎docs.package.json‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,19 @@
4646
"repo": "SovereignCloudStack/status-page-openapi",
4747
"source": "docs",
4848
"target": "docs/04-operating-scs/components",
49-
"label": "status-page"
49+
"label": "status-page-openapi"
50+
},
51+
{
52+
"repo": "SovereignCloudStack/status-page-api",
53+
"source": "docs",
54+
"target": "docs/04-operating-scs/components",
55+
"label": "status-page-api"
56+
},
57+
{
58+
"repo": "SovereignCloudStack/status-page-deployment",
59+
"source": "docs",
60+
"target": "docs/04-operating-scs/components",
61+
"label": "status-page-deployment"
5062
},
5163
{
5264
"repo": "SovereignCloudStack/k8s-observability",

‎sidebarsDocs.js‎

Lines changed: 65 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -214,15 +214,70 @@ const sidebarsDocs = {
214214
items: [
215215
{
216216
type: 'category',
217-
label: 'Status Page API',
217+
label: 'Status Page',
218218
link: {
219219
type: 'generated-index'
220220
},
221221
items: [
222-
'operating-scs/components/status-page/docs/overview',
223-
'operating-scs/components/status-page/docs/component_overview',
224-
'operating-scs/components/status-page/docs/components',
225-
'operating-scs/components/status-page/docs/levels_of_consensus'
222+
{
223+
type: 'category',
224+
label: 'Concepts',
225+
link: {
226+
type: 'generated-index'
227+
},
228+
items: [
229+
'operating-scs/components/status-page-openapi/docs/overview',
230+
'operating-scs/components/status-page-openapi/docs/components',
231+
'operating-scs/components/status-page-openapi/docs/levels_of_consensus',
232+
'operating-scs/components/status-page-openapi/docs/component_overview'
233+
]
234+
},
235+
{
236+
type: 'category',
237+
label: 'API',
238+
link: {
239+
type: 'generated-index'
240+
},
241+
items: [
242+
'operating-scs/components/status-page-api/docs/overview',
243+
'operating-scs/components/status-page-api/docs/requirements',
244+
'operating-scs/components/status-page-api/docs/quickstart',
245+
'operating-scs/components/status-page-api/docs/configuration',
246+
'operating-scs/components/status-page-api/docs/requests',
247+
'operating-scs/components/status-page-api/docs/example-requests',
248+
'operating-scs/components/status-page-api/docs/contribute'
249+
]
250+
},
251+
{
252+
type: 'category',
253+
label: 'Deployment',
254+
link: {
255+
type: 'generated-index'
256+
},
257+
items: [
258+
'operating-scs/components/status-page-deployment/docs/overview',
259+
'operating-scs/components/status-page-deployment/docs/requirements',
260+
'operating-scs/components/status-page-deployment/docs/quickstart',
261+
{
262+
type: 'category',
263+
label: 'Configuration',
264+
link: {
265+
type: 'generated-index'
266+
},
267+
items: [
268+
'operating-scs/components/status-page-deployment/docs/configuration',
269+
'operating-scs/components/status-page-deployment/docs/kind',
270+
'operating-scs/components/status-page-deployment/docs/k3s',
271+
'operating-scs/components/status-page-deployment/docs/scs-public'
272+
]
273+
},
274+
'operating-scs/components/status-page-deployment/docs/usage',
275+
'operating-scs/components/status-page-deployment/docs/monitoring',
276+
'operating-scs/components/status-page-deployment/docs/contribute',
277+
'operating-scs/components/status-page-deployment/docs/admin-authentication',
278+
'operating-scs/components/status-page-deployment/docs/faq'
279+
]
280+
}
226281
]
227282
},
228283
{
@@ -267,7 +322,7 @@ const sidebarsDocs = {
267322
'operating-scs/components/automated-pentesting/overview',
268323
'operating-scs/components/automated-pentesting/tools'
269324
]
270-
},
325+
}
271326
]
272327
},
273328
{
@@ -354,7 +409,10 @@ const sidebarsDocs = {
354409
link: {
355410
type: 'generated-index'
356411
},
357-
items: ['iam/domain-manager-setup-and-usage', 'iam/SCS-example-setup-configuration-description']
412+
items: [
413+
'iam/domain-manager-setup-and-usage',
414+
'iam/SCS-example-setup-configuration-description'
415+
]
358416
},
359417
'iam/intra-SCS-federation-setup-description-for-osism-doc-operations'
360418
]

‎static/data/architecturalOverviewData.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"components": [
99
{
1010
"title": "Status Page",
11-
"url": "/docs/operating-scs/components/status-page/docs/overview",
11+
"url": "/docs/category/status-page",
1212
"mandatory": "true",
1313
"stable": "true"
1414
},

0 commit comments

Comments
 (0)