kubevela.github.io/sidebars.js

const { Component } = require("react");

module.exports = {
  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',
        'end-user/component-delivery',
        'end-user/binding-traits',
        'end-user/cloud-services',
        'end-user/rollout-scaler',
        'end-user/component-observability',
        'end-user/component-dependency-parameter',
        'end-user/multi-app-env-cluster',
          // '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/apply-component',
        //     'end-user/workflow/apply-remaining',
        //     'end-user/workflow/multi-env',
        //   ]
        // },
        {
          'Debugging': [
            // 'end-user/debug/health',
            // 'end-user/debug/monitoring', 这部分要和可观测合并
            'end-user/debug/live-diff',
          ]
        },
      ]
    },
    {
      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',
          ]
        },
        {
          'Addons': [
            'end-user/addons/introduction',
            // 'end-user/addons/fluxcd', 这个应该整体放在 reference 文档里去。它的使用方式，只需要在 helm 组件和 Kustomize 组件使用是 refer 即可。
          ]
        },
        {
          type: 'category',
          label: 'Component System',
          items: [
            {
            type: 'category',
              label: 'Builtin Components',
              items: [
                'platform-engineers/components/built-in/overview',
                'platform-engineers/components/built-in/helm',
                'platform-engineers/components/built-in/kustomize',
                'platform-engineers/components/built-in/raw',
                'platform-engineers/components/built-in/task',
                'platform-engineers/components/built-in/webservice',
                'platform-engineers/components/built-in/worker',
                'platform-engineers/components/built-in/alicloud-ack',
                'platform-engineers/components/built-in/alicloud-oss',
                'platform-engineers/components/built-in/alicloud-rds',
                'platform-engineers/components/built-in/more',
              ]
            },
            'platform-engineers/components/custom-component',
            'platform-engineers/components/component-terraform',
          ]
        },
        {
          type: 'category',
          label: 'Traits System',
          items: [
            {
              type: 'category',
              label: 'Builtin Traits',
              items: [
                'platform-engineers/traits/built-in/overview',
                'platform-engineers/traits/built-in/ingress',
                'platform-engineers/traits/built-in/manual-scaler',
                'platform-engineers/traits/built-in/autoscaler',
                'platform-engineers/traits/built-in/annotations-and-labels',
                'platform-engineers/traits/built-in/sidecar',
                'platform-engineers/traits/built-in/service-binding',
                'platform-engineers/traits/built-in/kustomize-patch',
                'platform-engineers/traits/built-in/more',
              ]
            },
            '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/observability',
            'platform-engineers/system-operation/performance-finetuning',
          ]
        },
        {
          'Debugging': [
            'platform-engineers/debug/dry-run',
          ]
        },
        'platform-engineers/advanced-install',
      ]
    },
    {
      type: 'category',
      label: 'Case Studies',
      collapsed: false,
      items: [
        // 'case-studies/paas',
        //        'case-studies/workflow-edge-computing', // 待完成
        //        'case-studies/li-auto-inc', 暂时下掉，应该改写成一个 10 - 15 分钟体验的产品 lab 例子
        //        'case-studies/workflow-with-ocm',
      ],
    },
    {
      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',
          ]
        },
      ],
    },
    {
      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'
    },
  ],
};