Skip to content

[FLINK-39362][Docs] Fix broken/outdated connector download links and improve link maintenance strategy#4356

Merged
lvyanquan merged 9 commits into
apache:masterfrom
lvyanquan:hotfix-3.6-doc-links
Mar 31, 2026
Merged

[FLINK-39362][Docs] Fix broken/outdated connector download links and improve link maintenance strategy#4356
lvyanquan merged 9 commits into
apache:masterfrom
lvyanquan:hotfix-3.6-doc-links

Conversation

@lvyanquan
Copy link
Copy Markdown
Contributor

@lvyanquan lvyanquan commented Mar 31, 2026

What is the purpose of the change

This PR fixes broken/outdated connector download links in the Flink CDC documentation and improves the overall link maintenance strategy.

Brief change log

Documentation Fixes

  • Postgres to Fluss Quickstart: Added PostgreSQL to Fluss example to the introduction page Quickstart table (both English and Chinese versions).
  • Maven Download Links → mvnrepository: Replaced all specific-version Maven Central download links across 47 files (pipeline-connectors, flink-sources, quickstarts, tutorials) with mvnrepository.com artifact pages, so users can choose the latest release themselves and avoid dead link issues.
  • Removed "download links only available" notices from mysql-cdc.md, oceanbase-cdc.md, and oceanbase-tutorial.md since links now point to artifact pages.

Dead Link Check Configuration (.dlc.json)

  • Removed ^https://repo1.maven.org/maven2/org/apache/flink.* and ^https://mvnrepository.com from ignorePatterns, since connector download links no longer point to specific Maven Central JAR URLs.

lvyanquan and others added 2 commits March 31, 2026 13:31
Update download links in pipeline-connectors and flink-sources overview pages:
- Flink 1.20.x: Change path from /3.6.0/ to /3.6.0-1.20/ for versioned artifacts
- Flink 2.2.x: Change path from /3.6.0/ to /3.6.0-2.2/ for versioned artifacts

This align the URL structure with Maven Central's actual artifact layout.

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
…on page

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
@github-actions github-actions Bot added the docs Improvements or additions to documentation label Mar 31, 2026
@lvyanquan
Copy link
Copy Markdown
Contributor Author

PTAL @yuxiqian.

lvyanquan and others added 2 commits March 31, 2026 13:51
…ct pages

- Replace specific version download links in pipeline-connectors and
  flink-sources overview pages with mvnrepository.com artifact pages
  so users can choose the latest release themselves
- Remove 'download links only available for released versions' notices
  from mysql-cdc.md, oceanbase-cdc.md, and oceanbase-tutorial.md

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
…ct pages

- Replace all specific version download links in connector docs with
  mvnrepository.com artifact pages so users can choose the latest
  release themselves and avoid dead link issues
- Remove 'download links only available for released versions' notices
  from mysql-cdc.md, oceanbase-cdc.md, and oceanbase-tutorial.md
- Updated 47 files across pipeline-connectors, flink-sources, quickstarts
  and tutorials

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
@lvyanquan lvyanquan marked this pull request as draft March 31, 2026 05:57
lvyanquan and others added 2 commits March 31, 2026 14:02
…nk check ignore patterns

Since all Maven download links have been replaced with mvnrepository.com
artifact pages, the ignore patterns for repo1.maven.org and mvnrepository.com
are no longer needed.

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
Prevent documentation-only changes (dead link check config) from
triggering unnecessary unit and E2E tests.

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
@github-actions github-actions Bot added the build label Mar 31, 2026
@lvyanquan lvyanquan changed the title [hotfix][docs] Fix Maven connector download URLs for 3.6.0 version [hotfix][docs] Fix connector download links and clean up dead link check config Mar 31, 2026
@lvyanquan lvyanquan marked this pull request as ready for review March 31, 2026 06:37
… column

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
@lvyanquan lvyanquan changed the title [hotfix][docs] Fix connector download links and clean up dead link check config [FLINK-39362][Docs] Fix broken/outdated connector download links and improve link maintenance strategy Mar 31, 2026
Copy link
Copy Markdown
Member

