dir.yaml

---
# How it is organised
#
# - Each doc node is a yaml dict
# - A doc node is either a grouping node or a content node
#
# Grouping node
# - Must have a 'title_en' (English), 'title_cn' (Chinese) is optional when no need to translate. e.g. FAQ
# - Parent nodes must NOT have a 'path'
#
# Content node can be one of:
# - Just the path to the markdown file (the first line of which is extracted as its title)
#   the path is relative inside the per-language sub-dir i.e. en_US and zh_CN
# - A node with 'title_en' 'title_cn' and 'path'

- title_en: Overview
  title_cn: 概述
  path: "./" # this is the index page, {en_US,zh_CN}/README.md is the content

#- title_en: Introduction
#  title_cn: 关于Datalayers
#  collapsed: false
#  children:
#    - title_en: Introduction
#      title_cn: 产品简介
#      path: introduction/introduction
#    - title_en: Architecture
#      title_cn: 系统架构
#      path: introduction/architecture

- title_en: Getting Started
  title_cn: 快速开始
  collapsed: false
  children:
    - title_en: Installation
      title_cn: 安装部署
      children:
        - title_en: Docker
          title_cn: Docker
          path: getting-started/docker
        - title_en: Ubuntu
          title_cn: Ubuntu
          path: getting-started/ubuntu
        - title_en: CentOS
          title_cn: CentOS
          path: getting-started/centos
    - title_en: Command-line Tool
      title_cn: 命令行工具
      path: getting-started/command-line-tool

- title_en: Development Guide
  title_cn: 最佳实践（开发指南）
  collapsed: false
  children:
    - title_en: Concepts
      title_cn: 概念
      path: development-guide/concepts
    - title_en: Database Connection
      title_cn: 数据库连接
      path: development-guide/connection
      collapsed: true
      children:
        - title_en: Arrow Flight SQL
          title_cn: Arrow Flight SQL
          path: development-guide/arrow-flight-sql
        - title_en: PostgreSQL Protocol
          title_cn: PostgreSQL 协议
          path: development-guide/postgresql/overview
        - title_en: Prometheus Protocol
          title_cn: Prometheus 协议
          path: development-guide/prometheus/overview
        - title_en: REST API
          title_cn: REST API
          path: development-guide/rest-api/overview
        - title_en: InfluxDB Line Protocol
          title_cn: InfluxDB Line Protocol
          path: development-guide/writing-with-influxdb-line-protocol
        - title_en: Redis Protocol
          title_cn: Redis 协议
          path: development-guide/redis
    - title_en: Table Design Best Practices
      title_cn: 数据表设计
      path: development-guide/table-design/overview
      collapsed: true
      children:
        - title_en: Overview
          title_cn: 概述
          path: development-guide/table-design/overview
        - title_en: Time-Series Table Design
          title_cn: 时序存储
          path: development-guide/table-design/timeseries-table-design
        - title_en: Fulltext
          title_cn: 全文检索
          path: development-guide/table-design/fulltext-table-design
    - title_en: High-Performance Writing
      title_cn: 高性能写入
      path: development-guide/high-performance-ingestion
    - title_en: Query Performance Tuning
      title_cn: 查询加速
      path: development-guide/query-performance-tuning-overview
      collapsed: true
      children:
        - title_en: Index Cache
          title_cn: 索引缓存调优
          path: development-guide/query-optimization/index-cache-optimization
        - title_en: Data Cache
          title_cn: 热点数据缓存
          path: development-guide/query-optimization/hybrid-cache-optimization
        - title_en: Last Cache
          title_cn: Last Cache
          path: development-guide/query-optimization/last-cache-optimization
        - title_en: SQL Hints
          title_cn: SQL Hints
          path: development-guide/query-optimization/hints/overview
          collapsed: true
          children:
            - title_en: Query Parallelism Control
              title_cn: 查询并行度控制
              path: development-guide/query-optimization/hints/parallel-degree
            - title_en: Index Hints
              title_cn: Index Hints
              path: development-guide/query-optimization/hints/index
    - title_en: Downsampling
      title_cn: 时间窗口查询
      path: development-guide/time-window-aggregation-query
    - title_en: Object Storage
      title_cn: 对象存储
      path: development-guide/object-storage
