zhangshenghang opened a new pull request, #13216:
URL: https://github.com/apache/seatunnel/pull/13216
Yes, I contribute to Apache SeaTunnel.
## What documentation issues were found
While auditing connector documentation against the Java `Option` definitions
(factory identifiers, `Options.key(...)` defaults), the EN/ZH table structure,
and the heading structure of every connector page, I found two classes of real
problems:
1. **Chinese connector docs that lag behind the English pages** — several ZH
pages were missing whole sections that exist in EN: per-option explanation
sections, file-format examples, task examples, an authentication section, and a
sink example section. Users reading the Chinese docs would not know these
options/examples exist.
2. **An inaccurate English architecture section** —
`docs/en/architecture/features/multi-table.md` section 3 presented
`MultiTableSource`, `MultiTableSourceSplitEnumerator` and
`MultiTableSourceReader` as concrete framework classes in code snippets, but no
such classes exist in the codebase (`grep -rn "class MultiTableSource"
seatunnel-api seatunnel-connectors-v2` finds nothing; connectors only have
local `createMultiTableSource` helper methods). The ZH page had already been
corrected (PR #13019); the EN page still described the non-existent classes.
## What was changed
- **docs/zh/connectors/source/ObsFile.md**: added the missing per-option
sections (`parse_partition_from_path`, `date_format`, `datetime_format`,
`time_format`, `skip_header_row_number`, `schema`, `read_columns`,
`common-options`), the JSON/text/CSV parsing examples in `file_format_type`,
the six task examples (text/parquet/orc/json/excel/csv), and fixed the
supported-format list to include `xml`, `binary` and `pdf` (all match EN and
the file-base connector code).
- **docs/zh/connectors/source/BosFile.md**: added the missing per-option
sections (`path`, `bucket`, `access_key`, `secret_key`, `endpoint`,
`file_format_type`, `common-options`), the missing "Filter File" example, and
synced the binary example with the EN version (`binary_chunk_size = 2048`).
- **docs/zh/connectors/sink/Http.md**: added the missing "Multiple table"
example section (two examples, same as EN).
- **docs/zh/connectors/source/Paimon.md**: added the missing `catalog_name`,
`user` and `password` option sections (verified against
`PaimonBaseOptions.java`: `catalog_name` default `paimon`, `user`/`password` no
default).
- **docs/zh/connectors/sink/Paimon.md**: added the missing "Truncate target
table on startup with Hive catalog" example section.
- **docs/zh/connectors/sink/AmazonSqs.md**: added the missing
"Authentication" section (credential resolution order and LocalStack/ElasticMQ
testing note).
- **docs/zh/connectors/source/WooCommerce.md**: added the missing "Key
Features" checklist section.
- **docs/zh/connectors/sink/GraphQL.md**: added the missing "Stream
Mutations to a GraphQL Service" example section (option keys verified against
`GraphQLSinkOptions` + `HttpParameter`/`HttpCommonOptions`, which consume
`url`, `headers`, `retry`, `retry_backoff_multiplier_ms`,
`retry_backoff_max_ms`).
- **docs/zh/connectors/sink/Easysearch.md**: restored the missing `### Save
Mode` example heading that had been merged into the previous section.
- **docs/zh/connectors/common-options/sink-common-options.md**: added the
missing important-note sentence ("a sink only consumes data sets, so it has no
`plugin_output`; `plugin_input` must match the upstream `plugin_output`").
- **docs/en/architecture/features/multi-table.md**: replaced the fabricated
section-3 code snippets (non-existent
`MultiTableSource`/`MultiTableSourceSplitEnumerator`/`MultiTableSourceReader`
classes) with an accurate description of the actual contract (each
`SeaTunnelRow` carries `tableId`/`rowKind`; the multi-table source structure is
connector-specific), aligning EN with the already-corrected ZH page; also
mirrored the missing "References" subsections into the ZH page.
- **docs/zh/architecture/features/multi-table.md**: added the "Key Source
Files" and "Example Implementations" subsections missing from section 14.
## Which areas/files were updated
12 files, +539/−101 lines: `docs/zh/connectors/{source,sink}` (ObsFile,
BosFile, Http, Paimon ×2, AmazonSqs, WooCommerce, GraphQL, Easysearch),
`docs/zh/connectors/common-options/sink-common-options.md`, and
`docs/{en,zh}/architecture/features/multi-table.md`.
## Were English and Chinese docs both checked?
Yes. I compared every EN/ZH connector page (option tables and heading
structure) with scripts. All content added to ZH pages was translated from the
EN pages after the EN content was verified against the connector source code.
The remaining EN/ZH gaps (FtpFile, SftpFile, OssJindoFile, SqlServer-CDC, Jdbc)
are intentionally untouched because open PRs #13149/#13193 already cover those
files; no file modified by this PR overlaps with those PRs.
## How duplicate PRs from the last 7 days were checked
I listed all PRs created in the last 7 days (`gh pr list --author
zhangshenghang --search "created:>=2026-11-03"` and docs-labeled PRs from all
authors) and reviewed the file list of every open docs PR:
- #13204 (architecture/api-design, SensorsData, GoogleBigtable, Phoenix,
Vertica, developer, getting-started) — no overlap.
- #13193 (connector-faq, Assert, DB2, DuckDB, Mysql, OceanBase, Oracle,
Pulsar, Firebase, Http source, IoTDB, MongoDB, PostgreSQL, Typesense,
schema-feature, docker) — no overlap with any file in this PR.
- #13149 (Jdbc, Kafka, Pulsar, CosFile, FtpFile, GcsFile, SftpFile,
OssJindoFile, sidebars.js, event-listener, rest-api docs) — no overlap; I
explicitly excluded all JDBC/Kafka/Pulsar and covered file-connector pages
(FtpFile/SftpFile/GcsFile/CosFile/OssJindoFile/SqlServer-CDC zh) from my fix
set for this reason.
Merged docs PRs from the same period (#13163, #13135, #13121) are already
part of upstream/dev, so this branch is based on the latest upstream/dev and
only adds new fixes.
## How the change was verified
- All new option names/defaults/examples were checked against the Java
source (`PaimonBaseOptions`, `MilvusSinkOptions`,
`LanceCommonOptions`/`LanceSinkOptions`, `RedisSourceOptions`,
`GraphQLSinkOptions`, `HttpCommonOptions`, `AmazonSqsBaseOptions`,
connector-file-base options, `CatalogOptions`).
- Scripted checks over the whole docs tree after the change: EN/ZH
option-table comparison (no remaining divergence outside the open PRs' files),
EN/ZH heading-structure comparison (all remaining gaps are inside the open PRs'
files), Markdown fence-balance check on all 12 changed files, and relative-link
existence check on all changed files — all pass.
- The SeaTunnel website build lives in the separate seatunnel-website
repository and this repository has no docs CI workflow, so no site build was
run here; the checks above are the validation actually executed.
--
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]