@yuxiqian yuxiqian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates Flink CDC documentation to reduce connector download link rot by replacing direct Maven Central JAR URLs with mvnrepository artifact pages, and adjusts the dead-link-check configuration accordingly. It also adds a missing “PostgreSQL to Fluss” entry to the quickstart table (EN/ZH).

Changes:

  • Replace many connector download links (pipeline + flink-sources + tutorials + quickstarts) with mvnrepository artifact pages.
  • Add “PostgreSQL to Fluss” quickstart entry to the Get Started introduction (EN/ZH).
  • Update .dlc.json ignore patterns to re-enable checking of Maven Central / mvnrepository URLs.

Reviewed changes

Copilot reviewed 54 out of 54 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
docs/content/docs/get-started/quickstart-for-2.2/postgres-to-fluss.md Switch Postgres/Fluss connector download links to mvnrepository artifact pages.
docs/content/docs/get-started/quickstart-for-2.2/mysql-to-starrocks.md Switch MySQL/StarRocks connector download links to mvnrepository artifact pages.
docs/content/docs/get-started/quickstart-for-2.2/mysql-to-kafka.md Switch MySQL/Kafka connector download links to mvnrepository artifact pages.
docs/content/docs/get-started/quickstart-for-2.2/mysql-to-doris.md Switch MySQL/Doris connector download links to mvnrepository artifact pages.
docs/content/docs/get-started/quickstart-for-1.20/postgres-to-fluss.md Switch Postgres/Fluss connector download links to mvnrepository artifact pages.
docs/content/docs/get-started/quickstart-for-1.20/mysql-to-starrocks.md Switch MySQL/StarRocks connector download links to mvnrepository artifact pages.
docs/content/docs/get-started/quickstart-for-1.20/mysql-to-kafka.md Switch MySQL/Kafka connector download links to mvnrepository artifact pages.
docs/content/docs/get-started/quickstart-for-1.20/mysql-to-doris.md Switch MySQL/Doris connector download links to mvnrepository artifact pages.
docs/content/docs/get-started/introduction.md Add “PostgreSQL to Fluss” to the quickstart table.
docs/content/docs/connectors/pipeline-connectors/overview.md Replace per-version JAR links with a single mvnrepository artifact page per connector.
docs/content/docs/connectors/flink-sources/vitess-cdc.md Replace Vitess connector JAR link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/tutorials/tidb-tutorial.md Replace TiDB connector link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/tutorials/sqlserver-tutorial.md Replace SQLServer connector link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/tutorials/oracle-tutorial.md Replace Oracle connector link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/tutorials/oceanbase-tutorial.md Replace OceanBase connector link with mvnrepository artifact page; remove stable-only note line.
docs/content/docs/connectors/flink-sources/tutorials/mongodb-tutorial.md Replace MongoDB connector link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/tidb-cdc.md Replace TiDB connector JAR link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/sqlserver-cdc.md Replace SQLServer connector JAR link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/postgres-cdc.md Replace Postgres connector JAR link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/overview.md Replace download table links with mvnrepository artifact pages (and modify the feature matrix table).
docs/content/docs/connectors/flink-sources/oracle-cdc.md Replace Oracle connector JAR link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/oceanbase-cdc.md Replace OceanBase connector JAR link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/mysql-cdc.md Replace MySQL connector JAR link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/mongodb-cdc.md Replace MongoDB connector JAR link with mvnrepository artifact page.
docs/content/docs/connectors/flink-sources/db2-cdc.md Replace Db2 connector JAR link with mvnrepository artifact page.
docs/content.zh/docs/get-started/quickstart-for-2.2/postgres-to-fluss.md Switch Postgres/Fluss connector download links to mvnrepository artifact pages (ZH).
docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-starrocks.md Switch MySQL/StarRocks connector download links to mvnrepository artifact pages (ZH).
docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-kafka.md Switch MySQL/Kafka connector download links to mvnrepository artifact pages (ZH).
docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-doris.md Switch MySQL/Doris connector download links to mvnrepository artifact pages (ZH).
docs/content.zh/docs/get-started/quickstart-for-1.20/postgres-to-fluss.md Switch Postgres/Fluss connector download links to mvnrepository artifact pages (ZH).
docs/content.zh/docs/get-started/quickstart-for-1.20/mysql-to-starrocks.md Switch MySQL/StarRocks connector download links to mvnrepository artifact pages (ZH).
docs/content.zh/docs/get-started/quickstart-for-1.20/mysql-to-kafka.md Switch MySQL/Kafka connector download links to mvnrepository artifact pages (ZH).
docs/content.zh/docs/get-started/quickstart-for-1.20/mysql-to-doris.md Switch MySQL/Doris connector download links to mvnrepository artifact pages (ZH).
docs/content.zh/docs/get-started/introduction.md Add “PostgreSQL to Fluss” to the quickstart table (ZH).
docs/content.zh/docs/connectors/pipeline-connectors/overview.md Replace per-version JAR links with a single mvnrepository artifact page per connector (ZH).
docs/content.zh/docs/connectors/flink-sources/vitess-cdc.md Replace Vitess connector JAR link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/tutorials/tidb-tutorial.md Replace TiDB connector link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/tutorials/sqlserver-tutorial.md Replace SQLServer connector link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/tutorials/polardbx-tutorial.md Replace MySQL CDC connector link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/tutorials/oracle-tutorial.md Replace Oracle connector link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/tutorials/oceanbase-tutorial.md Replace OceanBase connector link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/tutorials/mongodb-tutorial.md Replace MongoDB connector link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/tutorials/build-streaming-etl-tutorial.md Replace MySQL/Postgres CDC connector links with mvnrepository artifact pages (ZH).
docs/content.zh/docs/connectors/flink-sources/tutorials/build-real-time-data-lake-tutorial.md Replace MySQL CDC connector link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/tidb-cdc.md Replace TiDB connector JAR link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/sqlserver-cdc.md Replace SQLServer connector JAR link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/postgres-cdc.md Replace Postgres connector JAR link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/overview.md Replace download table links with mvnrepository artifact pages (and modify the feature matrix table) (ZH).
docs/content.zh/docs/connectors/flink-sources/oracle-cdc.md Replace Oracle connector JAR link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/oceanbase-cdc.md Replace OceanBase connector JAR link with mvnrepository artifact page; remove stable-only notice block (ZH).
docs/content.zh/docs/connectors/flink-sources/mysql-cdc.md Replace MySQL connector JAR link with mvnrepository artifact page; remove stable-only notice block (ZH).
docs/content.zh/docs/connectors/flink-sources/mongodb-cdc.md Replace MongoDB connector JAR link with mvnrepository artifact page (ZH).
docs/content.zh/docs/connectors/flink-sources/db2-cdc.md Replace Db2 connector JAR link with mvnrepository artifact page (ZH).
.dlc.json Remove ignore patterns for Flink Maven Central and mvnrepository URLs so they are checked again.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/content/docs/connectors/flink-sources/overview.md Outdated
Comment thread docs/content.zh/docs/connectors/flink-sources/overview.md Outdated
Comment thread docs/content/docs/connectors/flink-sources/mysql-cdc.md Outdated
Comment thread docs/content/docs/connectors/flink-sources/oceanbase-cdc.md Outdated
… column and remove stable releases notice

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
@lvyanquan lvyanquan merged commit 209c0c6 into apache:master Mar 31, 2026
22 of 23 checks passed
lvyanquan added a commit that referenced this pull request Mar 31, 2026
…improve link maintenance strategy (#4356)

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
(cherry picked from commit 209c0c6)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved build docs Improvements or additions to documentation reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants