Update Javadoc links to use OS version [DI-425] #1538
Merged
Conversation
This file contains 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
Replace: - https://docs.hazelcast.org/docs/{full-version}/javadoc - https://docs.hazelcast.org/docs/{page-latest-supported-java-client}/javadoc With either `os-version` or `ee-version` as appropriate.
JackPGreen
added
the
backport to all versions
✅ Deploy Preview for hardcore-allen-f5257d ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
JackPGreen
added
backport to 5.5
JackPGreen
added a commit
to JackPGreen/hz-docs
that referenced
this pull request
Feb 13, 2025
(Manual) backport of hazelcast#1538
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.
The OS & EE Javadocs are versioned separately - reflecting the latest version of each product.
However in the documentation, we use the (problematic)
full-versionproperty when linking to the OS Javadoc which is the latest EE version.We no longer publish (incorrectly versioned) OS Javadoc as part of an EE release which is why this problem is only now visible.
Replaced:
With
https://docs.hazelcast.org/docs/{os-version}/javadocas are all OS content.Tested by running external link check on branch.
Ideally this should be backported to all maintenance branches, but the PR is unlikely to merge without conflicts. If required, re-applying the change (now it's scoped) is trivial.
Fixes: DI-425