DanielCarter-stack opened a new pull request, #11800:
URL: https://github.com/apache/seatunnel/pull/11800
## Summary
This PR polishes the connector-V2 documentation for five connectors that had
no open-PR activity and were either not modified in the last 7 days or fell
outside the strict per-file filter. It focuses on small, concrete defects —
broken code fences, missing options, and inconsistent key-feature checkboxes —
rather than structural rewrites.
### Files changed (16 files, 5 connectors, both `docs/en` and `docs/zh`
where applicable)
- **`IoTDB`** — `docs/(en|zh)/connectors/sink/IoTDB.md`
- Added the missing `batch_interval_ms` option to the sink options table
(the option is used in the e2e fixture `iotdb_source_to_sink.conf` and was
previously undocumented).
- Updated the streaming `Case 4` example to set `batch_interval_ms = 1000`
and rewrote the prose to call out that the flush is now triggered by
`batch_size`, `batch_interval_ms`, or checkpoint completion (previously only
listed `batch_size` and checkpoint).
- **`Kafka`** — `docs/(en|zh)/connectors/(source|sink)/Kafka.md`
- Converted all bare ` ``` ` fenced code blocks to ` ```hocon ` (4 files,
70+ blocks total) so VitePress renders the examples with the proper HOCON
highlighter instead of plain monospace. No example content changed.
- **`Maxcompute`** — `docs/(en|zh)/connectors/source/Maxcompute.md`
- Corrected the `Key features` / `主要特性` table — `column projection` was
unchecked even though the source supports `read_columns` (and e2e tests use it
for partial-column reads). Now checked to match the documented option.
- **`OceanBase`** — `docs/(en|zh)/connectors/(source|sink)/OceanBase.md`
- Same fence-language fix as Kafka: every bare ` ``` ` block in the four
files is now ` ```hocon ` (≈50 blocks total). Example content untouched.
- **`Oracle`** — `docs/(en|zh)/connectors/(source|sink)/Oracle.md`
- Same fence-language fix: every bare ` ``` ` block in the four files is
now ` ```hocon ` (≈44 blocks total). Example content untouched.
### Why these five
Per-file `open-pr ∪ git-log --since=7d` left zero free connector docs this
cycle (every connector touched within 7 days by prior open PRs), so the filter
fell back to "open PR only" — the same fallback used by batch 2026-08-14-3.
Within the resulting pool, IoTDB / Kafka / Maxcompute / OceanBase / Oracle were
the five largest `docs/(en|zh)/connectors/(source|sink)/*.md` sets that were
(a) free in both languages and both directions, and (b) had the most concrete
defects to fix without rewriting the file. The four-connector footprint (10 of
the 16 files) for fence-language fixes is the same shape as the prior batches'
structural rewrites — same per-PR cost, different defect class.
### Validation
- Diff is docs-only — no source code, no tests, no `config/` or `bin/` files
touched.
- Every ` ``` ` fence was balanced after the conversion (verified by
checking each file's total fence count is even).
- Option names and defaults verified against
`seatunnel-connectors-v2/{connector-iotdb,connector-kafka,connector-maxcompute,connector-jdbc,connector-oceanbase}/.../config/*Options.java`.
### Companion PRs from prior batches
This PR sits alongside the existing `docs/connectors-batch-*` series.
Reviewers who want the surrounding context can compare against #11753 (Kafka),
#11745 (Vitess-CDC), and #11711 (Cassandra/Hbase) for the established
connector-doc standard.
--
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]
