diff --git a/sidebars.js b/sidebars.js index 41f47c12..9b2ccc7d 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,247 +1,247 @@ -const {Component} = require("react"); +const { Component } = require("react"); module.exports = { - docs: [ + docs: [ + { + type: 'category', + label: 'Getting Started', + collapsed: false, + items: [ + 'getting-started/introduction', + 'getting-started/quick-install', + 'getting-started/first-application', + ], + }, + { + type: 'category', + label: 'Core Concepts', + collapsed: false, + items: [ + 'core-concepts/architecture', + 'core-concepts/application', + ], + }, + { + type: 'category', + label: 'End User Guide', + collapsed: false, + items: [ + // 'end-user/initializer-end-user', { - type: 'category', - label: 'Getting Started', - collapsed: false, - items: [ - 'getting-started/introduction', - 'getting-started/quick-install', - 'getting-started/first-application', - ], + 'Components': [ + 'end-user/components/helm', + 'end-user/components/kustomize', + { + 'Cloud Services': [ + 'end-user/components/cloud-services/alibaba-ack', + 'end-user/components/cloud-services/alibaba-rds', + 'end-user/components/cloud-services/alibaba-oss', + ] + }, + { + 'CUE Component': [ + 'end-user/components/cue/webservice', + 'end-user/components/cue/worker', + 'end-user/components/cue/task', + 'end-user/components/cue/raw', + ] + }, + 'end-user/components/more', + ] }, - { - type: 'category', - label: 'Core Concepts', - collapsed: false, - items: [ - 'core-concepts/architecture', - 'core-concepts/application', - ], - }, - { - type: 'category', - label: 'End User Guide', - collapsed: false, - items: [ - // 'end-user/initializer-end-user', - { - 'Components': [ - 'end-user/components/helm', - 'end-user/components/kustomize', - { - 'Cloud Services': [ - 'end-user/components/cloud-services/alibaba-ack', - 'end-user/components/cloud-services/alibaba-rds', - 'end-user/components/cloud-services/alibaba-oss', - ] - }, - { - 'CUE Component': [ - 'end-user/components/cue/webservice', - 'end-user/components/cue/worker', - 'end-user/components/cue/task', - 'end-user/components/cue/raw', - ] - }, - 'end-user/components/more', - ] - }, - { - 'Traits': [ - 'end-user/traits/ingress', - 'end-user/traits/rollout', - 'end-user/traits/autoscaler', - 'end-user/traits/kustomize-patch', - 'end-user/traits/annotations-and-labels', - 'end-user/traits/service-binding', - 'end-user/traits/sidecar', - 'end-user/traits/more', - ] - }, - // 'end-user/canary-blue-green', v1.1+ 再上 - // { - // 'Components': [ - // 'end-user/components/helm', - // 'end-user/components/kustomize', - // 'end-user/components/cue', - // 'end-user/components/cloud-services', 先隐藏，需要等用户侧的云服务支持 terraform 原生的 HCL - // { - // 'Cloud Services': [ - // { - // 'Terraform': [ - // 'end-user/components/cloud-services/terraform/alibaba-rds', - // 'end-user/components/cloud-services/terraform/alibaba-oss', - // ] - // }, - // ] - // }, - // ] - // }, - { - 'Policies': [ - 'end-user/policies/envbinding', - ] - }, - { - 'Workflow': [ - 'end-user/workflow/multi-env', - 'end-user/workflow/webhook-notification', - ] - }, - { - 'Debugging': [ - // 'end-user/debug/health', - // 'end-user/debug/monitoring', 这部分要和可观测合并 - 'end-user/debug/live-diff', - ] - }, - ] + { + 'Traits': [ + 'end-user/traits/ingress', + 'end-user/traits/rollout', + 'end-user/traits/autoscaler', + 'end-user/traits/kustomize-patch', + 'end-user/traits/annotations-and-labels', + 'end-user/traits/service-binding', + 'end-user/traits/sidecar', + 'end-user/traits/more', + ] + }, + // 'end-user/canary-blue-green', v1.1+ 再上 + // { + // 'Components': [ + // 'end-user/components/helm', + // 'end-user/components/kustomize', + // 'end-user/components/cue', + // 'end-user/components/cloud-services', 先隐藏，需要等用户侧的云服务支持 terraform 原生的 HCL + // { + // 'Cloud Services': [ + // { + // 'Terraform': [ + // 'end-user/components/cloud-services/terraform/alibaba-rds', + // 'end-user/components/cloud-services/terraform/alibaba-oss', + // ] + // }, + // ] + // }, + // ] + // }, + { + 'Policies': [ + 'end-user/policies/envbinding', + ] }, { - type: 'category', - label: 'Case Studies', - collapsed: false, - items: [ - 'case-studies/jenkins-cicd' - // 'case-studies/workflow-edge-computing', // 待完成 - // 'case-studies/li-auto-inc', 暂时下掉，应该改写成一个 10 - 15 分钟体验的产品 lab 例子 - // 'case-studies/workflow-with-ocm', - ], + 'Workflow': [ + 'end-user/workflow/multi-env', + 'end-user/workflow/webhook-notification', + ] }, { - type: 'category', - label: 'Platform Admin Guide', - collapsed: false, - items: [ - { - type: 'category', - label: 'Learning OAM', - collapsed: false, - items: [ - 'platform-engineers/oam/oam-model', - 'platform-engineers/oam/x-definition', - ] - }, - { - 'Learning CUE': [ - 'platform-engineers/cue/basic', - 'platform-engineers/cue/definition-edit', - 'platform-engineers/cue/advanced', - ] - }, - //{ - // 'Environment System': [ - // 'platform-engineers/initializer/basic-initializer', - // ] - //}, - { - type: 'category', - label: 'Component System', - items: [ - 'platform-engineers/components/custom-component', - 'platform-engineers/components/component-terraform', - ] - }, - { - type: 'category', - label: 'Traits System', - items: [ + 'Debugging': [ + // 'end-user/debug/health', + // 'end-user/debug/monitoring', 这部分要和可观测合并 + 'end-user/debug/live-diff', + ] + }, + ] + }, + { + type: 'category', + label: 'Case Studies', + collapsed: false, + items: [ + 'case-studies/jenkins-cicd' + // 'case-studies/workflow-edge-computing', // 待完成 + // 'case-studies/li-auto-inc', 暂时下掉，应该改写成一个 10 - 15 分钟体验的产品 lab 例子 + // 'case-studies/workflow-with-ocm', + ], + }, + { + type: 'category', + label: 'Platform Admin Guide', + collapsed: false, + items: [ + { + type: 'category', + label: 'Learning OAM', + collapsed: false, + items: [ + 'platform-engineers/oam/oam-model', + 'platform-engineers/oam/x-definition', + ] + }, + { + 'Learning CUE': [ + 'platform-engineers/cue/basic', + 'platform-engineers/cue/definition-edit', + 'platform-engineers/cue/advanced', + ] + }, + //{ + // 'Environment System': [ + // 'platform-engineers/initializer/basic-initializer', + // ] + //}, + { + type: 'category', + label: 'Component System', + items: [ + 'platform-engineers/components/custom-component', + 'platform-engineers/components/component-terraform', + ] + }, + { + type: 'category', + label: 'Traits System', + items: [ - 'platform-engineers/traits/customize-trait', - 'platform-engineers/traits/patch-trait', - 'platform-engineers/traits/status', - 'platform-engineers/traits/advanced', - ] - }, - { - 'Workflow System': [ - 'platform-engineers/workflow/steps', - 'platform-engineers/workflow/context', - 'platform-engineers/workflow/data-flow', - 'platform-engineers/workflow/cue-actions', - ] - }, - { - 'System Operation': [ - 'platform-engineers/system-operation/bootstrap-parameters', - 'platform-engineers/system-operation/observability', - 'platform-engineers/system-operation/performance-finetuning', - ] - }, - { - 'Debugging': [ - 'platform-engineers/debug/dry-run', - ] - }, - 'platform-engineers/advanced-install', - ] + 'platform-engineers/traits/customize-trait', + 'platform-engineers/traits/patch-trait', + 'platform-engineers/traits/status', + 'platform-engineers/traits/advanced', + ] }, { - type: 'category', - label: 'Using KubeVela CLI', - items: [ - { - 'Appfile': [ - 'quick-start-appfile', - 'developers/learn-appfile', - ] - }, - { - 'Managing Applications': [ - 'developers/config-enviroments', - 'developers/port-forward', - 'developers/check-logs', - 'developers/exec-cmd', - 'developers/cap-center', - 'developers/config-app', - ] - }, - ], + 'Workflow System': [ + 'platform-engineers/workflow/steps', + 'platform-engineers/workflow/context', + 'platform-engineers/workflow/data-flow', + 'platform-engineers/workflow/cue-actions', + ] }, { - type: 'category', - label: 'References', - items: [ - { - type: 'category', - label: 'CLI', - items: [ - 'cli/vela_components', - 'cli/vela_config', - 'cli/vela_env', - 'cli/vela_init', - 'cli/vela_up', - 'cli/vela_version', - 'cli/vela_exec', - 'cli/vela_logs', - 'cli/vela_ls', - 'cli/vela_port-forward', - 'cli/vela_show', - 'cli/vela_status', - 'cli/vela_workloads', - 'cli/vela_traits', - 'cli/vela_system', - 'cli/vela_template', - 'cli/vela_cap', - ], - }, - 'developers/references/kubectl-plugin' - ], + 'System Operation': [ + 'platform-engineers/system-operation/bootstrap-parameters', + 'platform-engineers/system-operation/observability', + 'platform-engineers/system-operation/performance-finetuning', + ] }, { - type: 'category', - label: 'Roadmap', - items: [ - 'roadmap/README', - ], + 'Debugging': [ + 'platform-engineers/debug/dry-run', + ] + }, + 'platform-engineers/advanced-install', + ] + }, + { + type: 'category', + label: 'Using KubeVela CLI', + items: [ + { + 'Appfile': [ + 'quick-start-appfile', + 'developers/learn-appfile', + ] }, { - type: 'doc', - id: 'developers/references/devex/faq' + 'Managing Applications': [ + 'developers/config-enviroments', + 'developers/port-forward', + 'developers/check-logs', + 'developers/exec-cmd', + 'developers/cap-center', + 'developers/config-app', + ] }, - ], + ], + }, + { + type: 'category', + label: 'References', + items: [ + { + type: 'category', + label: 'CLI', + items: [ + 'cli/vela_components', + 'cli/vela_config', + 'cli/vela_env', + 'cli/vela_init', + 'cli/vela_up', + 'cli/vela_version', + 'cli/vela_exec', + 'cli/vela_logs', + 'cli/vela_ls', + 'cli/vela_port-forward', + 'cli/vela_show', + 'cli/vela_status', + 'cli/vela_workloads', + 'cli/vela_traits', + 'cli/vela_system', + 'cli/vela_template', + 'cli/vela_cap', + ], + }, + 'developers/references/kubectl-plugin' + ], + }, + { + type: 'category', + label: 'Roadmap', + items: [ + 'roadmap/README', + ], + }, + { + type: 'doc', + id: 'developers/references/devex/faq' + }, + ], };