Docs: Fix broken links in Flink Configuration documentation #13288
+1
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@KyleLin0927 Thanks for your PR, could you share a snapshot of the page after the fix? |
|
I used MkDocs to preview the Markdown rendering (the links are broken in this mode because they rely on Javadoc relative path templates, which don’t work correctly in this local setup). 
|
stevenzwu
approved these changes
Jun 12, 2025
|
thanks @KyleLin0927 for the fix and @manuzhang for the review. I will merge it to give this a try. if it doesn't work, we can follow up again. |
|
confirmed that this works correctly |
thanks for your check! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does
This PR fixes broken
{@link ...}tags in the Flink Configuration documentation by converting them into proper Markdown links.Fixes #13285
Why is this necessary
The original links used JavaDoc-style
{@link ...}syntax, which is not rendered correctly in Markdown.How this was fixed
{@link StatisticsType#Map}with [StatisticsType.Map](../../javadoc/{{ icebergVersion }}/org/apache/iceberg/flink/sink/shuffle/StatisticsType.html#Map){@link StatisticsType#Sketch}with [StatisticsType.Sketch](../../javadoc/{{ icebergVersion }}/org/apache/iceberg/flink/sink/shuffle/StatisticsType.html#Sketch)These changes follow the link style already used elsewhere in the documentation (e.g.,
PendingUpdatereferences).