From a6ecc3f4caa46e9c50818e4374967519e08199cc Mon Sep 17 00:00:00 2001 From: Jan Schoone Date: Wed, 27 Nov 2024 21:39:57 +0100 Subject: [PATCH] docs(container): make path shorter Signed-off-by: Jan Schoone --- docs.package.json | 8 +-- sidebarsDocs.js | 134 ++++++++++++++++++++-------------------------- 2 files changed, 62 insertions(+), 80 deletions(-) diff --git a/docs.package.json b/docs.package.json index 31c01bdbc5..99ae66523f 100644 --- a/docs.package.json +++ b/docs.package.json @@ -14,7 +14,7 @@ { "repo": "SovereignCloudStack/cluster-stack-provider-openstack", "source": "docs", - "target": "docs/03-container/components/cluster-stacks/components", + "target": "docs/03-container/components", "label": "cluster-stack-provider-openstack" }, { @@ -109,19 +109,19 @@ { "repo": "SovereignCloudStack/csctl", "source": "docs/*.md", - "target": "docs/03-container/components/cluster-stacks/components", + "target": "docs/03-container/components", "label": "csctl" }, { "repo": "SovereignCloudStack/cluster-stacks", "source": "docs/*", - "target": "docs/03-container/components/cluster-stacks/components", + "target": "docs/03-container/components", "label": "cluster-stacks" }, { "repo": "SovereignCloudStack/cluster-stack-operator", "source": ["docs/*"], - "target": "docs/03-container/components/cluster-stacks/components", + "target": "docs/03-container/components", "label": "cluster-stack-operator" }, { diff --git a/sidebarsDocs.js b/sidebarsDocs.js index 36ba19fcc0..b3e20cce7c 100644 --- a/sidebarsDocs.js +++ b/sidebarsDocs.js @@ -74,123 +74,105 @@ const sidebarsDocs = { items: [ { type: 'category', - label: 'Overview', + label: 'Guides', link: { type: 'generated-index' }, - items: [ - // 'container/overview/architecture', - // 'container/overview/knowledge' - ] + items: ['container/guides/guide1'] }, { type: 'category', - label: 'Deployment Examples', + label: 'Components', link: { type: 'generated-index' }, items: [ + 'container/components/cluster-stacks/overview', + { + type: 'category', + label: 'Cluster Stack Operator', + link: { + type: 'generated-index' + }, + items: [ + 'container/components/cluster-stack-operator/architecture/overview', + 'container/components/cluster-stack-operator/topics/quickstart', + 'container/components/cluster-stack-operator/topics/troubleshoot', + 'container/components/cluster-stack-operator/develop/develop' + ] + }, + { + type: 'category', + label: 'Cluster Stack Provider OpenStack', + items: [ + 'container/components/cluster-stack-provider-openstack/docs/overview', + 'container/components/cluster-stack-provider-openstack/docs/quickstart', + 'container/components/cluster-stack-provider-openstack/docs/controllers', + 'container/components/cluster-stack-provider-openstack/docs/develop' + ] + }, + { + type: 'category', + label: 'csctl', + items: [ + 'container/components/csctl/overview', + 'container/components/csctl/quickstart', + 'container/components/csctl/getting_started', + 'container/components/csctl/developing-and-testing-csctl' + ] + }, { type: 'category', - label: 'Deployment A', + label: 'Container Registry', link: { type: 'generated-index' }, items: [ - // 'container/deployment-examples/a/index', - // 'container/deployment-examples/a/hardware', - // 'container/deployment-examples/a/software' + 'container/components/container-registry/docs/quickstart', + 'container/components/container-registry/docs/scs-deployment', + 'container/components/container-registry/docs/rate_limit', + 'container/components/container-registry/docs/upgrade', + 'container/components/container-registry/docs/backup_and_restore', + 'container/components/container-registry/docs/migration', + 'container/components/container-registry/docs/persistence', + 'container/components/container-registry/docs/ha-deployment' ] + }, + { + type: 'category', + label: 'Cluster Gen', + items: ['container/deployment-examples/a/software'] } ] }, { type: 'category', - label: 'Guides', - link: { - type: 'generated-index' - }, - items: [ - // 'container/guides/guide1' - ] - }, - { - type: 'category', - label: 'Components', + label: 'Deployment Examples', link: { type: 'generated-index' }, items: [ { type: 'category', - label: 'Cluster Stacks', - link: { - type: 'generated-index' - }, + label: 'Predefined Cluster Stacks', items: [ - 'container/components/cluster-stacks/components/cluster-stacks/overview', - { - type: 'category', - label: 'Cluster Stack Operator', - items: [ - 'container/components/cluster-stacks/components/cluster-stack-operator/architecture/overview', - 'container/components/cluster-stacks/components/cluster-stack-operator/topics/quickstart', - 'container/components/cluster-stacks/components/cluster-stack-operator/topics/troubleshoot', - 'container/components/cluster-stacks/components/cluster-stack-operator/develop/develop' - ] - }, - { - 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', + label: 'Openstack', 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: 'Predefined Cluster Stacks', - items: [ - { - type: 'category', - label: 'Openstack', - items: [ - 'container/components/cluster-stacks/components/cluster-stacks/providers/openstack/quickstart', - 'container/components/cluster-stacks/components/cluster-stacks/providers/openstack/configuration' - ] - } + 'container/components/cluster-stacks/providers/openstack/quickstart', + 'container/components/cluster-stacks/providers/openstack/configuration' ] } ] }, { type: 'category', - label: 'Container Registry', + label: 'Moin Cluster', link: { type: 'generated-index' }, - items: [ - 'container/components/container-registry/docs/quickstart', - 'container/components/container-registry/docs/scs-deployment', - 'container/components/container-registry/docs/rate_limit', - 'container/components/container-registry/docs/upgrade', - 'container/components/container-registry/docs/backup_and_restore', - 'container/components/container-registry/docs/migration', - 'container/components/container-registry/docs/persistence', - 'container/components/container-registry/docs/ha-deployment' - ] + items: ['container/deployment-examples/a/software'] } ] }