[FLINK-39416] Fix link address errors in documents#4373
[FLINK-39416] Fix link address errors in documents#4373sd4324530 wants to merge 2 commits intoapache:masterfrom
Conversation
Signed-off-by: Pei Yu <125331682@qq.com>
There was a problem hiding this comment.
Pull request overview
This PR updates documentation hyperlinks to fix broken internal anchors and outdated external references, with a focus on improving link navigation (including in Chinese docs).
Changes:
- Updated internal section links (anchor fragments) in multiple connector and core-concept docs.
- Updated several external Apache Flink documentation URLs (e.g., savepoint restore and type docs) to newer release paths.
- Simplified/standardized Chinese document anchors by linking directly to heading-generated ids.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/content/docs/connectors/flink-sources/postgres-cdc.md | Adjusts internal anchor to the “Incremental Snapshot Reading (Experimental)” section; updates Flink savepoint doc URL. |
| docs/content/docs/connectors/flink-sources/oracle-cdc.md | Updates Flink savepoint doc URL. |
| docs/content/docs/connectors/flink-sources/oceanbase-cdc.md | Adjusts internal anchor for “Spatial Data Types Mapping”. |
| docs/content/docs/connectors/flink-sources/mysql-cdc.md | Updates SQL hints URL and internal chunk-reading anchor; updates Flink savepoint doc URL. |
| docs/content/docs/connectors/flink-sources/mongodb-cdc.md | Updates Flink savepoint and Flink type-system doc URLs. |
| docs/content.zh/docs/core-concept/transform.md | Fixes internal link to the “所有支持的模型” section. |
| docs/content.zh/docs/core-concept/schema-evolution.md | Fixes internal link to the “按类型配置行为” section. |
| docs/content.zh/docs/core-concept/data-pipeline.md | Fixes internal link to the “Pipeline 配置” section. |
| docs/content.zh/docs/connectors/pipeline-connectors/mysql.md | Fixes internal link to “空间数据类型映射”. |
| docs/content.zh/docs/connectors/flink-sources/postgres-cdc.md | Adjusts internal anchor to “Incremental Snapshot Reading (Experimental)”; updates Flink savepoint doc URL. |
| docs/content.zh/docs/connectors/flink-sources/oracle-cdc.md | Updates Flink savepoint doc URL. |
| docs/content.zh/docs/connectors/flink-sources/oceanbase-cdc.md | Fixes internal link target and removes explicit named anchor in the “空间数据类型映射” header. |
| docs/content.zh/docs/connectors/flink-sources/mysql-cdc.md | Updates SQL hints URL; normalizes multiple internal anchors to heading-based ids; updates Flink savepoint doc URL. |
| docs/content.zh/docs/connectors/flink-sources/mongodb-cdc.md | Normalizes internal anchor to heading-based id; updates Flink savepoint and Flink type-system doc URLs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| (2) source can perform checkpoints in the chunk granularity during snapshot reading, | ||
| (3) source doesn't need to acquire global read lock (FLUSH TABLES WITH READ LOCK) before snapshot reading. | ||
| Please see <a href="#incremental-snapshot-reading ">Incremental Snapshot Reading</a>section for more detailed information. | ||
| Please see <a href="#incremental-snapshot-reading-experimental ">Incremental Snapshot Reading</a>section for more detailed information. |
There was a problem hiding this comment.
The fragment identifier in this link has a trailing space (#incremental-snapshot-reading-experimental ). In HTML, the space becomes part of the fragment and won’t match the generated heading id, so the link will not navigate correctly. Please remove the trailing space so it matches the Incremental Snapshot Reading (Experimental) section id.
| Please see <a href="#incremental-snapshot-reading-experimental ">Incremental Snapshot Reading</a>section for more detailed information. | |
| Please see <a href="#incremental-snapshot-reading-experimental">Incremental Snapshot Reading</a>section for more detailed information. |
|
|
||
| In snapshot phase, the snapshot is cut into multiple snapshot chunks according to chunk key of table and the size of table rows. | ||
| Snapshot chunks is assigned to multiple snapshot readers. Each snapshot reader reads its received chunks with [chunk reading algorithm](#snapshot-chunk-reading) and send the read data to downstream. | ||
| Snapshot chunks is assigned to multiple snapshot readers. Each snapshot reader reads its received chunks with [chunk reading algorithm](#Chunk-Reading-Algorithm) and send the read data to downstream. |
There was a problem hiding this comment.
The link target #Chunk-Reading-Algorithm does not match the heading id generated for ##### Chunk Reading Algorithm (Hugo/Markdown heading ids are typically lowercased, i.e., #chunk-reading-algorithm). With the current capitalization, the internal link is likely broken. Please use the correct generated fragment for that heading.
| Snapshot chunks is assigned to multiple snapshot readers. Each snapshot reader reads its received chunks with [chunk reading algorithm](#Chunk-Reading-Algorithm) and send the read data to downstream. | |
| Snapshot chunks is assigned to multiple snapshot readers. Each snapshot reader reads its received chunks with [chunk reading algorithm](#chunk-reading-algorithm) and send the read data to downstream. |
| <td> | ||
| The spatial data types will be converted into STRING with a fixed Json format. | ||
| Please see <a href="#patial-data-types-mapping ">Spatial Data Types Mapping</a> section for more detailed information. | ||
| Please see <a href="#Spatial-Data-Types-Mapping ">Spatial Data Types Mapping</a> section for more detailed information. |
There was a problem hiding this comment.
This link uses href="#Spatial-Data-Types-Mapping " with capital letters and a trailing space. The ### Spatial Data Types Mapping heading will generate an id like #spatial-data-types-mapping (lowercase, no trailing space), so the current fragment likely won’t resolve. Please update the fragment to match the generated heading id and remove the trailing space.
| Please see <a href="#Spatial-Data-Types-Mapping ">Spatial Data Types Mapping</a> section for more detailed information. | |
| Please see <a href="#spatial-data-types-mapping">Spatial Data Types Mapping</a> section for more detailed information. |
| (2) source can perform checkpoints in the chunk granularity during snapshot reading, | ||
| (3) source doesn't need to acquire global read lock (FLUSH TABLES WITH READ LOCK) before snapshot reading. | ||
| Please see <a href="#incremental-snapshot-reading ">Incremental Snapshot Reading</a>section for more detailed information. | ||
| Please see <a href="#incremental-snapshot-reading-experimental ">Incremental Snapshot Reading</a>section for more detailed information. |
There was a problem hiding this comment.
The fragment identifier in this link has a trailing space (#incremental-snapshot-reading-experimental ). This prevents matching the generated heading id for Incremental Snapshot Reading (Experimental), so the link will not work. Please remove the trailing space from the fragment.
| Please see <a href="#incremental-snapshot-reading-experimental ">Incremental Snapshot Reading</a>section for more detailed information. | |
| Please see <a href="#incremental-snapshot-reading-experimental">Incremental Snapshot Reading</a>section for more detailed information. |
Signed-off-by: Pei Yu <125331682@qq.com>
Currently, many internal links in the document are not redirecting correctly, especially in Chinese documents.