zhangshenghang opened a new pull request, #12378:
URL: https://github.com/apache/seatunnel/pull/12378
## What documentation issues were found
1. **Four newly added connector docs were unreachable from the docs
navigation.** `FacebookAds`, `GoogleAds`, `Salesforce` (and `Http-Linear`) were
placed under `docs/{en,zh}/connector-v2/source/`, a directory that is not
referenced by `docs/sidebars.js` (the sidebar autogenerates only from
`connectors/source` and `connectors/sink`). The live docs site confirms those
pages render only when the URL is typed directly: no sidebar entry, no
previous/next pagination, and no index table points to them, so users browsing
the connector list cannot discover these connectors at all.
2. **English and Chinese "Key features" checklists had drifted apart in 11
sink connector docs**, so the two languages advertised different capabilities
for the same connector:
- STIP-23 Phase 3 (#10802) added the `timer flush` flag only to the
**Chinese** docs of `Rabbitmq`, `Socket`, `S3-Redshift`, `ClickhouseFile`,
`FtpFile` sinks; the English docs never got the row.
- `zh sink CosFile` was missing the `cdc`, `support multiple table
write`, and `timer flush` rows present in English.
- `zh sink DuckDB` and `zh sink Redshift` were missing the `timer flush`
row.
- `zh sink Jdbc` was missing the `support multiple table write` row (the
JDBC sink implements multi-table write via `JdbcSink`/`AbstractJdbcSinkWriter`).
- `zh sink StarRocks` had `timer flush` unchecked while English marks it
checked (feature added by #11518 "Add StarRocks timer flush").
- `en sink Greenplum` omitted `support multiple table write` although the
Chinese doc and the JDBC implementation support it (Greenplum writes through
the JDBC connector).
## What was changed
- Moved the three orphaned doc pairs into the canonical,
sidebar-autogenerated directory so they become navigable like every other
connector:
- `docs/{en,zh}/connector-v2/source/FacebookAds.md` →
`docs/{en,zh}/connectors/source/FacebookAds.md`
- `docs/{en,zh}/connector-v2/source/GoogleAds.md` →
`docs/{en,zh}/connectors/source/GoogleAds.md`
- `docs/{en,zh}/connector-v2/source/Salesforce.md` →
`docs/{en,zh}/connectors/source/Salesforce.md`
(`Http-Linear` was intentionally left in place because PR #12276 is
actively modifying it.)
The files are two directory levels deep both before and after the move, so
all relative links (`../../introduction/concepts/connector-v2-features.md`)
keep resolving; no other document referenced the old paths (verified by
repo-wide grep).
- Added the missing feature-checklist rows / fixed check states in the 11
sink docs listed above, making each English file and its Chinese counterpart
list identical features with identical states.
## Which areas/files were updated
17 files total (≥ 10 files, satisfying the scope requirement):
- 6 moved files:
`docs/{en,zh}/connectors/source/{FacebookAds,GoogleAds,Salesforce}.md` (100%
renames)
- 11 edited files:
`docs/en/connectors/sink/{Rabbitmq,Socket,S3-Redshift,ClickhouseFile,FtpFile,Greenplum}.md`,
`docs/zh/connectors/sink/{CosFile,DuckDB,Jdbc,Redshift,StarRocks}.md` (13
content lines: 12 insertions, 1 check-state flip)
## Were English and Chinese docs both checked?
Yes. Both languages were scanned for every connector under
`docs/{en,zh}/connectors/{source,sink}`: option tables were compared against
the `Options.key(...)` definitions in the connector modules, and the feature
checklists were compared language-pair-wise. All fixes above were applied to
both languages where applicable.
## How duplicate PRs from the last 7 days were checked
Ran `gh pr list --repo apache/seatunnel --state all --search
"created:>=2026-09-10"` and inspected every PR touching `docs/`. Open
doc-related PRs: #12347 (my previous docs PR — option defaults/tables/links/zh
Splunk; disjoint files from this PR), #12328 (Zeta MapStore persistence
examples), plus feature PRs (#12275/#12230/#10938/#12270 created the orphan
docs themselves; #12276 owns `Http-Linear`, which is why it was excluded here).
No open PR covers the navigation problem or the feature-checklist drift fixed
here.
## How the change was verified
- Automated scans run locally: (a) doc option tables vs `Options.key`
name/default extraction across all connector modules; (b) en↔zh
feature-checklist comparison (label-normalized and positional) — after the fix,
remaining diffs are only translation wording variants, not missing rows or
state mismatches; (c) relative-link + anchor checker over `docs/{en,zh}` — no
broken links introduced (the only reported items are pre-existing Scala
code-block false positives in `transforms/dynamic-compile.md` and
directory-style links that resolve via the landing pages' `slug` front matter).
- Verified against code: JDBC multi-table write implementation
(`JdbcSink`/`AbstractJdbcSinkWriter`), StarRocks timer flush feature (#11518),
STIP-23 #10802 history (added zh-only timer flush rows).
- The Docusaurus site build was not run locally because the website
toolchain lives in the separate `apache/seatunnel-website` repository (the docs
are synced there at build time); the structural checks above are the applicable
local verification.
--
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]
