You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by "zhangshenghang (via GitHub)" <gi...@apache.org> on 2026/06/29 13:45:37 UTC

[PR] [Docs] Fix connector documentation links [seatunnel]

zhangshenghang opened a new pull request, #11217:
URL: https://github.com/apache/seatunnel/pull/11217

   ## What documentation issues were found
   
   Several connector documentation pages had real reader-facing issues:
   
   - Some Chinese connector pages used full-width parentheses in Markdown links, for example `](...)`, so the docs rendered the target as plain text instead of a clickable link.
   - A few links pointed to invalid paths, including `../Sink common Options.md`, `../sink common-Options.md`, and a Debezium JSON path containing a space.
   - Several Sink connector pages described `common-options` as Source common options, although the link target was the Sink common options page. This affected English and Chinese docs where the same mistake existed.
   - The Kudu Sink docs listed `save_mode` as having no default and said `batch_size` defaults to `100`, while the current implementation defaults to `APPEND` and `1024`.
   
   ## What was changed
   
   - Converted malformed Chinese Markdown links to normal clickable links.
   - Corrected invalid relative paths to the existing common options and format pages.
   - Updated Sink connector `common-options` descriptions to point readers to Sink common options instead of Source common options.
   - Corrected Kudu Sink default value text for `save_mode` and `batch_size`.
   
   ## Areas/files updated
   
   Updated 23 connector documentation files under:
   
   - `docs/en/connectors/sink`
   - `docs/zh/connectors/sink`
   - `docs/zh/connectors/source`
   
   The affected connector pages include Hudi, Kudu, MongoDB, Pulsar, Qdrant, Socket, AmazonSqs, ObsFile, OceanBase, OssFile, OssJindoFile, RocketMQ, S3-Redshift, SftpFile, Tablestore, CosFile, DB2, and Easysearch.
   
   ## English and Chinese docs check
   
   Both English and Chinese connector docs were checked. When the same Sink common-options issue existed in both languages, both pages were updated. The malformed full-width Markdown links were only found in the Chinese connector pages, so those fixes are Chinese-only.
   
   ## Duplicate PR check
   
   I checked PRs created in the last 7 days with:
   
   ```bash
   gh search prs --repo apache/seatunnel --created '>=2026-06-22' --json number,title,author,createdAt,state,url --limit 100
   ```
   
   I also inspected recent documentation-related or potentially overlapping PRs, including #11175, #11176, #11183, #11197, and #11214. They cover connector FAQ links, JDBC table prefix/suffix deprecation, Jira API token guide links, Transform docs, and Socket Sink validation code. None covered these malformed connector links, Sink common-options wording issues, or Kudu Sink default-value documentation fixes.
   
   ## Verification
   
   - `for f in $(git diff --name-only | sort); do npx --yes markdown-link-check@3.8.7 -q -c .dlc.json "$f" || exit 1; done`
   - `git diff --check`
   - `./mvnw spotless:apply`
   - `./mvnw -q -DskipTests verify`
   


-- 
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: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [Docs] Fix connector documentation links [seatunnel]

Posted by "davidzollo (via GitHub)" <gi...@apache.org>.
davidzollo merged PR #11217:
URL: https://github.com/apache/seatunnel/pull/11217


-- 
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: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org