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
# - A doc node may have edition: ee for enterprise only content
#
# Grouping node
# - Must have a 'title_en' (English), 'title_cn' (Chinese) is optional wehn 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: Introduction
  title_cn: 概览
  path: "./" # this is the index page, {en_US,zh_CN}/README.md is the content

- title_en: Getting Started
  title_cn: 快速开始
  children:
    - getting-started/getting-started
    - getting-started/restrictions
    - getting-started/new-features

## Infrastructure

- title_en: Installation
  title_cn: 安装部署
  children:
    - title_en: Install
      title_cn: 安装
      children:
        - deploy/install
        - deploy/install-docker
        - deploy/install-k8s
        - deploy/install-debian
        - deploy/install-ubuntu
        - deploy/install-centos
        - deploy/install-amazon-linux
        - deploy/install-macOS
        - title_en: Windows
          title_cn: Windows
          path: deploy/install-windows
          edition: ce
        - title_en: Install from Source code
          title_cn: 源码编译安装
          path: deploy/install-source
          edition: ce
        # - deploy/install-marketplace
    - title_en: Use license
      title_cn: 配置 License
      edition: ee
      path: deploy/license
  # - title_en: Upgrade
  #   title_cn: 升级
  #   children:
  #     - deploy/hot-upgrades
  #     - deploy/rolling-upgrades
    - deploy/upgrade-from-v4
  # - title_en: Migrate to Enterprise
  #   title_cn: 迁移到企业版
  #   path: deploy/migrate-to-enterprise
    
- title_en: Clustering
  title_cn: 构建集群
  children:
    - deploy/cluster/introduction
    - deploy/cluster/mria-introduction
    - deploy/cluster/create-cluster
    - deploy/cluster/security
    - deploy/cluster/lb
    - title_en: Performance and Tuning
      title_cn: 性能与调优
      children:
        - performance/tune
        - performance/benchmark

- title_en: Access Control
  title_cn: 访问控制
  children:
    - title_en: Authentication
      title_cn: 认证
      children:
        - access-control/authn/authn
        - title_en: Password Based
          title_cn: 密码认证
          children:
            - access-control/authn/mnesia
            - access-control/authn/mysql
            - access-control/authn/postgresql
            - access-control/authn/redis
            - access-control/authn/mongodb
            - access-control/authn/http
        - access-control/authn/jwt
        - access-control/authn/scram
        - access-control/authn/user_management

    - title_en: Authorization
      title_cn: 授权
      children:
        - access-control/authz/authz
        - access-control/authz/file
        - access-control/authz/mnesia
        - access-control/authz/http
        - access-control/authz/mysql
        - access-control/authz/postgresql
        - access-control/authz/redis
        - access-control/authz/mongodb
    - access-control/blacklist

- title_en: Publish/Subscribe
  title_cn: 发布订阅
  children:
    # - messaging/introduction
    - messaging/mqtt-publish-and-subscribe
    - messaging/explore-mqtt
    - mqtt/mqtt-exclusive-subscription
    - mqtt/mqtt-delayed-publish
    - mqtt/mqtt-auto-subscription
    - mqtt/mqtt-topic-rewrite
    # - messaging/nanomq
    # - messaging/neuron

# MQTT over QUIC

- title_en: MQTT over QUIC
  title_cn: MQTT over QUIC
  children:
    - mqtt-over-quic/introduction
    - mqtt-over-quic/getting-started
    # - mqtt-over-quic/client

## Data integration
# - data-integration/introduction

- title_en: Rule Engine
  title_cn: 规则引擎
  children:
    - data-integration/rules
    - data-integration/rule-sql-syntax
    - data-integration/rule-sql-events-and-fields
    - data-integration/rule-sql-builtin-functions
    - data-integration/rule-sql-jq
    # - data-integration/rule-sql-user-defined-function

- title_en: Data Bridges
  title_cn: 数据桥接
  children:
    - data-integration/data-bridges
    - data-integration/data-bridge-webhook
    - data-integration/data-bridge-mqtt
    - data-integration/data-bridge-kafka
    - data-integration/data-bridge-influxdb
    - data-integration/data-bridge-mysql
    - data-integration/data-bridge-redis
    - data-integration/data-bridge-gcp-pubsub
    - data-integration/data-bridge-mongodb
    # - data-integration/data-bridge-pgsql

    # TODO
    # - title_en: Examples and Tutorials
    #   title_cn: 示例和教程
    #   children:
    #     - data-integration/rule-configs
    # - title_en: Schema Registry
    #   title_cn: Schema 注册
    #   edition: ee
    #   children:
    #     - data-integration/schema-registry

- title_en: Network and TLS
  title_cn: 网络与 TLS
  children:
    - network/emqx-mqtt-tls
    - network/mqtt-client-tls
    # - network/crl-and-ocsp-stapling
    - title_en: GMSSL
      title_cn: 国密 SSL
      lang: cn
      path: network/gmssl
    # - network/ipv6

