misi1987107 commented on PR #10262:
URL: https://github.com/apache/seatunnel/pull/10262#issuecomment-3718179949
The Doc Structure Design
docs/
├── introduction/ # 产品定位 + 总览
│ ├── about.md # About SeaTunnel（复用/精简
../seatunnel/docs/en/about.md）
│ ├── architecture.md # 统一架构：Engine / Connector /
Transform / Job
│ └── concepts.md # 概念索引：Job / Pipeline / Config
/ Metalake / Schema / SpeedLimit
├── getting-started/ # 完整“上手路径”，串联 start-v2
│ ├── deployment.md # 部署总览：Locally / Docker /
Kubernetes
│ ├── quick-start-zeta.md # 对应 seatunnel-engine Quick
Start
│ ├── quick-start-flink.md # 对应
docs/en/other-engine/flink.md
│ └── quick-start-spark.md # 对应
docs/en/other-engine/spark.md
├── connectors/ # Connector 中心入口（保持与现有 docs
结构一致）
│ ├── overview.md # 支持矩阵 + 能力说明（引用
concept/connector-v2-features.md）
│ ├── source/ # 对应
../seatunnel/docs/en/connector-v2/source/*.md
│ │ ├── README.md # 说明用法 + 指南入口（A-Z 列表为主）
│ │ └── <ConnectorName>.md # 与当前官网一一对应，例如 Mysql.md /
Kafka.md / ...
│ ├── sink/ # 对应
../seatunnel/docs/en/connector-v2/sink/*.md
│ │ ├── README.md # 说明用法 + 指南入口（A-Z 列表为主）
│ │ └── <ConnectorName>.md # 与当前官网一一对应，例如 Clickhouse.md /
Doris.md / ...
│ ├── formats/ # 对齐
../seatunnel/docs/en/connector-v2/formats/*.md
│ │ ├── overview.md
│ │ └── <FormatName>.md # Avro / Protobuf /
Debezium-Json / Canal-Json / ...
│ ├── common-options/ # 将 common options 显式归档但不改现有文件名
│ │ ├── source-common-options.md # 直接引用
connector-v2/source-common-options.md
│ │ └── sink-common-options.md # 直接引用
connector-v2/sink-common-options.md
│ ├── changelog/ # 对应
../seatunnel/docs/en/connector-v2/changelog/*.md
│ │ └── <ConnectorName>.md
├── transforms/ # Transform 插件（保持与
transform-v2 结构一致）
│ ├── common-options.md # 对应
../seatunnel/docs/en/transform-v2/common-options.md
│ ├── define-sink-type.md # 对应 define-sink-type.md
│ └── <TransformName>.md # 对应 filter / split / jsonpath
/ replace / table-filter / table-merge / field-mapper / field-rename /
regexextract / sql / sql-udf / sql-functions / metadata / transform-multi-table
/ dynamic-compile / embedding / llm / rowkind-extractor / filter-rowkind 等
├── engines/ # 执行引擎
│ ├── zeta/ # SeaTunnel Engine（默认）
│ │ ├── about.md # 对应 seatunnel-engine/about.md
│ │ ├── download-seatunnel.md # 对应 download-seatunnel.md
│ │ ├── deployment.md # 对应 deployment.md
│ │ ├── local-mode-deployment.md # 对应 local-mode-deployment.md
│ │ ├── separated-cluster-deployment.md # 对应
separated-cluster-deployment.md
│ │ ├── hybrid-cluster-deployment.md # 对应
hybrid-cluster-deployment.md
│ │ ├── checkpoint-storage.md # 对应 checkpoint-storage.md
│ │ ├── engine-jar-storage-mode.md # 对应 engine-jar-storage-mode.md
│ │ ├── resource-isolation.md # 对应 resource-isolation.md
│ │ ├── slot-allocation-strategy.md # 对应
slot-allocation-strategy.md
│ │ ├── logging.md # 对应 logging.md
│ │ ├── telemetry.md # 对应 telemetry.md
│ │ ├── tuning-guide.md # 对应 tuning-guide.md
│ │ ├── security.md # 对应 security.md
│ │ ├── tcp.md # 对应 tcp.md
│ │ ├── rest-api-v1.md # 对应 rest-api-v1.md
│ │ ├── rest-api-v2.md # 对应 rest-api-v2.md
│ │ ├── user-command.md # 对应 user-command.md
│ │ └── web-ui.md # 对应 web-ui.md
│ ├── flink.md # Flink Engine 使用说明（基于
other-engine/flink.md）
│ └── spark.md # Spark Engine 使用说明（基于
other-engine/spark.md）
├── operations/ # 生产级运维 & 最佳实践
│ ├── deployment-architecture/ # 部署架构与模式（对 Zeta 视角抽象）
│ │ ├── standalone.md
│ │ ├── cluster-ha.md
│ │ └── hybrid.md
│ ├── management/ # 日常管理
│ │ ├── plugin-management.md # install-plugin.sh /
plugin-mapping.properties
│ │ ├── cli-tools.md # bin/seatunnel.sh /
bin/connector-check.sh / tools
│ │ └── job-lifecycle.md # Job 提交 / 调度 / 停止 / Savepoint
策略
│ ├── observability/ # 可观测性
│ │ ├── metrics.md # Prometheus / 日志字段说明
│ │ └── logging.md # Log4j2 / 日志滚动策略
│ ├── performance-tuning/ # 性能优化
│ │ ├── parallelism.md
│ │ ├── memory-and-backpressure.md
│ │ └── cdc-large-tables.md # CDC 多表/全库同步实践
│ ├── security/ # 安全
│ │ ├── authentication.md
│ │ └── encryption.md
│ └── troubleshooting/ # 故障排查
│ ├── error-codes.md # 整合
Error-Quick-Reference-Manual.md
│ └── common-issues.md # 常见问题 + FAQ 中运维类问题
├── developer/ # 开发者文档（与源码模块强关联）
│ ├── architecture/ # 源码架构
│ │ ├── project-structure.md # 讲清各 Maven 模块：api / engine /
core / connectors / formats / e2e ...
│ │ └── module-design.md # Connector / Transform /
Engine 内部设计模式
│ ├── connector-development/ # Connector 开发指南
│ │ ├── overview.md # 总览：Source / Sink / Config /
Split / Checkpoint
│ │ ├── source-api.md # 对齐 seatunnel-api &
SeaTunnelSource
│ │ ├── sink-api.md # 对齐 SeaTunnelSink
│ │ ├── catalog-api.md # Catalog 相关 API
│ │ └── cdc-connector-guide.md # 针对 CDC 类 Connector 的扩展指南
│ ├── transform-development.md # Transform API Guide（对齐
transform-v2）
│ ├── engine-development.md # seatunnel-engine
内部开发指引（client / server / storage / ui）
│ ├── e2e-testing.md # E2E 测试（基于 seatunnel-e2e 模块）
│ └── contribution-guide.md # 贡献指引（整合
docs/en/contribution/*）
└── faq/ # FAQ 归一出口
├── general.md # 对应 docs/en/faq.md
└── troubleshooting-shortcuts.md # 与 operations/troubleshooting
形成互链
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
