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

   ## What Problem Does This PR Solve?
   
   This PR is a documentation cleanup for five V2 connector docs (Pulsar 
source/sink, TDengine source/sink, HugeGraph source/sink, AmazonSqs 
source/sink, BigQuery sink — 17 files in total).
   
   **Pain points.** Across these docs:
   
   - Several pages were missing the **Support Those Engines** header (TDengine 
source/sink, HugeGraph source/sink, BigQuery sink already had it, but the new 
sections were missing in places).
   - The TDengine source/sink option tables used bare keys (`name`, `type`, 
`required`, `default value`) without descriptions, and the source key-features 
list was split across two bullet groups.
   - The HugeGraph source page had a base vertex-read example but no edge-read 
or filter example.
   - The HugeGraph sink page covered vertices/edges well but lacked DELETE-row 
and clone-from-HugeGraph examples.
   - The Pulsar source/sink pages were already strong on the JSON path but did 
not show Avro, streaming, topic-discovery, text or Pulsar-producer-config 
examples.
   - The AmazonSqs source/sink pages covered JSON/text but did not show 
Debezium JSON (source) or Canal JSON (sink), and the auth resolution order was 
not documented.
   - The BigQuery sink page had the streaming CDC example but did not show the 
`sequence_number_column` wiring or the inline `service_account_key_json` 
alternative.
   
   ## What This PR Changes
   
   - Adds **Support Those Engines** sections to TDengine (source + sink) and 
HugeGraph (source + sink) English and Chinese docs.
   - Restructures the TDengine source/sink option tables to include a 
description column, unifies field naming, and consolidates the key-features 
list into one block.
   - Adds an **Output Schema** section to TDengine source explaining the 
reserved `subtable_name` column and the TAGS-trailing convention.
   - Adds an **Input Row Shape** section to TDengine sink explaining the 
`sub-table-name + normal columns + TAGS values` write contract.
   - Adds explicit examples to the HugeGraph source for **edge labels** and 
**server-side `filter`**, plus a multi-table / clone-from-HugeGraph example on 
the HugeGraph sink.
   - Adds explicit DELETE-row and clone-from-HugeGraph examples to the 
HugeGraph sink (en + zh).
   - Adds **Read Avro Messages**, **Streaming Read**, and **topic-pattern + 
discovery** examples to the Pulsar source (en + zh).
   - Adds **Text Delimiter**, **Avro**, and **Pulsar Producer Config** examples 
to the Pulsar sink (en + zh).
   - Adds an **Authentication** section to the AmazonSqs source and sink that 
documents the credential resolution order and local-emulator tip.
   - Adds **Read Debezium JSON Messages** to the AmazonSqs source and **Write 
Canal JSON Messages** to the AmazonSqs sink (en + zh).
   - Adds a **`sequence_number_column` CDC example** and an **inline service 
account key** example to the BigQuery sink (en + zh).
   - Keeps all existing information intact; only adds clarifications, examples, 
and structural headers.
   
   ## Compatibility
   
   - No config-option renames, no default-value changes, no removals.
   - All examples use the same option names and value semantics as the current 
implementation.
   
   ## Checklist
   
   - [x] Documentation only — no source/test changes.
   - [x] Touches docs that have not been modified by other recent PRs.
   - [x] English and Chinese docs are kept in sync.
   


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