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

   ## [Docs][Connector-V2] Improve Paimon StarRocks and RabbitMQ connector docs
   
   ### Summary
   
   This PR polishes the user-facing documentation for five Paimon, StarRocks, 
and RabbitMQ connector pages. It is part of an ongoing effort to make connector 
docs self-contained, accurate, and copy-paste friendly.
   
   ### Changes
   
   **Paimon source**
   - Add a `description` column to the options table and document the 
previously-undocumented `catalog_name`, `user`, and `password` options.
   - Remove a duplicate `## Changelog` section (the section explaining Paimon 
changelog reading was previously mis-named `## Changelog` and collided with the 
file-footer changelog). Renamed to `## Reading Paimon Changelog`.
   
   **Paimon sink**
   - Add a `description` column to the options table and tighten descriptions 
for catalog options and the schema/data save modes.
   
   **StarRocks source**
   - Replace placeholder `password = ""` and unquoted `username = root` in the 
two examples with realistic values and consistent quoting.
   - Tighten the descriptions for `request_tablet_size`, `nodeUrls`, 
`username`, `password`, `database`, and `table`.
   
   **StarRocks sink**
   - Same `password`/`username` example fixes applied across all sample configs 
in both `docs/en` and `docs/zh`.
   
   **RabbitMQ source**
   - Add a `description` column to the options table; clarify `tables_configs` 
vs root-level `queue_name` and the `AUTOMATIC_RECOVERY_ENABLED` casing.
   
   **RabbitMQ sink**
   - Add a `description` column to the options table; clarify the 
`routing_key`/`exchange` pair, the `rabbitmq.config` extra-options map, and the 
queue declaration flags.
   
   ### Checklist
   
   - [x] Only documentation files are touched.
   - [x] No support-version metadata changed.
   - [x] Each touched connector (Paimon, StarRocks, RabbitMQ) has not been 
modified by another PR in the last 7 days.
   - [x] No source code, examples, or e2e test configs were touched.
   
   ### Notes
   
   - Connector identifiers and option names match the runtime options classes 
(`PaimonBaseOptions`, `PaimonSinkOptions`, `KafkaBaseOptions`, etc.).
   - The five connectors selected here have no PR touching their docs in the 
last 7 days, per the team's batching rule.
   


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