[
https://issues.apache.org/jira/browse/FLINK-39362?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Yanquan Lv resolved FLINK-39362.
--------------------------------
Assignee: Yanquan Lv
Resolution: Fixed
Merged in master via 209c0c6a7d877eee36f6e8e8311406b7b0c3ac92.
> [Docs] Fix broken/outdated connector download links and improve link
> maintenance strategy
> -----------------------------------------------------------------------------------------
>
> Key: FLINK-39362
> URL: https://issues.apache.org/jira/browse/FLINK-39362
> Project: Flink
> Issue Type: Improvement
> Components: Flink CDC
> Affects Versions: cdc-3.6.0
> Reporter: Yanquan Lv
> Assignee: Yanquan Lv
> Priority: Major
> Labels: pull-request-available
>
> Background
> The connector download links in the Flink CDC documentation currently
> point to specific Maven
> Central JAR URLs. However, the path structure often mismatches the actual
> artifact layout after
> releases (e.g., /3.6.0/ vs /3.6.0-1.20/), resulting in numerous broken
> links. Additionally,
> maintaining these version-specific links requires manual updates for
> every new release, which is
> error-prone and unsustainable.
> Proposed Changes
> This PR addresses the broken download links and improves the long-term
> maintainability of the
> documentation:
> 1. Replace Specific-Version Links with Artifact Pages: Updated 47
> markdown files across
> pipeline-connectors, flink-sources, quickstarts, and tutorials. All
> direct Maven Central JAR
> links have been replaced with stable mvnrepository.com artifact
> pages. Users can now select the
> appropriate version themselves.
> 2. Add Missing Quickstart Example: Added the PostgreSQL to Fluss
> pipeline example to the Quickstart
> table in the Introduction page (both English and Chinese versions).
> 3. Remove Obsolete Notices: Deleted the "Download links are only
> available for released versions..."
> warnings from mysql-cdc.md, oceanbase-cdc.md, and
> oceanbase-tutorial.md, as they are no longer
> applicable.
> 4. Improve Table Consistency: Updated the "Download Page" column in
> pipeline-connectors/overview.md
> to display human-readable connector names (e.g., Apache Doris instead
> of doris) matching the
> "Connector" column.
> 5. Clean Up Dead Link Check Config: Removed
> ^https://repo1.maven.org/maven2/org/apache/flink.* and
> ^https://mvnrepository.com from .dlc.json ignorePatterns, since the
> documentation no longer
> contains fragile direct JAR URLs.
> Benefits
> - Eliminates broken download links for connector JARs.
> - Reduces future documentation maintenance overhead; no need to update
> links for each minor/patch
> release.
> - Improves user experience by directing them to a centralized version
> selection page.
> - Passes the CI dead link check (Build documentation / check-doc).
> Files Modified
> - docs/content/docs/connectors/**/overview.md
> - docs/content.zh/docs/connectors/**/overview.md
> - docs/content/docs/get-started/introduction.md & Chinese counterpart
> - docs/content/**/*quickstart*.md & docs/content/**/*tutorial*.md (47
> files total)
> - .dlc.json
> Verification
> - [x] Local Hugo build passes without errors.
> - [x] CI check-doc job (dead link check) passes successfully.
> - [x] All updated mvnrepository.com links return HTTP 200.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
