Skip to content

Conversation

@misi1987107
Copy link
Contributor

Purpose of this pull request

Optimize document structure

Does this PR introduce any user-facing change?

How was this patch tested?

Check list

@davidzollo
Copy link
Contributor

Happy new year!

CI failed.
image

@zhangshenghang
Copy link
Member

please resolve conflicts

@misi1987107
Copy link
Contributor Author

misi1987107 commented Jan 8, 2026

The Document Structure Design
docs/en/
├── introduction/ 核心概念 (13 个文件)
│ ├── about.md ✓ 项目介绍
│ ├── architecture.md ⚠️ TODO
│ └── concepts/ 11 个核心概念

├── getting-started/ 快速开始 (7 个文件)
│ ├── locally/ 本地部署 (4 个)
│ ├── docker/ Docker 部署 (1 个)
│ └── kubernetes/ K8s 部署 (2 个)

├── connectors/ 连接器 (157+ 个文件)
│ ├── overview.md ✓ 能力矩阵
│ ├── source/ 79 个 Source 连接器
│ ├── sink/ 78 个 Sink 连接器
│ ├── common-options/ 通用选项 (2 个)
│ ├── formats/ 数据格式 (8 个)
│ └── changelog/ 变更日志 (100+ 个)

├── transforms/ 数据转换 (21 个文件)
│ ├── common-options.md ✓ 通用选项
│ ├── sql.md ✓ SQL 转换
│ ├── filter.md ✓ 过滤
│ ├── field-mapper.md ✓ 字段映射
│ └── ... (17 个其他转换)

├── engines/ 执行引擎 (21 个文件)
│ ├── flink.md ⚠️ Flink (文档少)
│ ├── spark.md ⚠️ Spark (文档少)
│ └── zeta/ SeaTunnel Engine (19 个)
│ ├── about.md ✓ 介绍
│ ├── deployment.md ✓ 部署
│ ├── rest-api-v1.md ✓ API
│ └── ... (16 个其他)

├── operations/ 运维管理 (15 个文件)
│ ├── deployment-architecture/ 部署架构 (3 个)
│ ├── management/ 管理 (3 个)
│ ├── observability/ 可观测性 (2 个)
│ ├── performance-tuning/ 性能调优 (3 个)
│ ├── security/ 安全 (2 个)
│ └── troubleshooting/ 故障排查 (2 个)

├── developer/ 开发者指南 (12 个文件)
│ ├── contribution-guide.md ⚠️ TODO
│ ├── e2e-testing.md ✓ E2E 测试
│ ├── architecture/ 架构 (2 个)
│ └── connector-development/ 连接器开发 (5 个)

├── best-practies/
│ ├── cdc-sync.md CDC同步场景

└── faq/ 常见问题 (2 个文件)
├── general.md ✓ 常见问题
└── troubleshooting-shortcuts.md ✓ 快捷方式

@davidzollo
Copy link
Contributor

Here is my suggestions:

  1. Just keep one faq.md, and delete troubleshooting-shortcuts.md and general.md.
  2. The entire operations directory can be deleted, and we can add content to it later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants