DanielCarter-stack opened a new pull request, #11788:
URL: https://github.com/apache/seatunnel/pull/11788
## Summary
This PR is part of the ongoing connector docs improvement series for Apache
SeaTunnel. It enriches the documentation of five connector-v2 modules — DataHub
(sink), Socket (source + sink), Web3j (source), and ActiveMQ (sink) — with a
FAQ section answering the recurring operational questions that came up while
reviewing existing connector documentation.
## What This PR Does
For each of the five touched connectors (10 files: EN + ZH for each), this
PR:
- Adds a connector-specific `## FAQ` / `## 常见问题` section placed **before**
the `## Changelog` / `## 变更日志` block, matching the same ordering already used
in recent connector docs (Druid, Doris, Iceberg, Elasticsearch, ClickHouse, …).
- Adds the missing `## Support Those Engines` / `## 引擎支持` header block to
`docs/en/connectors/sink/Activemq.md` so the EN documentation matches its ZH
sibling.
- Keeps every change docs-only and adds no new `Option` keys, default
values, or behavioral claims — all FAQ answers are cross-checked against the
actual `*Options.java` / `*SinkFactory` / `*SourceFactory` source.
- Adds Chinese parity for every English addition — ZH docs use Chinese for
feature names like `精确一次` / `定时刷新` / `并行度` and for the FAQ items.
## Connectors Touched
| Connector | Doc files | Source / Sink | Notable FAQ additions |
|-----------|-----------|---------------|----------------------|
| DataHub | `sink/Datahub.md` | sink only | exactly-once
behavior; `${table}` multi-table routing; why `topic` is always required |
| Socket | `source/Socket.md`, `sink/Socket.md` | source + sink |
offset/checkpoint behavior for source; why no delimiter after each record in
sink; how parallelism interacts with the single client connection |
| Web3j | `source/Web3j.md` | source only | how the
polling rate is shaped by provider latency; exact JSON shape of the emitted
`value` field; authentication limitations |
| ActiveMQ | `sink/Activemq.md` | sink only | topic vs
queue destination; `username`/`password` validation; fixed JSON message format;
exactly-once delivery |
## What This PR Does NOT Change
- No new connector options, defaults, or behavior. No renames. No version
bumps.
- Does not modify any `seatunnel-connectors-v2/**` source files,
`seatunnel-e2e/**` test files, or shared docs in `docs/{en,zh}/introduction/`.
- Does not edit the support version (`## Support X Version` / `## X 版本支持`)
header on any of the touched files.
## Verification
- File ordering verified: each touched file ends with `<ChangeLog />` after
`trim()`, matching the `MarkdownTest.testConnectorDocWithChangeLogFlagAndFile`
assertion in `seatunnel-ci-tools`.
- EN/ZH parity verified: every prose addition in English has a matching
Chinese entry, and every Chinese addition has a matching English entry.
- Spot-checked against the actual connector source:
- Datahub: `DataHubSinkOptions` for all option keys and defaults;
multi-table routing uses `${table}` / `${table_name}` per the factory code.
- Socket source: `StreamSocketSource` / `SocketSource` shows the
single-split, no-checkpoint behavior.
- Socket sink: `SinkStreamSocket` / `SocketSink` shows
`JsonSerializationSchema` and the no-delimiter TCP writer.
- Web3j: `Web3jSourceFactory` / `Web3jSource` shows the single-option
`url` and the JSON `value` payload shape.
- ActiveMQ: `ActiveMQSinkFactory` shows queue-only destinations;
`username`/`password` are validated together.
Please let me know if you want the FAQ wording adjusted or want me to
back-port any of these patterns into more recently touched connectors.
--
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]