- title_en: SQL Reference
  title_cn: SQL 参考
  collapsed: true
  children:
    - title_en: Data Type
      title_cn: 数据类型
      path: sql-reference/data-type
    - title_en: Operator
      title_cn: 运算符
      path: sql-reference/operators
    - title_en: Table Engine
      title_cn: 表引擎
      collapsed: true
      path: sql-reference/table-engine
      children:
        - title_en: Time-Series Engine
          title_cn: 时序引擎
          path: sql-reference/table-engine/timeseries
    - title_en: SQL Statements
      title_cn: SQL 语句
      collapsed: true
      children:
        - title_en: CREATE
          title_cn: CREATE
          path: sql-reference/statements/create
        - title_en: INSERT
          title_cn: INSERT
          path: sql-reference/statements/insert
        - title_en: SELECT
          title_cn: SELECT
          path: sql-reference/statements/select
          collapsed: true
          children:
            - title_en: WHERE
              title_cn: WHERE
              path: sql-reference/statements/where
            - title_en: LIMIT
              title_cn: LIMIT
              path: sql-reference/statements/limit
            - title_en: GROUP BY
              title_cn: GROUP BY
              path: sql-reference/statements/group-by
            - title_en: ORDER BY
              title_cn: ORDER BY
              path: sql-reference/statements/order-by
            - title_en: DISTINCT
              title_cn: DISTINCT
              path: sql-reference/statements/distinct
            - title_en: HAVING
              title_cn: HAVING
              path: sql-reference/statements/having
            - title_en: CASE
              title_cn: CASE
              path: sql-reference/statements/case
            - title_en: CTE
              title_cn: CTE
              path: sql-reference/statements/cte
            - title_en: EXISTS
              title_cn: EXISTS
              path: sql-reference/statements/exists
            - title_en: JOIN
              title_cn: JOIN
              path: sql-reference/statements/join
            - title_en: PIVOT
              title_cn: PIVOT
              path: sql-reference/statements/pivot
            - title_en: UNPIVOT
              title_cn: UNPIVOT
              path: sql-reference/statements/unpivot
            - title_en: SUBQUERY
              title_cn: SUBQUERY
              path: sql-reference/statements/subquery
            - title_en: UNION
              title_cn: UNION
              path: sql-reference/statements/union
            - title_en: WINDOW FUNCTION
              title_cn: WINDOW FUNCTION
              path: sql-reference/statements/window-function
            - title_en: WITHIN GROUP
              title_cn: WITHIN GROUP
              path: sql-reference/statements/within-group
        - title_en: ALTER
          title_cn: ALTER
          path: sql-reference/statements/alter
        - title_en: USE
          title_cn: USE
          path: sql-reference/statements/use
        - title_en: SHOW
          title_cn: SHOW
          path: sql-reference/statements/show
        - title_en: DESC
          title_cn: DESC
          path: sql-reference/statements/desc
        - title_en: DROP
          title_cn: DROP
          path: sql-reference/statements/drop
        - title_en: REFRESH
          title_cn: REFRESH
          path: sql-reference/statements/refresh
        - title_en: EXPLAIN
          title_cn: EXPLAIN
          path: sql-reference/statements/explain
        # - title_en: DELETE
        #   title_cn: DELETE
        #   path: sql-reference/statements/delete
        - title_en: TRIM
          title_cn: TRIM
          path: sql-reference/statements/trim
        - title_en: TRUNCATE
          title_cn: TRUNCATE
          path: sql-reference/statements/truncate
        - title_en: FLUSH
          title_cn: FLUSH
          path: sql-reference/statements/flush
        - title_en: COMPACT
          title_cn: COMPACT
          path: sql-reference/statements/compact
        - title_en: EXCLUDE
          title_cn: EXCLUDE
          path: sql-reference/statements/exclude
        - title_en: INCLUDE
          title_cn: INCLUDE
          path: sql-reference/statements/include
        - title_en: REBALANCE
          title_cn: REBALANCE
          path: sql-reference/statements/rebalance
    - title_en: Functions
      title_cn: 函数
      collapsed: true
      children:
        - title_en: Aggregation
          title_cn: 聚合函数
          path: sql-reference/aggregation
        - title_en: Date
          title_cn: 时间与日期函数
          path: sql-reference/date
        - title_en: Math
          title_cn: 数学函数
          path: sql-reference/math
        - title_en: Gap Fill
          title_cn: 插值函数
          path: sql-reference/gap_fill
        - title_en: JSON
          title_cn: JSON 函数
          path: sql-reference/json
        - title_en: Cast
          title_cn: 类型转换函数
          path: sql-reference/cast
        - title_en: Streaming Window Functions
          title_cn: 流式窗口函数
          path: sql-reference/streaming-window
        - title_en: Fulltext Functions
          title_cn: 全文索引函数
          path: sql-reference/fulltext-functions
        - title_en: Vector Functions
          title_cn: 向量函数
          path: sql-reference/vector-functions
        #- title_en: String
        #  title_cn: 字符串函数
        #  path: sql-reference/string
    - title_en: INFORMATION_SCHEMA
      title_cn: INFORMATION_SCHEMA
      path: sql-reference/information-schema
    - title_en: Configure Column Codec
      title_cn: 列编码与压缩算法
      path: sql-reference/column-codec
