Re: [PR] [DOC]Optimize Seatunnel Document Structure [seatunnel]

[via GitHub]

misi1987107 commented on PR #10262:
URL: https://github.com/apache/seatunnel/pull/10262#issuecomment-3721516590

   The Document Structure Design
   docs/en/
   │
   ├── 📂 introduction/                    (核心概念介绍)
   │   ├── about.md                        ✓ 项目介绍
   │   ├── architecture.md                 ⚠️ TODO - 架构概览
   │   └── 📂 concepts/                    (核心概念)
   │       ├── config.md                   ✓ 配置文件指南
   │       ├── connector-v2-features.md    ✓ 连接器 V2 特性
   │       ├── schema-feature.md           ✓ Schema 特性
   │       ├── schema-evolution.md         ✓ Schema 演变
   │       ├── event-listener.md           ✓ 事件监听器
   │       ├── JobEnvConfig.md             ✓ 作业环境配置
   │       ├── sql-config.md               ✓ SQL 配置
   │       ├── speed-limit.md              ✓ 速度限制
   │       ├── sink-options-placeholders.md ✓ Sink 选项占位符
   │       ├── metalake.md                 ✓ 元数据湖
   │       └── incompatible-changes.md     ✓ 不兼容变更
   │
   ├── 📂 getting-started/                 (快速开始)
   │   ├── 📂 locally/                     (本地部署)
   │   │   ├── deployment.md               ✓ 部署指南
   │   │   ├── quick-start-seatunnel-engine.md ✓ Zeta 快速开始
   │   │   ├── quick-start-flink.md        ✓ Flink 快速开始
   │   │   └── quick-start-spark.md        ✓ Spark 快速开始
   │   ├── 📂 docker/                      (Docker 部署)
   │   │   └── docker.md                   ✓ Docker 指南
   │   └── 📂 kubernetes/                  (Kubernetes 部署)
   │       ├── kubernetes.mdx              ✓ K8s 指南
   │       └── helm.md                     ✓ Helm 指南
   │
   ├── 📂 connectors/                      (连接器文档 - 157+ 个)
   │   ├── overview.md                     ✓ 连接器能力矩阵
   │   ├── 📂 source/                      (79 个 Source 连接器)
   │   │   ├── Mysql.md, PostgreSQL.md, Oracle.md, ...
   │   │   ├── MySQL-CDC.md, PostgreSQL-CDC.md, ...
   │   │   ├── Kafka.md, Pulsar.md, RocketMQ.md, ...
   │   │   ├── Elasticsearch.md, MongoDB.md, Redis.md, ...
   │   │   ├── S3File.md, HdfsFile.md, LocalFile.md, ...
   │   │   ├── Iceberg.md, Hudi.md, Paimon.md, ...
   │   │   ├── Http.md, GraphQL.md, Github.md, ...
   │   │   └── ... (更多连接器)
   │   ├── 📂 sink/                        (78 个 Sink 连接器)
   │   │   ├── Mysql.md, PostgreSQL.md, Oracle.md, ...
   │   │   ├── Kafka.md, Pulsar.md, RocketMQ.md, ...
   │   │   ├── Elasticsearch.md, MongoDB.md, Redis.md, ...
   │   │   ├── S3File.md, HdfsFile.md, LocalFile.md, ...
   │   │   ├── Iceberg.md, Hudi.md, Paimon.md, ...
   │   │   ├── Console.md, Email.md, Slack.md, ...
   │   │   └── ... (更多连接器)
   │   ├── 📂 common-options/              (通用选项)
   │   │   ├── source-common-options.md    ✓ Source 通用选项
   │   │   └── sink-common-options.md      ✓ Sink 通用选项
   │   ├── 📂 formats/                     (数据格式)
   │   │   ├── avro.md                     ✓ Avro 格式
   │   │   ├── protobuf.md                 ✓ Protobuf 格式
   │   │   ├── canal-json.md               ✓ Canal JSON
   │   │   ├── debezium-json.md            ✓ Debezium JSON
   │   │   ├── maxwell-json.md             ✓ Maxwell JSON
   │   │   ├── ogg-json.md                 ✓ OGG JSON
   │   │   ├── cdc-compatible-debezium-json.md ✓ CDC 兼容 JSON
   │   │   └── kafka-compatible-kafkaconnect-json.md ✓ Kafka 兼容 JSON
   │   └── 📂 changelog/                   (变更日志 - 100+ 个)
   │       ├── connector-jdbc.md
   │       ├── connector-mysql.md
   │       ├── connector-cdc-base.md
   │       ├── connector-kafka.md
   │       └── ... (每个连接器的变更日志)
   │
   ├── 📂 transforms/                      (数据转换 - 21 个)
   │   ├── common-options.md               ✓ 转换通用选项
   │   ├── sql.md                          ✓ SQL 转换
   │   ├── filter.md                       ✓ 过滤转换
   │   ├── field-mapper.md                 ✓ 字段映射
   │   ├── field-rename.md                 ✓ 字段重命名
   │   ├── copy.md                         ✓ 复制转换
   │   ├── split.md                        ✓ 分割转换
   │   ├── replace.md                      ✓ 替换转换
   │   ├── jsonpath.md                     ✓ JSONPath 转换
   │   ├── regexextract.md                 ✓ 正则提取
   │   ├── metadata.md                     ✓ 元数据转换
   │   ├── data-validator.md               ✓ 数据验证
   │   ├── filter-rowkind.md               ✓ 行类型过滤
   │   ├── rowkind-extractor.md            ✓ 行类型提取
   │   ├── table-filter.md                 ✓ 表过滤
   │   ├── table-rename.md                 ✓ 表重命名
   │   ├── table-merge.md                  ✓ 表合并
   │   ├── transform-multi-table.md        ✓ 多表转换
   │   ├── sql-functions.md                ✓ SQL 函数
   │   ├── sql-udf.md                      ✓ SQL UDF
   │   ├── dynamic-compile.md              ✓ 动态编译
   │   ├── embedding.md                    ✓ 嵌入转换
   │   ├── llm.md                          ✓ LLM 转换
   │   └── define-sink-type.md             ✓ 定义 Sink 类型
   │
   ├── 📂 engines/                         (执行引擎)
   │   ├── flink.md                        ⚠️ Flink 引擎 (文档少)
   │   ├── spark.md                        ⚠️ Spark 引擎 (文档少)
   │   └── 📂 zeta/                        (SeaTunnel Engine - 19 个)
   │       ├── about.md                    ✓ Zeta 引擎介绍
   │       ├── download-seatunnel.md       ✓ 下载安装
   │       ├── 📂 部署相关
   │       │   ├── deployment.md           ✓ 部署指南
   │       │   ├── local-mode-deployment.md ✓ 本地模式
   │       │   ├── hybrid-cluster-deployment.md ✓ 混合集群
   │       │   └── separated-cluster-deployment.md ✓ 分离集群
   │       ├── 📂 配置相关
   │       │   ├── checkpoint-storage.md   ✓ 检查点存储
   │       │   ├── engine-jar-storage-mode.md ✓ JAR 存储模式
   │       │   ├── tcp.md                  ✓ TCP 配置
   │       │   ├── resource-isolation.md   ✓ 资源隔离
   │       │   └── slot-allocation-strategy.md ✓ 槽位分配
   │       ├── 📂 API 相关
   │       │   ├── rest-api-v1.md          ✓ REST API v1
   │       │   ├── rest-api-v2.md          ✓ REST API v2
   │       │   └── user-command.md         ✓ 用户命令
   │       ├── 📂 运维相关
   │       │   ├── logging.md              ✓ 日志配置
   │       │   ├── telemetry.md            ✓ 遥测
   │       │   ├── web-ui.md               ✓ Web UI
   │       │   ├── security.md             ✓ 安全配置
   │       │   └── tuning-guide.md         ✓ 调优指南
   │       └── savepoint.md                ✓ 保存点
   │
   ├── 📂 operations/                      (运维管理)
   │   ├── 📂 deployment-architecture/     (部署架构)
   │   │   ├── standalone.md               ✓ 单机部署
   │   │   ├── hybrid.md                   ✓ 混合部署
   │   │   └── cluster-ha.md               ✓ 集群 HA
   │   ├── 📂 management/                  (管理)
   │   │   ├── cli-tools.md                ✓ CLI 工具
   │   │   ├── job-lifecycle.md            ✓ 作业生命周期
   │   │   └── plugin-management.md        ✓ 插件管理
   │   ├── 📂 observability/               (可观测性)
   │   │   ├── logging.md                  ✓ 日志
   │   │   └── metrics.md                  ✓ 指标
   │   ├── 📂 performance-tuning/          (性能调优)
   │   │   ├── parallelism.md              ✓ 并行度
   │   │   ├── memory-and-backpressure.md  ✓ 内存和反压
   │   │   └── cdc-large-tables.md         ✓ CDC 大表
   │   ├── 📂 security/                    (安全)
   │   │   ├── authentication.md           ✓ 认证
   │   │   └── encryption.md               ✓ 加密
   │   └── 📂 troubleshooting/             (故障排查)
   │       ├── common-issues.md            ✓ 常见问题
   │       └── error-codes.md              ✓ 错误代码
   │
   ├── 📂 developer/                       (开发者指南)
   │   ├── contribution-guide.md           ⚠️ TODO - 贡献指南
   │   ├── e2e-testing.md                  ✓ E2E 测试
   │   ├── engine-development.md           ✓ 引擎开发
   │   ├── transform-development.md        ✓ 转换开发
   │   ├── 📂 architecture/                (架构)
   │   │   ├── module-design.md            ✓ 模块设计
   │   │   └── project-structure.md        ✓ 项目结构
   │   └── 📂 connector-development/       (连接器开发)
   │       ├── overview.md                 ⚠️ TODO - 概览
   │       ├── source-api.md               ✓ Source API
   │       ├── sink-api.md                 ✓ Sink API
   │       ├── catalog-api.md              ✓ Catalog API
   │       └── cdc-connector-guide.md      ✓ CDC 连接器指南
   │
   └── 📂 faq/                             (常见问题)
       ├── general.md                      ✓ 常见问题
       └── troubleshooting-shortcuts.md    ✓ 故障排查快捷方式
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org