zhangshenghang opened a new pull request, #13284:
URL: https://github.com/apache/seatunnel/pull/13284

   I acknowledge that I am contributing to Apache SeaTunnel.
   
   ## What documentation issues were found
   
   While auditing the connector docs on `dev` against the source code and 
across the English/Chinese versions, I found two classes of real, verifiable 
issues:
   
   ### 1. Broken HOCON examples (copy-paste produces a parse error)
   
   - `docs/en/connectors/source/FtpFile.md`, 
`docs/zh/connectors/source/FtpFile.md`, 
`docs/zh/connectors/source/LocalFile.md`: the "Read multiple tables" example 
declares `tables_configs = [ ...` but the array is never closed with `]` — the 
block ends with a stray `}`. The example is invalid HOCON and fails to parse 
when users copy it. The same example in 
`docs/en/connectors/source/LocalFile.md` was already correct; the three broken 
files are fixed to match it. (The same broken pattern in 
`docs/en/transforms/embedding.md` / `docs/zh/transforms/embedding.md` is 
intentionally not touched here because an open PR already modifies those files.)
   
   ### 2. Option-table Type cells inconsistent with the counterpart language 
and the repo-wide convention
   
   - `docs/zh/connectors/source/Opengauss-CDC.md`: ~25 Type cells used 
translated Chinese words (字符串/列表/枚举/整型/布尔/双浮点型/配置) while the English version of 
the same page and all other docs use SeaTunnel type identifiers 
(`String`/`List`/`Enum`/`Integer`/`Boolean`/`Double`/`Config`). The 
conditional-required cells for `table-names` / `table-pattern` were the vague 
`二选一` ("choose one of the two"); they now state the exact condition (`未设置 
table-pattern 时必填`), matching the English text.
   - `docs/zh/connectors/sink/Paimon.md`: 16 Type cells translated to Chinese 
words; normalized to match the English page.
   - `docs/en/connectors/sink/Paimon.md` + `docs/zh/connectors/sink/Paimon.md`: 
`multi_table_sink_replica` Type casing (`int` → `Int`) aligned with the rest of 
the column and between the two languages.
   - `docs/zh/connectors/sink/Hudi.md`: 8 cells (`array`/`int`) differed from 
the English page (`Array`/`Int`).
   - `docs/zh/connectors/source/Notion.md` (14 cells) and 
`docs/zh/connectors/source/OneSignal.md` (6 cells): lowercase 
`int`/`boolean`/`long` differed from the English pages (`Int`/`Boolean`/`Long`).
   - `docs/en/connectors/source/Mqtt.md`: 14 Type cells used lowercase 
`string`/`int`/`boolean`/`config`, unlike both the zh counterpart and the 
repo-wide convention (`String`/`Int`/`Boolean`/`Config`).
   - `docs/en/connectors/sink/HugeGraph.md`: `List<string>` typo — Java 
generics are case-sensitive, and the zh page already correctly shows 
`List<String>`.
   - `docs/en/connectors/sink/Socket.md`: `host` / `port` rows had an empty 
Default cell; filled with `-` as done for every other option without a default 
(and as the zh page already shows).
   
   No option names, default values or semantics were changed — only 
documentation content.
   
   ## What was changed
   
   - Fixed 3 broken `tables_configs` HOCON examples (missing array-closing 
bracket).
   - Normalized Type/Required cells in 9 more docs so each page matches its 
counterpart language and the repo-wide type naming convention.
   
   ## Which areas/files were updated (12)
   
   - en `connectors/sink`: `HugeGraph.md`, `Paimon.md`, `Socket.md`; en 
`connectors/source`: `FtpFile.md`, `Mqtt.md`
   - zh `connectors/sink`: `Hudi.md`, `Paimon.md`; zh `connectors/source`: 
`FtpFile.md`, `LocalFile.md`, `Notion.md`, `OneSignal.md`, `Opengauss-CDC.md`
   
   ## Were both English and Chinese docs checked?
   
   Yes. All 251 EN↔ZH option-table pairs (source/sink/transforms) were compared 
programmatically (option name, type, required, default). Every fix above was 
applied to exactly the language(s) where the issue exists, so no new EN/ZH 
divergence is introduced.
   
   ## How duplicate PRs from the last 7 days were checked
   
   I listed all PRs authored by zhangshenghang created between 2026-11-08 and 
2026-11-15 (#13193, #13204, #13216, #13234, #13258, #13274, #13282) and fetched 
the changed-file list of every still-open one. None of the 12 files in this PR 
appears in any open PR's file list. Topics already covered by those PRs 
(Doris/StarRocks/TDengine/Milvus, 
Elasticsearch/Redis/RocketMQ/Paimon-source/Couchbase, 
Clickhouse-file/InfluxDB/Snowflake and the CDC sources, 
IoTDB/Http/PostgreSQL/DB2/DuckDB/…, Zeta engine pages, and the 
embedding/llm/calcite transforms) were explicitly excluded from my fix scope. 
The two remaining unbalanced examples in `transforms/embedding.md` belong to 
#13274's files and were left untouched for that PR.
   
   ## How the change was verified
   
   - A brace/bracket balance check over all fenced ```hocon example blocks in 
the repo: the 3 fixed files now report 0 unbalanced blocks; the only remaining 
ones are the two `embedding.md` files excluded above.
   - An EN↔ZH option-table parity re-run after the fix: all touched pages now 
agree on Type/Required/Default cells; the only remaining flags are natural 
translations of the Required text.
   - A markdown-table column-count check on the 12 changed files: tables remain 
well-formed.
   - No website build was run locally: the SeaTunnel docs site is built in the 
separate `apache/seatunnel-website` repository and this repo has no local docs 
lint/build target; the checks above cover the changed content. No code was 
touched, so no Maven build is needed.
   


-- 
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]

Reply via email to