Skip to content

Commit e39c09b

Browse files
jschooneDEiselt
andauthored
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]>
1 parent b98d106 commit e39c09b

File tree

2 files changed

+78
-21
lines changed

2 files changed

+78
-21
lines changed

docs.package.json

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@
4141
"target": "docs/03-container/components",
4242
"label": "container-registry"
4343
},
44-
4544
{
4645
"repo": "SovereignCloudStack/status-page-openapi",
4746
"source": "docs",
@@ -74,7 +73,12 @@
7473
},
7574
{
7675
"repo": "SovereignCloudStack/scs-health-monitor",
77-
"source": ["docs/overview.md", "docs/Workflow.md", "docs/Testflow.md", "docs/ObservabilityStack/SetupObservabilityStack.md"],
76+
"source": [
77+
"docs/overview.md",
78+
"docs/Workflow.md",
79+
"docs/Testflow.md",
80+
"docs/ObservabilityStack/SetupObservabilityStack.md"
81+
],
7882
"target": "docs/04-operating-scs/components",
7983
"label": "scs-health-monitor"
8084
},
@@ -95,5 +99,23 @@
9599
"source": "docs/images/*.png",
96100
"target": "docs/04-operating-scs/components",
97101
"label": "automated-pentesting/images"
102+
},
103+
{
104+
"repo": "SovereignCloudStack/csctl",
105+
"source": "docs/*.md",
106+
"target": "docs/03-container/components/cluster-stacks/components",
107+
"label": "csctl"
108+
},
109+
{
110+
"repo": "SovereignCloudStack/cluster-stacks",
111+
"source": "docs/*",
112+
"target": "docs/03-container/components/cluster-stacks/components",
113+
"label": "cluster-stacks"
114+
},
115+
{
116+
"repo": "SovereignCloudStack/cluster-stack-operator",
117+
"source": ["docs/*"],
118+
"target": "docs/03-container/components/cluster-stacks/components",
119+
"label": "cluster-stack-operator"
98120
}
99121
]

sidebarsDocs.js

Lines changed: 54 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,60 @@ const sidebarsDocs = {
120120
type: 'generated-index'
121121
},
122122
items: [
123+
{
124+
type: 'category',
125+
label: 'Cluster Stacks',
126+
link: {
127+
type: 'generated-index'
128+
},
129+
items: [
130+
'container/components/cluster-stacks/components/cluster-stacks/overview',
131+
{
132+
type: 'category',
133+
label: 'Cluster Stack Operator',
134+
items: [
135+
'container/components/cluster-stacks/components/cluster-stack-operator/architecture/overview',
136+
'container/components/cluster-stacks/components/cluster-stack-operator/topics/quickstart',
137+
'container/components/cluster-stacks/components/cluster-stack-operator/topics/troubleshoot',
138+
'container/components/cluster-stacks/components/cluster-stack-operator/develop/develop'
139+
]
140+
},
141+
{
142+
type: 'category',
143+
label: 'Cluster Stack Provider OpenStack',
144+
items: [
145+
'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/overview',
146+
'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/quickstart',
147+
'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/controllers',
148+
'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/develop'
149+
]
150+
},
151+
{
152+
type: 'category',
153+
label: 'csctl',
154+
items: [
155+
'container/components/cluster-stacks/components/csctl/overview',
156+
'container/components/cluster-stacks/components/csctl/quickstart',
157+
'container/components/cluster-stacks/components/csctl/getting_started',
158+
'container/components/cluster-stacks/components/csctl/developing-and-testing-csctl'
159+
]
160+
},
161+
{
162+
type: 'category',
163+
label: 'Predefined Cluster Stacks',
164+
items: [
165+
{
166+
type: 'category',
167+
label: 'Openstack',
168+
items: [
169+
'container/components/cluster-stacks/components/cluster-stacks/providers/openstack/quickstart',
170+
'container/components/cluster-stacks/components/cluster-stacks/providers/openstack/configuration'
171+
]
172+
}
173+
]
174+
}
175+
]
176+
},
123177
{
124178
type: 'category',
125179
label: 'K8s Cluster API Provider',
@@ -157,25 +211,6 @@ const sidebarsDocs = {
157211
}
158212
]
159213
},
160-
{
161-
type: 'category',
162-
label: 'Cluster Stacks',
163-
link: {
164-
type: 'generated-index'
165-
},
166-
items: [
167-
{
168-
type: 'category',
169-
label: 'Cluster Stack Provider OpenStack',
170-
items: [
171-
'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/overview',
172-
'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/quickstart',
173-
'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/controllers',
174-
'container/components/cluster-stacks/components/cluster-stack-provider-openstack/docs/develop'
175-
]
176-
}
177-
]
178-
},
179214
{
180215
type: 'category',
181216
label: 'Container Registry',

0 commit comments

Comments
 (0)