close
Skip to content

[DOC]Optimize Seatunnel Document Structure#10262

Merged
davidzollo merged 31 commits into
apache:devfrom
misi1987107:feature-doc-structure-optimize
Jan 13, 2026
Merged

[DOC]Optimize Seatunnel Document Structure#10262
davidzollo merged 31 commits into
apache:devfrom
misi1987107:feature-doc-structure-optimize

Conversation

@misi1987107

Copy link
Copy Markdown
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
Copy Markdown
Contributor

Happy new year!

CI failed.
image

@zhangshenghang

Copy link
Copy Markdown
Member

please resolve conflicts

@misi1987107

misi1987107 commented Jan 8, 2026

Copy link
Copy Markdown
Contributor Author

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 个其他)

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

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

└── faq.md 常见问题解答

@davidzollo

Copy link
Copy Markdown
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.

@zhangshenghang

Copy link
Copy Markdown
Member

Is there a screenshot of the website running successfully?

@misi1987107

Copy link
Copy Markdown
Contributor Author

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.

ok,got it

@misi1987107

Copy link
Copy Markdown
Contributor Author

Is there a screenshot of the website running successfully?

image image image

misi added 2 commits January 12, 2026 09:39
# Conflicts:
#	docs/en/connectors/source/HdfsFile.md
#	docs/zh/connectors/source/HdfsFile.md
davidzollo
davidzollo previously approved these changes Jan 12, 2026

@davidzollo davidzollo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1
LGTM

# Conflicts:
#	docs/en/connectors/sink/GraphQL.md
#	docs/zh/connectors/sink/GraphQL.md
#	docs/zh/connectors/source/GraphQL.md
@zhangshenghang

Copy link
Copy Markdown
Member

LGTM

@davidzollo davidzollo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1
Good job!

@davidzollo davidzollo merged commit 81d8733 into apache:dev Jan 13, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants