sidebars.js

/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  // By default, Docusaurus generates a sidebar from the docs folder structure
  //tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],

// TapData Documentation docs list
  TapData: [
  'what-is-tapdata',
    {
     type: 'category',
     label: '产品简介',
     link: {type: 'doc', id: 'introduction/README'},
     items: [
             'introduction/architecture',
             'introduction/features',
             'introduction/benefits',
             'introduction/use-cases',
             'introduction/compare-editions',
             'introduction/change-data-capture-mechanism',
             'introduction/security',
             'introduction/terms',
       ]
    },
    {
     type: 'category',
     label: '快速入门',
     link: {type: 'doc', id: 'quick-start/README'},
     items: [
            'quick-start/install',
            'quick-start/connect-database',
            'quick-start/create-task',
     ]
    },
    {
     type: 'category',
     label: '安装指南',
     link: {type: 'doc', id: 'installation/README'},
     items: [
            {
            type: 'category',
            label: 'TapData Enterprise',
            link: {type: 'doc', id: 'installation/install-tapdata-enterprise/README'},
            items: [
                     'installation/install-tapdata-enterprise/install-tapdata-stand-alone',
                     'installation/install-tapdata-enterprise/install-on-windows',
                     ]
            },
            'installation/install-tapdata-community',
            {
            type: 'category',
            label: 'TapData Cloud Agent',
            link: {type: 'doc', id: 'installation/install-tapdata-agent/README'},
            items: [
                     'installation/install-tapdata-agent/agent-on-selfhosted',
                     'installation/install-tapdata-agent/agent-on-compute-nest',
                 ]
            },
            ]
    },
    {
     type: 'category',
     label: '产品计费',
     link: {type: 'doc', id: 'billing/README'},
     items: [
             'billing/billing-overview',
             'billing/purchase',
             'billing/renew-subscribe',
             'billing/expiration',
             'billing/refund',
       ]
    },
{
         type: 'category',
         label: '连接数据源',
         link: {type: 'doc', id: 'prerequisites/README'},
         items: [
                 'prerequisites/supported-databases',
                 {
                  type: 'category',
                  label: '数据仓库与数据湖',
                  link: {type: 'doc', id: 'prerequisites/warehouses-and-lake/README'},
                  items: [
                          'prerequisites/warehouses-and-lake/big-query',
                          'prerequisites/warehouses-and-lake/clickhouse',
                          'prerequisites/warehouses-and-lake/databend',
                          'prerequisites/warehouses-and-lake/doris',
                          'prerequisites/warehouses-and-lake/gaussdb',
                          'prerequisites/warehouses-and-lake/greenplum',
                          'prerequisites/warehouses-and-lake/hudi',
                          'prerequisites/warehouses-and-lake/paimon',
                          'prerequisites/warehouses-and-lake/selectdb',
                          'prerequisites/warehouses-and-lake/snowflake',
                          'prerequisites/warehouses-and-lake/starrocks',
                          'prerequisites/warehouses-and-lake/tablestore',
                          'prerequisites/warehouses-and-lake/yashandb',
                         ]
                  },
                 {
                  type: 'category',
                  label: '自建数据库',
                  link: {type: 'doc', id: 'prerequisites/on-prem-databases/README'},
                  items: [
                          'prerequisites/on-prem-databases/dameng',
                          'prerequisites/on-prem-databases/db2',
                          'prerequisites/on-prem-databases/db2-for-i',
                          'prerequisites/on-prem-databases/elasticsearch',
                          'prerequisites/on-prem-databases/gbase-8a',
                          'prerequisites/on-prem-databases/gbase-8s',
                          'prerequisites/on-prem-databases/hive1',
                          'prerequisites/on-prem-databases/hive3',
                          'prerequisites/on-prem-databases/informix',
                          'prerequisites/on-prem-databases/kingbase-es-r3',
                          'prerequisites/on-prem-databases/kingbase-es-r6',
                          'prerequisites/on-prem-databases/mariadb',
                          'prerequisites/on-prem-databases/mongodb',
                          'prerequisites/on-prem-databases/mongodb-below34',
                          'prerequisites/on-prem-databases/mrs-hive3',
                          'prerequisites/on-prem-databases/mysql',
                          'prerequisites/on-prem-databases/mysql-pxc',
                          'prerequisites/on-prem-databases/oceanbase',
                          'prerequisites/on-prem-databases/oceanbase-oracle',
                          'prerequisites/on-prem-databases/opengauss',
                          'prerequisites/on-prem-databases/oracle',
                          'prerequisites/on-prem-databases/postgresql',
                          'prerequisites/on-prem-databases/redis',
                          'prerequisites/on-prem-databases/sqlserver',
                          'prerequisites/on-prem-databases/sybase',
                          'prerequisites/on-prem-databases/tdengine',
                          'prerequisites/on-prem-databases/tidb',
                          'prerequisites/on-prem-databases/vastbase',
                          ]
                  },
                  {
                   type: 'category',
                   label: '云数据库',
                   link: {type: 'doc', id: 'prerequisites/cloud-databases/README'},
                   items: [
                           'prerequisites/cloud-databases/aliyun-adb-mysql',
                           'prerequisites/cloud-databases/aliyun-adb-postgresql',
                           'prerequisites/cloud-databases/aliyun-mongodb',
                           'prerequisites/cloud-databases/aliyun-rds-for-mariadb',
                           'prerequisites/cloud-databases/aliyun-rds-for-mongodb',
                           'prerequisites/cloud-databases/aliyun-rds-for-mysql',
                           'prerequisites/cloud-databases/aliyun-rds-for-pg',
                           'prerequisites/cloud-databases/aliyun-rds-for-sql-server',
                           'prerequisites/cloud-databases/amazon-rds-mysql',
                           'prerequisites/cloud-databases/huawei-cloud-gaussdb',
                           'prerequisites/cloud-databases/mongodb-atlas',
                           'prerequisites/cloud-databases/polardb-mysql',                           
                           'prerequisites/cloud-databases/polardb-postgresql',
                           'prerequisites/cloud-databases/tencentdb-for-mysql',
                           'prerequisites/cloud-databases/tencentdb-for-mariadb',
                           'prerequisites/cloud-databases/tencentdb-for-mongodb',
                           'prerequisites/cloud-databases/tencentdb-for-pg',
                           'prerequisites/cloud-databases/tencentdb-for-sql-server',
                          ]
                   },
                  {
                   type: 'category',
                   label: '消息队列与中间件',
                   link: {type: 'doc', id: 'prerequisites/mq-and-middleware/README'},
                   items: [
                           'prerequisites/mq-and-middleware/activemq',
                           'prerequisites/mq-and-middleware/ai-chat',
                           'prerequisites/mq-and-middleware/bes-channels',
                           'prerequisites/mq-and-middleware/hazelcast-cloud',
                           'prerequisites/mq-and-middleware/kafka-enhanced',
                           'prerequisites/mq-and-middleware/kafka',
                           'prerequisites/mq-and-middleware/rabbitmq',
                           'prerequisites/mq-and-middleware/rocketmq',
                          ]
                   },
                   {
                   type: 'category',
                   label: '客户管理与销售运营分析',
                   link: {type: 'doc', id: 'prerequisites/crm-and-sales-analytics/README'},
                   items: [
                           'prerequisites/crm-and-sales-analytics/hubspot',
                           'prerequisites/crm-and-sales-analytics/metabase',
                           'prerequisites/crm-and-sales-analytics/salesforce',
                           'prerequisites/crm-and-sales-analytics/zoho-crm',
                          ]
                   },
                   {
                    type: 'category',
                    label: 'SaaS 应用与 API 服务',
                    link: {type: 'doc', id: 'prerequisites/saas-and-api/README'},
                    items: [
                            'prerequisites/saas-and-api/coding',
                            'prerequisites/saas-and-api/feishu-bitable',
                            'prerequisites/saas-and-api/github',
                            'prerequisites/saas-and-api/lark-approval',
                            'prerequisites/saas-and-api/lark-doc',
                            'prerequisites/saas-and-api/lark-im',
                            'prerequisites/saas-and-api/lark-task',
                            'prerequisites/saas-and-api/quick-api',
                            'prerequisites/saas-and-api/vika',
                            'prerequisites/saas-and-api/zoho-desk',
                           ]
                   },
                   {
                    type: 'category',
                    label: '电商平台',
                    link: {type: 'doc', id: 'prerequisites/e-commerce/README'},
                    items: [
                            'prerequisites/e-commerce/alibaba-1688',
                            'prerequisites/e-commerce/shein',
                           ]
                   },
                   {
                    type: 'category',
                    label: '文件',
                    link: {type: 'doc', id: 'prerequisites/files/README'},
                    items: [
                            'prerequisites/files/csv',
                            'prerequisites/files/excel',
                            'prerequisites/files/json',
                            'prerequisites/files/xml',
                           ]
                   },
                   {
                    type: 'category',
                    label: '其他',
                    link: {type: 'doc', id: 'prerequisites/others/README'},
                    items: [
                            'prerequisites/others/custom-connection',
                            'prerequisites/others/dummy',
                            'prerequisites/others/http-receiver',
                            'prerequisites/others/mock-source',
                            'prerequisites/others/mock-target',
                           ]
                   },
         ]
    },
    {
     type: 'category',
     label: '用户指南',
     link: {type: 'doc', id: 'user-guide/README'},
     items: [
             'user-guide/log-in',
             'user-guide/workshop',
             'user-guide/manage-agent',
             'user-guide/manage-connection',
             {
              type: 'category',
              label: '实时数据中心',
              link: {type: 'doc', id: 'user-guide/real-time-data-hub/README'},
              items:[
                    {
                     type: 'category',
                     label: '数据集成模式',
                     link: {type: 'doc', id: 'user-guide/real-time-data-hub/etl-mode/README'},
                     items:[
                            'user-guide/real-time-data-hub/etl-mode/etl-mode-dashboard',
                            'user-guide/real-time-data-hub/etl-mode/create-etl-task',
                           ]
                    },
                    {
                     type: 'category',
                     label: '数据服务平台模式',
                     link: {type: 'doc', id: 'user-guide/real-time-data-hub/daas-mode/README'},
                     items:[
                            'user-guide/real-time-data-hub/daas-mode/enable-daas-mode',
                            'user-guide/real-time-data-hub/daas-mode/daas-mode-dashboard',
                            'user-guide/real-time-data-hub/daas-mode/create-daas-task',
                           ]
                    },
                    ]
             },             
             {
             type: 'category',
             label: '数据复制',
             link: {type: 'doc', id: 'user-guide/copy-data/README'},
             items:[
                     'user-guide/copy-data/create-task',
                     'user-guide/copy-data/quick-create-task',
                     'user-guide/copy-data/manage-task',
                     'user-guide/copy-data/process-node',
                     'user-guide/copy-data/monitor-task',
                    ]
             },
             {
             type: 'category',
             label: '数据转换',
             link: {type: 'doc', id: 'user-guide/data-development/README'},
             items:[
                    'user-guide/data-development/create-task',
                    'user-guide/data-development/create-materialized-view',
                    'user-guide/data-development/manage-task',
                    'user-guide/data-development/process-node',
                    'user-guide/data-development/aggregate-computing-node',
                    'user-guide/data-development/monitor-task',
                   ]
             },
             'user-guide/compare-data-model',
             'user-guide/incremental-check',
             'user-guide/verify-data',
             'user-guide/pre-check',
             {
              type: 'category',
              label: '高级功能',
              link: {type: 'doc', id: 'user-guide/advanced-settings/README'},
              items:[
                     'user-guide/advanced-settings/share-cache',
                     'user-guide/advanced-settings/manage-function',
                     'user-guide/advanced-settings/custom-node',
                     'user-guide/advanced-settings/share-mining',
                     'user-guide/advanced-settings/task-scheduling-balance',
                     'user-guide/advanced-settings/manage-external-storage',
                     {
                     type: 'category',
                     label: '管理项目',
                     link: {type: 'doc', id: 'user-guide/advanced-settings/manage-project/README'},
                     items:[
                            'user-guide/advanced-settings/manage-project/introduction',
                            'user-guide/advanced-settings/manage-project/setup-pipeline',
                            'user-guide/advanced-settings/manage-project/deploy-project',
                           ]
                    },
                    ]
             },
             {
              type: 'category',
              label: '发布数据 API',
              link: {type: 'doc', id: 'user-guide/data-service/README'},
              items:[
                     'user-guide/data-service/manage-app',
                     'user-guide/data-service/create-api-service',
                     'user-guide/data-service/create-api-client',
                     'user-guide/data-service/create-api-server',
                     'user-guide/data-service/audit-api',
                     'user-guide/data-service/monitor-api-request',
                     'user-guide/data-service/api-auth',
                     'user-guide/data-service/query-via-restful',
                     'user-guide/data-service/query-via-graphql',
                     'user-guide/data-service/api-query-params',
                    ]
             },
             {
              type: 'category',
              label: '系统管理',
              link: {type: 'doc', id: 'user-guide/manage-system/README'},
              items:[
                     'user-guide/manage-system/manage-role',
                     'user-guide/manage-system/manage-user',
                     'user-guide/manage-system/configure-sso',
                     'user-guide/manage-system/manage-cluster',
                    ]
             },
             {
              type: 'category',
              label: '其他设置',
              link: {type: 'doc', id: 'user-guide/other-settings/README'},
              items:[
                     'user-guide/other-settings/system-settings',
                     'user-guide/other-settings/notification',
                     'user-guide/other-settings/manage-license',
                     'user-guide/other-settings/check-version',
                    ]
             },
             'user-guide/operation-log',
             'user-guide/no-supported-data-type',
        ]
    },
    {
         type: 'category',
         label: 'MCP Server 使用指南',
         link: {type: 'doc', id: 'mcp/README'},
         items: [
                'mcp/introduction',
                'mcp/quick-start',
                ]
     },    
    {
         type: 'category',
         label: 'TapFlow 开发者指南',
         link: {type: 'doc', id: 'tapflow/README'},
         items: [
                'tapflow/introduction',
                'tapflow/quick-start',
                {
                 type: 'category',
                 label: 'TapFlow API 参考',
                 link: {type: 'doc', id: 'tapflow/api-reference/README'},
                 items: [
                        'tapflow/api-reference/data-source',
                        'tapflow/api-reference/data-flow',
                 ]
                },
                'tapflow/tapshell-reference',
                {
                 type: 'category',
                 label: '典型案例',
                 link: {type: 'doc', id: 'tapflow/tapflow-tutorial/README'},
                 items: [
                        'tapflow/tapflow-tutorial/build-real-time-wide-table',
                        'tapflow/tapflow-tutorial/expand-mogodb-array-to-mysql',
                        'tapflow/tapflow-tutorial/merge-inventory-to-mongodb',
                 ]
                },
                ]
     },
    {
     type: 'category',
     label: '管理与运维',
     link: {type: 'doc', id: 'administration/README'},
     items: [
            {
              type: 'category',
              label: '生产部署',
              link: {type: 'doc', id: 'administration/production-deploy/README'},
              items:[
                     'administration/production-deploy/capacity-planning',
                     'administration/production-deploy/install-tapdata-ha',
                     'administration/production-deploy/install-tapdata-ha-with-3-node',
                     'administration/production-deploy/disaster-recovery',
                     'administration/production-deploy/install-replica-mongodb',
                     'administration/production-deploy/deploy-on-huawei-k8s',
                    ]
             },
            'administration/operation',
            {
              type: 'category',
              label: 'Prometheus 监控',
              link: {type: 'doc', id: 'administration/prometheus/README'},
              items: [
                     'administration/prometheus/deployment',
                     'administration/prometheus/metrics',
                     'administration/prometheus/grafana',
                     'administration/prometheus/alerting',
                    ]
            },
            {
              type: 'category',
              label: '故障排查',
              link: {type: 'doc', id: 'administration/troubleshooting/README'},
              items: [
                     'administration/troubleshooting/task-troubleshooting',
                     'administration/troubleshooting/error-code',
                     'administration/troubleshooting/error-and-solutions',
                     ]
            },
            'administration/emergency-plan',
        ]
    },
    {
     type: 'category',
     label: '案例实践',
     link: {type: 'doc', id: 'case-practices/README'},
     items: [
             {
            type: 'category',
            label: '同步案例',
            link: {type: 'doc', id: 'case-practices/pipeline-tutorial/README'},
            items: [
                    'case-practices/pipeline-tutorial/mysql-bi-directional-sync',
                    'case-practices/pipeline-tutorial/excel-to-mysql',
                    'case-practices/pipeline-tutorial/mysql-to-aliyun',
                    'case-practices/pipeline-tutorial/mysql-to-bigquery',
                    'case-practices/pipeline-tutorial/mysql-to-redis',
                    'case-practices/pipeline-tutorial/oracle-to-kafka',
                    'case-practices/pipeline-tutorial/oracle-to-tablestore',
                    'case-practices/pipeline-tutorial/extract-array',
                    ]
            },
            {
             type: 'category',
             label: '最佳实践',
             link: {type: 'doc', id: 'case-practices/best-practice/README'},
             items: [
                'case-practices/best-practice/data-sync',
                'case-practices/best-practice/handle-schema-change',
                'case-practices/best-practice/heart-beat-task',
                'case-practices/best-practice/alert-via-qqmail',
                'case-practices/best-practice/full-breakpoint-resumption',
                'case-practices/best-practice/raw-logs-solution',
            ]
        },
        ]
    },
    {
     type: 'category',
     label: '常见问题',
     link: {type: 'doc', id: 'faq/README'},
     items: [
            'faq/use-product',
            'faq/data-pipeline',
            'faq/agent-installation',
            'faq/data-security',
        ]
    },
    {
     type: 'category',
     label: '附录',
     link: {type: 'doc', id: 'appendix/README'},
     items: [
            'appendix/standard-js',
            'appendix/enhanced-js',
            'appendix/benchmark',
            'appendix/support'
        ]
    },
    {
     type: 'category',
     label: '更新日志',
     link: {type: 'doc', id: 'release-notes/README'},
     items: [
            'release-notes/release-notes-cloud',
            'release-notes/release-notes-on-prem',
            'release-notes/release-notes-community'
        ]
    },
 ]
};

module.exports = sidebars;