- title_en: Log Search
  title_cn: 全文检索（Beta）
  collapsed: true
  children:
    - title_en: Overview
      title_cn: 概述
      path: fulltext-search/overview
    - title_en: Quick Start
      title_cn: 快速开始
      path: fulltext-search/quick-start
#- title_en: Clustering
#  title_cn: 构建集群
#  path: cluster/introduction
#  collapsed: true
#  children:
#    - title_en: Concept & Architecture
#      title_cn: 概念与架构
#      path: cluster/concept-architecture
#    - title_en: Docker
#      title_cn: Docker
#      path: cluster/docker
#    - title_en: Manual deployment
#      title_cn: 手动部署
#      path: cluster/manual-deployment
#    - title_en: Kubernetes
#      title_cn: Kubernetes
#      path: cluster/kubernetes
#    - title_en: Performance and Tuning
#      title_cn: 性能与调优
#      path: cluster/server-config-optimization
#- title_en: Edge to Cloud
#  title_cn: 边云同步
#  collapsed: true
#  children:
#    - title_en: introduction
#      title_cn: 介绍
#      path: edge2cloud/introduction

- title_en: Vector Search
  title_cn: 向量检索
  collapsed: true
  children:
    - title_en: Vector Search Overview
      title_cn: 概述
      path: vector-search/overview
    - title_en: Quick Start
      title_cn: 快速开始
      path: vector-search/quick-start
    - title_en: Vector Index 
      title_cn: 向量索引
      path: vector-search/vector-index

- title_en: Streaming
  title_cn: 流计算
  collapsed: true
  children:
    - title_en: Streaming Overview
      title_cn: 概述
      path: streaming/overview
    - title_en: Quick Start
      title_cn: 快速开始
      path: streaming/quick-start
    - title_en: Computation Model
      title_cn: 计算模型
      path: streaming/model
    - title_en: Use cases
      title_cn: 应用示例
      path: streaming/use_cases
    - title_en: Formats
      title_cn: Formats
      path: streaming/format
    - title_en: Connectors
      title_cn: Connectors
      collapsed: true
      children:
        - title_en: Overview
          title_cn: 概述
          path: streaming/connectors
        - title_en: Kafka
          title_cn: Kafka
          path: streaming/kafka
        - title_en: MQTT
          title_cn: MQTT
          path: streaming/mqtt
        - title_en: HTTP
          title_cn: HTTP
          path: streaming/http

- title_en: Key Value Data Model
  title_cn: Key-Value 存储
  collapsed: true
  children:
    - title_en: Overview
      title_cn: 概述
      path: key-value-data-model/overview
    - title_en: Quick Start
      title_cn: 快速开始
      path: key-value-data-model/quick-start
    - title_en: Redis Compatibility
      title_cn: Redis 兼容性
      path: key-value-data-model/redis-compatibility

- title_en: Prometheus
  title_cn: Prometheus
  collapsed: true
  children:
    - title_en: Overview
      title_cn: 概述
      path: prometheus/overview
    - title_en: Quick Start
      title_cn: 快速开始
      path: prometheus/quick-start
    - title_en: PromQL Compatibility
      title_cn: PromQL 兼容性
      path: prometheus/promql-compatibility