- title_en: Command Line Interface
  title_cn: 命令行接口
  path: admin/cli

- title_en: REST API
  title_cn: REST API
  children:
    - admin/api
    - title_en: API Docs
      title_cn: API 文档
      lang: en
      edition: ce
      path: https://www.emqx.io/docs/en/v5.0/admin/api-docs.html
    - title_en: API Docs
      title_cn: API 文档
      lang: cn
      edition: ce
      path: https://www.emqx.io/docs/zh/v5.0/admin/api-docs.html
    - title_en: API Docs
      title_cn: API 文档
      lang: en
      edition: ee
      path: https://docs.emqx.com/en/enterprise/v5.0/admin/api-docs.html
    - title_en: API Docs
      title_cn: API 文档
      lang: cn
      edition: ee
      path: https://docs.emqx.com/zh/enterprise/v5.0/admin/api-docs.html

## Dashboard

- title_en: Dashboard
  title_cn: Dashboard
  children:
    - dashboard/introduction
    - dashboard/dashboard
    - dashboard/connections/connections
    - title_en: Subscriptions
      title_cn: 主题订阅
      children:
        - dashboard/subscriptions/subscriptions
        - dashboard/subscriptions/topics
    - dashboard/retained
    - title_en: Access Control
      title_cn: 访问控制
      children:
        - dashboard/authn
        - dashboard/authz
        - dashboard/blacklist
    - title_en: Data Integration
      title_cn: 数据集成
      children:
        - dashboard/bridge
        - dashboard/rules
        - dashboard/flows
    - dashboard/configuration
    - dashboard/extensions
    - dashboard/diagnose
    - dashboard/system

# Configuration

- title_en: Configuration
  title_cn: 配置文件参数
  children:
    - configuration/configuration
    - configuration/configuration-manual

# - title_en: Back
#   title_cn: 运维操作
#   children:
# 备份与恢复
- operations/backup-restore
    # - title_en: Hot Upgrades
    #   title_cn: 版本热升级
    #   path: deploy/hot-upgrades
    # - title_en: Rolling Upgrades
    #   title_cn: 滚动升级
    #   path: deploy/hot-upgrades
    # - operations/debug
    # - operations/diagnostic-mode
    # - operations/production-notes

- title_en: Rate Limit
  title_cn: 速率限制
  path: rate-limit/rate-limit

- title_en: Log and Observability
  title_cn: 日志及可观测性
  children:
    - observability/log
    - observability/metrics-and-stats
    - observability/prometheus
    - observability/statsd
    - observability/tracer
    - observability/alarms
    - observability/topic-metrics
    - observability/slow-subscribers-statistics

## Device connectivity

- title_en: Extended Protocol Gateway
  title_cn: 扩展协议网关
  children:
    - gateway/gateway
    - gateway/mqttsn
   #- gateway/lwm2m
    - gateway/coap
    - gateway/stomp
   #- gateway/ocpp
   #- gateway/jt808
   #- gateway/gbt32960
   #- gateway/tcp
   #- gateway/exproto

# - title_en: Advanced MQTT Features
#   title_cn: MQTT 高级特性
#   children:
    # - advanced/retained
    # - advanced/shared-subscriptions
    # - advanced/delayed-publish
    # - advanced/auto-subscriptions
    # - advanced/topic-rewrite
    # - advanced/system-topic
    # - advanced/quic

## Developers & Testers

- title_en: Plugins and Extensions
  title_cn: 插件与扩展
  children:
    - extensions/introduction
    - extensions/hooks
    - extensions/plugins
    # - extensions/lang-lua
    - extensions/exhook

- title_en: MQTT Specific
  title_cn: MQTT 协议
  children:
    - mqtt/mqtt-specific
    # - mqtt/mqtt-compliance
    - mqtt/mqtt-publish-and-subscribe
    - mqtt/mqtt-session-and-message-expiry
    - mqtt/mqtt-keepalive
    - mqtt/mqtt-qos
    - mqtt/mqtt-retained-messages
    - mqtt/mqtt-last-will-and-testament
    - mqtt/mqtt-shared-subscription
    - mqtt/mqtt-system-topics

- title_en: Telemetry
  title_cn: 遥测
  path: telemetry/telemetry
  edition: ce

- title_en: FAQ
  title_cn: 常见问题解答
  path: faq/faq

- title_en: Design & Implementation
  title_cn: 设计与实现
  children:
    # - design/design
    - advanced/inflight-window-and-message-queue
    - advanced/retransmission
    # - title_en: SDK & Tools
    #   title_cn: SDK 与工具
    #   children:
    #     - development/client
    #     - development/c
    #     - development/java
    #     - development/go
    #     - development/erlang
    #     - development/javascript
    #     - development/python
    #     - development/resource

# - title_en: Change log
#   title_cn: 版本发布记录
#   path: changes/changes-5.0

- title_en: Technical Support
  title_cn: 技术支持
  path: support/technical-support