DanielCarter-stack opened a new pull request, #11711:
URL: https://github.com/apache/seatunnel/pull/11711
### Purpose
This PR improves the documentation of five connector-V2 docs in `docs/en`
and `docs/zh`:
- Cassandra (`source/Cassandra.md`, `sink/Cassandra.md`)
- Hbase (`source/Hbase.md`, `sink/Hbase.md`)
- Maxcompute (`source/Maxcompute.md`, `sink/Maxcompute.md`)
- Neo4j (`source/Neo4j.md`, `sink/Neo4j.md`)
- Qdrant (`source/Qdrant.md`, `sink/Qdrant.md`)
The goal is to align the docs with the current connector code, add the
missing `Support Those Engines` section that the other connector docs already
use, fix known structural bugs in the existing docs, and ensure both languages
stay in sync. No source code is modified, no source-version metadata is
touched, and no recent PR (within the last 7 days) on the same files is
duplicated.
### Changes
- **Cassandra (source & sink)**: Add notes that explicitly mention the
Cassandra Java Driver and clarify the `batch_type` / `async_write` semantics on
the sink side.
- **Hbase (source & sink)**: Add the missing `Support Those Engines`
section. Rewrite the `Write One Table` example so it is wrapped in `env` and
`sink {}` blocks (the previous Hocon snippet was malformed and was missing a
top-level wrapper). Reformat the multi-table `FakeSource` example to use
consistent indentation and quoted string literals.
- **Maxcompute (source & sink)**: Add the missing `Support Those Engines`
section. Replace the option tables with the typed `Name / Type / Required /
Default / Description` form for both languages so every option has an explicit
description. Expand the `Description` section with the new auth, partition,
template, and `insert_strategy` semantics. In the Chinese source doc, remove
the duplicated `tunnel_endpoint` section that left two `### tunnel_endpoint`
headings stacked.
- **Neo4j (source & sink)**: Add the missing `Support Those Engines` section.
- **Qdrant (source & sink)**: Add the missing `Support Those Engines`
section.
### Validation
- Spot-checked option names, types, and defaults against the connector
source code (`connector-cassandra`, `connector-hbase`, `connector-maxcompute`,
`connector-neo4j`, and `connector-qdrant`).
- Bilingual parity: every English doc change is mirrored in the
corresponding Chinese doc; only the missing sections, fixed structural bugs,
and table forms were edited.
- Markdown structure follows the same shape used by the recently merged
connector doc PRs.
- No version metadata in the changelog files is modified.
### 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 been reviewed; the only outstanding
build issue (#11709) does not block this PR and will be handled on its own
branch.
--
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]
