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

   ## Purpose
   Improve the documentation for five Connector-V2 connectors that have not 
been touched by recent PRs: DingTalk (sink), Slack (sink), Sentry (sink), 
GoogleSheets (source) and OpenMldb (source). Both English and Chinese docs are 
updated in lockstep.
   
   ## What changed
   
   For each of the five connectors, the documentation is brought up to the 
standard format used by other recently improved connectors:
   
   - Add a clear description explaining what the connector does and how it is 
identified in job configuration.
   - Add the standard "Support Those Engines" / "Key features" section so users 
can see at a glance which engines and capabilities are supported (e.g. batch, 
stream, multiple table write).
   - Add a "Data Type Mapping" section that explains how SeaTunnel types are 
mapped to the underlying system for both the source (Google Sheets, OpenMLDB) 
and sink (DingTalk, Slack, Sentry) sides.
   - Expand the option table with a "description" column so every 
required/optional option is explained in one place; keep the actual option 
names, types and defaults aligned with the corresponding `Options` class.
   - Add focused per-option descriptions that explain when the option is 
required, what value it expects, and any defaults or constraints.
   - Add a second task example that wires the connector into a full 
env/source/sink job, on top of the existing minimal snippet, so users can 
copy/paste a complete pipeline.
   - Fix obvious typos and outdated wording (for example the "DinkTalk" typo 
and the outdated "Support Those Engines" wording on Slack).
   - Use the same headings and bullet structure in both the English and Chinese 
docs.
   
   ## Files updated
   
   - docs/en/connectors/sink/DingTalk.md and docs/zh/connectors/sink/DingTalk.md
   - docs/en/connectors/sink/Slack.md and docs/zh/connectors/sink/Slack.md
   - docs/en/connectors/sink/Sentry.md and docs/zh/connectors/sink/Sentry.md
   - docs/en/connectors/source/GoogleSheets.md and 
docs/zh/connectors/source/GoogleSheets.md
   - docs/en/connectors/source/OpenMldb.md and 
docs/zh/connectors/source/OpenMldb.md
   
   ## Backward compatibility
   
   Documentation only. No connector code, config options, defaults or job 
behavior are changed. Existing jobs that use these connectors continue to work 
without any modification.


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