Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve kaas documentation #234

Merged
merged 7 commits into from
Aug 28, 2024
Merged

Improve kaas documentation #234

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
441f24e
feat(cluster-stacks): add csctl
jschoone Aug 22, 2024
4772474
chore(container layer): switch cluster stacks and k8s-cluster-api-pro…
jschoone Aug 22, 2024
9ba6759
feat(cluster-stacks): add cluster stacks itself
jschoone Aug 22, 2024
d6cef05
feat(cluster-stacks): add cluster-stack-operator card
jschoone Aug 22, 2024
41457fe
changed: CSO structure
DEiselt Aug 26, 2024
1738916
added: predefined cluster stacks
DEiselt Aug 27, 2024
d6b98af
Merge branch 'main' into 232-epic-improve-kaas-documentation
jschoone Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion docs.package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,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"
},
Expand All @@ -95,5 +100,29 @@
"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/overview.md",
"target": "docs/03-container/components/cluster-stacks/components",
"label": "cluster-stacks"
},
{
"repo": "SovereignCloudStack/cluster-stack-operator",
"source": ["docs/architecture/overview.md"],
"target": "docs/03-container/components/cluster-stacks/components",
"label": "cluster-stack-operator"
},
{
"repo": "SovereignCloudStack/cluster-stack-operator",
"source": ["docs/pics/syself-cluster-stacks-web.png"],
"target": "docs/03-container/components/cluster-stacks/components",
"label": "pics"
jschoone marked this conversation as resolved.
Show resolved Hide resolved
}
]
56 changes: 37 additions & 19 deletions sidebarsDocs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,43 @@ 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/overview'
]
},
{
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: 'K8s Cluster API Provider',
Expand Down Expand Up @@ -157,25 +194,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',
Expand Down
Loading