close
Skip to content

[Doc] Seatunnel Doc Structure Adjustment#10351

Merged
davidzollo merged 4 commits into
apache:devfrom
misi1987107:feature-doc-structure-adjustment
Jan 21, 2026
Merged

[Doc] Seatunnel Doc Structure Adjustment#10351
davidzollo merged 4 commits into
apache:devfrom
misi1987107:feature-doc-structure-adjustment

Conversation

@misi1987107

Copy link
Copy Markdown
Contributor

Purpose of this pull request

related (#10262)
document structure adjustment

Does this PR introduce any user-facing change?

How was this patch tested?

Check list

@davidzollo

Copy link
Copy Markdown
Contributor

Great job.
I suggest deleting docs/en/connectors/overview.md and the Chinese document. Maintaining this doc will be difficult.

@misi1987107

Copy link
Copy Markdown
Contributor Author

Great job. I suggest deleting docs/en/connectors/overview.md and the Chinese document. Maintaining this doc will be difficult.

ok,got it

@DanielCarter-stack

Copy link
Copy Markdown
Contributor
  • docs/ (directory structure): Breaking URL change from connector-v2 to connectors will break all existing external links (blogs, tutorials, Stack Overflow answers) without a migration plan. Consider adding 301 redirects or a migration guide to preserve SEO and user bookmarks.

  • docs/en/connectors/overview.md (deleted file): The entire 433-line overview file was removed without indicating where the content migrated. If the connector capability matrix was deleted without replacement, users will lose important context about SeaTunnel's connector ecosystem.

  • docs/sidebars.js: Navigation config changed from autogenerated to explicit paths (135 lines changed). Without a before/after comparison, some documentation pages may become orphaned and inaccessible via the sidebar.

  • docs/zh/: Large-scale updates to both English and Chinese docs lack verification that Chinese content accurately reflects English changes. Inconsistent translations could mislead Chinese-speaking users.

  • docs/ (internal links): After restructuring directories (connector-v2connectors, moving common-options), internal relative links may be broken. Running a link checker before merge would prevent 404 errors within the documentation.

@zhangshenghang zhangshenghang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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 e93bbb9 into apache:dev Jan 21, 2026
4 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.

4 participants