DanielCarter-stack opened a new pull request, #11709:
URL: https://github.com/apache/seatunnel/pull/11709

   ### Purpose
   
   This PR improves the documentation of five connector-V2 docs in `docs/en` 
and `docs/zh`:
   
   - TDengine (`source/TDengine.md`, `sink/TDengine.md`)
   - Hive (`source/Hive.md`, `sink/Hive.md`)
   - Elasticsearch (`source/Elasticsearch.md`, `sink/Elasticsearch.md`)
   - Pulsar (`source/Pulsar.md`, `sink/Pulsar.md`)
   - OceanBase (`source/OceanBase.md`, `sink/OceanBase.md`)
   
   The goal is to align the docs with the current connector code, make option 
tables easier to read, and ensure both languages stay in sync. No source code, 
no source-version metadata, and no recent PR (within the last 7 days) was 
touched.
   
   ### Changes
   
   - **TDengine (source & sink)**: Add `Support Those Engines`, a REST-endpoint 
tip, and an explicit description column for every option. Sink doc clarifies 
the `timezone` semantics and the 2PC exactly-once behavior. Task examples are 
refreshed with explicit `env` blocks.
   - **Hive (source & sink)**: Replace the option tables with a typed `Name / 
Type / Required / Default / Description` form for both languages and expand 
each option's explanation. Sink doc fixes the FAQ that previously referenced 
undocumented `file_format_type` and `partition_by` options and now documents 
the actual `overwrite` / `data_save_mode` interaction.
   - **Elasticsearch (source & sink)**: Rewrite the option tables so every 
entry has its own description column (the previous tables mixed default values 
and descriptions). Source doc refreshes the `runtime_fields`, PIT-with-slicing, 
and SSL examples; sink doc harmonises the feature list and clarifies the 
CDC/auth/timer-flush options.
   - **Pulsar (source & sink)**: Complete the option table descriptions and 
refresh the multi-table examples. Sink doc now starts with `Support Those 
Engines` and `Description` before the feature list.
   - **OceanBase (source & sink)**: Replace the option tables with the typed 
description form and restore a clean `Description` section. Sink doc clarifies 
the XA-based exactly-once semantics and the relationship between 
`generate_sink_sql`, `database`, `table`, and `primary_keys`.
   
   ### Validation
   
   - Spot-checked option names and defaults against the connector source code 
(`connector-tdengine`, `connector-hive`, `connector-elasticsearch`, 
`connector-pulsar`, and the JDBC-backed OceanBase connector).
   - Bilingual parity: every English doc change is mirrored in the 
corresponding Chinese doc; the existing Chinese descriptions that were already 
correct were kept and only the tables and headings were normalized.
   - No version metadata in the changelog files is modified.
   - Markdown structure follows the same shape used by the recently merged 
connector doc PRs.
   
   ### Notes
   
   - This PR is opened as a draft per the contributor workflow; it will be 
marked ready for review after CI passes.
   - Five connectors were touched per batch, matching the contributor guidance.
   - Old PRs from `DanielCarter-stack` have all CI green and no outstanding 
review comments; they were checked before opening this new PR.


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