zhangshenghang opened a new pull request, #13258:
URL: https://github.com/apache/seatunnel/pull/13258
Yes, I am contributing to Apache SeaTunnel.
## What documentation issues were found
While auditing connector docs against the current source code on `dev`, the
following verified inaccuracies were found (every item was confirmed by reading
the corresponding `*Factory.java` / `*Options.java` and runtime classes before
editing):
1. **RocketMQ sink falsely claimed checkpoint-based exactly-once**
(`docs/{en,zh}/connectors/sink/RocketMQ.md`): docs said half-messages are
prepared during checkpoint and committed when the checkpoint completes, and
listed `exactly-once` as a supported feature. In the code,
`RocketMqTransactionSender.executeLocalTransaction()` returns `COMMIT_MESSAGE`
immediately, `checkLocalTransaction()` also returns `COMMIT_MESSAGE`, and
`RocketMqSink` extends `AbstractSimpleSink` (no committer / checkpoint
coordination). The docs now state that `exactly.once = true` only enables
transactional sending (messages are committed immediately), and the
`exactly-once` key-feature checkbox is unchecked.
2. **RabbitMQ source `delivery_timeout` presented as functional but never
used** (`docs/{en,zh}/connectors/source/Rabbitmq.md`): the option is parsed
into `RabbitmqConfig.deliveryTimeout` but is not read anywhere in the module.
Both docs now carry an explicit "parsed but not applied" note and drop the
invented "in milliseconds" unit.
3. **Paimon source FAQ described a projection mechanism that does not
exist** (`docs/{en,zh}/connectors/source/Paimon.md`): the FAQ claimed
projection fields come from the job `schema` block. Projection is derived only
from the `query` option's SELECT clause (`PaimonSource` computes
`convertSqlSelectToPaimonProjectionIndex` from the query; the job schema is
never used). FAQ rewritten in both languages.
4. **Redis source main Options table missing 7 real top-level options**
(`docs/{en,zh}/connectors/source/Redis.md`): `hash_key_parse_mode` (default
`all`), `read_key_enabled` (default `false`), `key_field_name`,
`single_field_name` (required when `read_key_enabled=true`), `batch_size`
(default `10`), `format` (default `json`), `field_delimiter` (default `,`) all
exist in `RedisSourceFactory.optionRule()` and are consumed at runtime, but
were absent from the main table. Added with names/types/defaults taken from
`RedisSourceOptions` / `RedisBaseOptions`.
5. **Elasticsearch sink `auth_type` documented as `string` but is an enum**
(`docs/en/connectors/sink/Elasticsearch.md`): code defines
`enumType(AuthTypeEnum.class)` with values `basic`, `api_key`,
`api_key_encoded`; the table also omitted `api_key_encoded` although the page's
own examples use it. Fixed.
6. **zh Elasticsearch sink options table missing the entire description
column** (`docs/zh/connectors/sink/Elasticsearch.md`): the EN table has full
per-option descriptions; the zh table had only 4 columns (no descriptions at
all). Synced: zh now mirrors EN with translated descriptions (27 options),
including the `auth_type` enum fix.
7. **zh Elasticsearch source examples/text diverged from EN**
(`docs/zh/connectors/source/Elasticsearch.md`): the multi-table example wrote
both source tables into a fixed index (`multi_source_write_test_index`) while
the corrected EN example uses `${table_name}_copy`; and a case description said
"三个字段" (three fields) while listing five. Fixed both.
8. **zh Redis sink contained a duplicated custom-key example section**
(`docs/zh/connectors/sink/Redis.md`): "按上游字段动态生成键" repeated the existing "使用自定义
Key 模板" content with no EN counterpart. Removed to restore en/zh parity.
9. **Couchbase sink `upsert-enable` undocumented runtime requirement**
(`docs/{en,zh}/connectors/sink/Couchbase.md`):
`CouchbaseSinkFactory.createSink` throws at startup when `upsert-enable = true`
without `primary-key`. The option row now states this requirement in both
languages.
## What was changed
Documentation-only changes: corrected feature claims, fixed option tables
(missing options, wrong types, missing descriptions), synced zh docs with EN,
removed a duplicated zh section, and documented one runtime validation
requirement. No code changes.
## Areas / files updated (14 files)
- `docs/en/connectors/{sink/RocketMQ.md, sink/Elasticsearch.md,
sink/Couchbase.md, source/Paimon.md, source/Rabbitmq.md, source/Redis.md}`
- `docs/zh/connectors/{sink/RocketMQ.md, sink/Elasticsearch.md,
sink/Redis.md, sink/Couchbase.md, source/Elasticsearch.md, source/Paimon.md,
source/Rabbitmq.md, source/Redis.md}`
## Were both English and Chinese docs checked?
Yes. Every fix was applied to the EN and ZH versions together where both
existed. Additionally, two zh-only divergences (missing description column in
the zh ES sink table, duplicated zh Redis sink section, wrong zh example
index/field count) were repaired to restore en/zh parity.
## How duplicate PRs from the last 7 days were checked
Searched open and recently merged/closed PRs in `apache/seatunnel` (last 7
days, before opening this PR):
- My own recent docs PRs (#13234, #13204, #13193, #13149 open; #13216,
#13163 merged) cover different areas (JDBC, Kafka, file connectors, CDC,
Clickhouse, InfluxDB, Snowflake, Zeta/architecture/deployment) — none of the
issues fixed here are covered by them.
- File-based search for open PRs touching the exact files in this PR found
only two feature PRs (#13243 multi-table replica modes, #13141 Paimon REST
catalog) whose doc edits serve their own features — no overlap with these doc
fixes.
- No open/merged PR from the last 7 days fixes any of the nine issues listed
above.
## How the change was verified
- Every claim was checked against the Java sources before editing (RocketMQ
`RocketMqTransactionSender`/`RocketMqSink`, RabbitMQ
`RabbitmqConfig`/`RabbitmqClient` grep for `deliveryTimeout`, Paimon
`PaimonSource` projection path, Redis `RedisSourceFactory.optionRule()` +
runtime readers, ES `ElasticsearchBaseOptions`/`AuthTypeEnum`, Couchbase
`CouchbaseSinkFactory`).
- Markdown structure checks on all 14 edited files: table column counts
consistent per table, code fences balanced (even count), and all added/edited
relative link targets exist under `docs/{en,zh}/connectors/common-options/`.
- No full site build was run: the Docusaurus website build lives in the
separate seatunnel-website repository and is not runnable from this repo;
content-level checks above were run instead. No Java build is needed as this PR
contains no code changes.
--
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]