- title_en: Operation Guide
  title_cn: 运维指南
  collapsed: true
  children:
    #- title_en: Support Platform
    #  title_cn: 支持平台 
    #  path: admin/support-platform
    - title_en: Performance and Tuning
      title_cn: 性能与调优
      collapsed: true
      children:
        - title_en: Performance Tuning (Linux)
          title_cn: 操作系统优化
          path: admin/system-tune
        - title_en: Optimize Configuration
          title_cn: 优化配置
          path: admin/optimize-configuration
    - title_en: Datalayers Configuration
      title_cn: 配置手册
      path: admin/datalayers-configuration
      collapsed: true
      children:
        - title_en: Server Configuration
          title_cn: Server 配置
          path: admin/configuration-fields/server
        - title_en: Time Series Engine Configuration
          title_cn: 时序引擎配置
          path: admin/configuration-fields/ts-engine
        - title_en: Storage Configuration
          title_cn: 存储配置
          path: admin/configuration-fields/storage
        - title_en: Cluster Configuration
          title_cn: 集群配置
          path: admin/configuration-fields/node
        - title_en: Query Configuration
          title_cn: 查询配置
          path: admin/configuration-fields/query
        - title_en: Scheduler Configuration
          title_cn: 调度器配置
          path: admin/configuration-fields/scheduler
        - title_en: Runtime Configuration
          title_cn: Runtime 配置
          path: admin/configuration-fields/runtime
        - title_en: Log Configuration
          title_cn: 日志配置
          path: admin/configuration-fields/log
        - title_en: Audit Logs
          title_cn: 审计日志
          path: admin/configuration-fields/audit-logs
        - title_en: License Configuration
          title_cn: License 配置
          path: admin/configuration-fields/license
    - title_en: Command Line Interface
      title_cn: 命令行工具
      path: admin/datalayers-cli
    #- title_en: Capacity Model
    #  title_cn: 容量模型
    #  path: admin/capacity-model
    - title_en: Backup and Restore 
      title_cn: 备份与恢复
      path: admin/backup-restore
    #- title_en: Compute Node Scaling
    #  title_cn: 计算节点扩缩容
    #  path: admin/compute-node-scaling
    #- title_en: Storage Node Scaling
    #  title_cn: 存储节点扩缩容
    #  path: admin/storage-node-scaling
    - title_en: Statistics and Metrics
      title_cn: 可观测性
      collapsed: false
      children:
        - title_en: Metrics
          title_cn: 指标
          path: admin/system-metrics
        - title_en: Monitor
          title_cn: 系统监控
          path: admin/system-monitor-grafana
- title_en: Integration
  title_cn: 应用集成
  collapsed: true
  children:
    - title_en: EMQX
      title_cn: EMQX
      path: integration/datalayers-with-emqx
    - title_en: Grafana
      title_cn: Grafana
      path: integration/datalayers-with-grafana
    - title_en: OpenTelemetry
      title_cn: OpenTelemetry
      path: integration/datalayers-with-opentelemetry
- title_en: Tools
  title_cn: 管理工具
  collapsed: true
  children:
    - title_en: DBeaver
      title_cn: DBeaver
      path: integration/datalayers-with-dbeaver
- title_en: User & Security
  title_cn: 安全与合规
  collapsed: true
  children:
    - title_en: TLS
      title_cn: 连接加密（TLS）
      path: user-security/tls
    - title_en: Authentication and Authorization
      title_cn: 认证与权限
      collapsed: true
      children:
      - title_en: Authentication
        title_cn: 连接认证
        path: user-security/authentication/overview
        collapsed: true
        children:
        - title_en: Overview
          title_cn: 静态认证
          path: user-security/authentication/static
        - title_en: RBAC 
          title_cn: 基于角色的访问控制（RBAC）
          path: user-security/authentication/rbac
        - title_en: Authentication chain 
          title_cn: 认证链
          path: user-security/authentication/chain
      - title_en: Authorization
        title_cn: 访问控制 
        collapsed: true
        children:
        - title_en: Overview
          title_cn: 概述
          path: user-security/rbac/overview
        - title_en: User Management 
          title_cn: 用户管理
          path: user-security/rbac/user
        - title_en: Role Management
          title_cn: 角色管理
          path: user-security/rbac/role
        - title_en: Privileges
          title_cn: 权限管理
          path: user-security/rbac/privilege
    - title_en: Audit Logs
      title_cn: 审计日志
      path: user-security/audit-logs
    - title_en: Password Policy
      title_cn: 密码策略
      path: user-security/password-policy
- title_en: Release Notes
  title_cn: 版本发布说明
  collapsed: true
  children:
    - title_en: Releases
      title_cn: 版本发布
      path: releases/changes