Repository navigation
KAFKA-20265: Add canonical URL tags to Kafka Javadoc pages to point search engines to suggest latest stable version - #823
Open
MartijnVisser wants to merge 2 commits into
Conversation
Add a bash script that inserts/updates <link rel="canonical"> tags in all Javadoc HTML files across all versions, pointing to the latest stable version. This points search engines to use the latest stable versions of the API docs and consolidates SEO ranking signals. When a Javadoc page doesn't exist in the latest version (e.g., a removed API), the script points the canonical URL to the newest version that still contains the page, instead of pointing to a 404. Also update README.md to document the new step in the release process.
Run add-javadoc-canonical-urls.sh to add <link rel="canonical"> tags across all existing Javadoc HTML files in static/*/javadoc/. Pages that exist in the latest version (42) get a canonical pointing there. Pages for removed APIs point to the newest version that still contains them.
mjsax
reviewed
May 1, 2026
| for (i = 1; i <= n; i++) order[v[i]] = i | ||
| } | ||
| !seen[$0]++ { print $0 } | ||
| ' > /dev/null |
Member
There was a problem hiding this comment.
What's the purpose of this block from L75 to here? (Thank you Claude for this pointer 😄)
| !seen[$0]++ { print $0 } | ||
| ' > /dev/null | ||
|
|
||
| # Simpler approach: for each version (newest first), record paths not yet seen |
Member
There was a problem hiding this comment.
If we delete the above block, we can update this comment?
| CANONICAL_URL="https://kafka.apache.org/${CANON_VERSION}/javadoc/${REL_PATH}" | ||
| CANONICAL_TAG="<link rel=\"canonical\" href=\"${CANONICAL_URL}\">" | ||
|
|
||
| if grep -qi 'rel="canonical"' "$HTML_FILE" 2>/dev/null; then |
Member
There was a problem hiding this comment.
grep -qiE 'rel=["'\'']canonical["'\'']' to find both 'canonical' and "canonical".
| # | ||
| # If no version argument is provided, reads latest_version from hugo.yaml. | ||
|
|
||
| set -e |
Member
There was a problem hiding this comment.
Claude suggest to use set -euo pipefail
| CANONICAL_TAG="<link rel=\"canonical\" href=\"${CANONICAL_URL}\">" | ||
|
|
||
| if grep -qi 'rel="canonical"' "$HTML_FILE" 2>/dev/null; then | ||
| "${SED_INPLACE[@]}" "s|<[Ll][Ii][Nn][Kk] [Rr][Ee][Ll] *=[\"'] *canonical[\"'][^>]*>|${CANONICAL_TAG}|g" "$HTML_FILE" |
Member
There was a problem hiding this comment.
<[Ll][Ii][Nn][Kk] [Rr][Ee][Ll] -> <[Ll][Ii][Nn][Kk][[:space:]]+[Rr][Ee][Ll]
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
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.
Some examples of Javadocs that are currently ranked for older versions:
RetriableCommitFailedExceptionis shown for 2.5.0 instead of 4.2.0ConsumerRebalanceListeneris shown for both 2.5.0 and 2.3.0 instead of 4.2.0AdminClientis shown for 2.6.0 instead of 4.2.0