Skip to content

[Improve][Docs] Optimize Doris, Paimon, Redis, and StarRocks connector docs - #3

Draft
DanielCarter-stack wants to merge 375 commits into
devfrom
docs/connectors-batch-20260812-01
Draft

[Improve][Docs] Optimize Doris, Paimon, Redis, and StarRocks connector docs#3
DanielCarter-stack wants to merge 375 commits into
devfrom
docs/connectors-batch-20260812-01

Conversation

@DanielCarter-stack

Copy link
Copy Markdown
Owner

Summary

This PR optimizes the user-facing documentation for five Apache SeaTunnel connectors (Doris, Paimon, Redis, StarRocks, both source and sink pages, English and Chinese) so the docs more accurately reflect the connector behavior and surface commonly used e2e patterns as first-class examples.

What changed

  • Doris (source): Fixed the asynchronous Arrow queue option name (doris.request.retriesdoris.deserialize.queue.sizedoris.deserialize.queue.size) and added a multi-source example that reads from two Doris databases with per-table doris.read.field and doris.filter.query settings, then writes back to Doris with ${table_name}.
  • Doris (sink): Added a data_save_mode = CUSTOM_PROCESSING example that uses custom_sql to seed the target table before the synchronization task, in both English and Chinese pages.
  • Paimon (source): Added complete scan.tag-name and incremental-between query examples that show how to read a single tag snapshot and how to read the rows added between two tags.
  • Paimon (sink): Added a streaming CDC → non-primary-key Paimon table example that combines paimon.table.non-primary-key = true with paimon.table.write-props, in both English and Chinese pages.
  • Redis (source): Added a single-node db_num example that reads from one database and writes to another in the same pipeline, plus an FAQ section with a read_key_enabled configuration example and a cluster-mode multi-table reading example.
  • Redis (sink): Added a multi-table sink example that uses ${table_name} in the key template, and a FAQ section explaining value_field, expire, and the limitation that each sink instance can only target a single Redis database.
  • StarRocks (sink): Added an automatic table creation example with table_options (storage_format, etc.) and a Zeta timer-flush example that combines MySQL-CDC, checkpoint.interval, and sink.flush.interval, in both English and Chinese pages.

Validation

  • All modified files are under docs/en/connectors/{source,sink} and docs/zh/connectors/{source,sink}; no source code, config files, or public API contracts were changed.
  • All additions reuse e2e patterns that already exist in seatunnel-e2e/seatunnel-connector-v2-e2e/connector-{doris,paimon,redis,starrocks}-e2e.
  • Chinese pages are updated in lockstep with English pages and keep the Chinese-language convention for connector feature lists.

Checklist

  • Docs only
  • Follows the existing [Type][Module] commit message style
  • No new dependencies, no removed config options, no public API changes
  • Draft PR — ready to be promoted once CI is green

DanielCarter-stack and others added 30 commits July 3, 2026 08:20
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…nRule (apache#11225)

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…che#11292)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…11293)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…1294)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Co-authored-by: Shenghang <shenghang@apache.org>
…ache#11300)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…#11299)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…11298)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…e#11297)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Co-authored-by: DanielLeens <DanielLeens@users.noreply.github.com>
…he#11323)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…che#11319)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…1308)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…he#11318)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…he#11320)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…#11321)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…1322)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Co-authored-by: Daniel <escheduler@outlook.com>
…11313)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…pache#11314)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…ache#11315)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…#11296)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…cs (apache#11302)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
DanielCarter-stack and others added 14 commits August 11, 2026 20:48
…S3-Redshift connector docs (apache#11745)

Co-authored-by: DanielCarter-stack <danielcarter-stack@users.noreply.github.com>
…ge worker-failure test (apache#11726)

Co-authored-by: DanielLeens <vsantonastaso.dev@gmail.com>
…sites, and wide-DAG wiring rules (apache#11659)

Co-authored-by: SEZ9 <20342912+SEZ9@users.noreply.github.com>
…ant connector docs (apache#11711)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
… Zendesk connector docs (apache#11698)

Co-authored-by: DanielCarter-stack <danielcarter-stack@users.noreply.github.com>
…penMldb connector docs (apache#11692)

Co-authored-by: DanielCarter-stack <danielcarter-stack@users.noreply.github.com>
… docs (apache#11575)

Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
)

Signed-off-by: Shenghang Zhang <shenghang@apache.org>
Co-authored-by: zhangshenghang <zhangshenghang@apache.org>
Co-authored-by: zhangshenghang <zhangshenghang@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
…pache#11654)

Signed-off-by: Santhosh Kumar Somarapu <somarapu.santhosh91@gmail.com>
… subtask instead of once per output file (apache#11661)

Co-authored-by: Dongyeon <loustler@naverz-corp.com>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Signed-off-by: FenjuFu <92919259+FenjuFu@users.noreply.github.com>
DanielCarter-stack and others added 2 commits August 12, 2026 10:28
…esense and Assert connector docs (apache#11751)

Co-authored-by: DanielCarter-stack <danielcarter-stack@users.noreply.github.com>
@DanielCarter-stack
DanielCarter-stack force-pushed the docs/connectors-batch-20260812-01 branch from 28cddd0 to 6ea037c Compare August 12, 2026 04:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.