docs: Update replacements and links #541
Merged
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
Those links redirect to internal API which is not a part of the generated javadoc, leading to 404 on visit. Instead redirect to code on github.
Some of the links in documentation lead to datastax repositories. This change adds patterns that should cover any links to classes or directories of the codebase and make them point to scylladb fork instead.
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation links and replacement patterns to fix broken URLs for the scylla-4.x branch, and adds extra patterns for handling GitHub links.
- Updated URL links in the reconnection README to point to the correct GitHub repository paths.
- Added new regex replacement patterns for GitHub links in docs/source/conf.py to ensure consistency across documentation.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| manual/core/reconnection/README.md | Fixed broken links by redirecting to the GitHub repository for the scylla-4.x branch. |
| docs/source/conf.py | Added multiple replacement patterns to update and standardize documentation links. |
| was established. | ||
|
|
||
| [ConstantReconnectionPolicy]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/internal/core/connection/ConstantReconnectionPolicy.html | ||
| [ConstantReconnectionPolicy]: https://github.com/scylladb/java-driver/blob/scylla-4.x/core/src/main/java/com/datastax/oss/driver/internal/core/connection/ConstantReconnectionPolicy.java |
There was a problem hiding this comment.
Verify that the updated link correctly reflects the intended repository structure and branch for accurate documentation reference.
| r'docs.datastax.com/en/drivers/java\/(.*?)\/': "java-driver.docs.scylladb.com/" + current_slug + "/api/", | ||
| r'java-driver.docs.scylladb.com\/(.*?)\/': "java-driver.docs.scylladb.com/" + current_slug + "/" | ||
| r'java-driver.docs.scylladb.com\/(.*?)\/': "java-driver.docs.scylladb.com/" + current_slug + "/", | ||
| r'github.com\/apache\/cassandra-java-driver\/blob\/4.x\/': "github.com/scylladb/java-driver/blob/scylla-4.x/", |
There was a problem hiding this comment.
[nitpick] Consider adding inline comments to describe the intent behind these new replacement patterns, which can aid future maintainability.
Author
|
This PR can be merged separately from the other drafts. |
dkropachev
approved these changes
May 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds a few extra replacement patterns for documentation links and fixes broken links in reconnection manual, but for this (scylla-4.x) branch only. Once this patch is approved I will create backports fixing the links in older versions.