forked from apache/cassandra-java-driver
-
Notifications
You must be signed in to change notification settings - Fork 43
docs: deprecate the 3.x doc versions and route their readers to 4.x #997
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
dkropachev
merged 4 commits into
scylladb:scylla-4.x
from
nikagra:deprecate/3x-doc-versions
Aug 31, 2026
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
6bb67f1
docs: give the 3.x migration guide its own page
nikagra 04bc74b
docs: fix the coordinates the 3.x migration guide advertises
nikagra e931773
docs: mark the 3.x doc versions deprecated on the docs site
nikagra cce4001
docs: point deprecated 3.x doc versions at the migration guide
nikagra File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| {# Deprecated versions (see DEPRECATED_VERSIONS in conf.py) get a single combined | ||
| notice that both marks the deprecation and points at the migration guide, in | ||
| place of the theme's generic "previous version" banner. Every other version | ||
| falls through to the theme's own template, unchanged. | ||
|
|
||
| This file lives on the publishing branch on purpose: sphinx-multiversion builds | ||
| every version with `-c <publishing tree>/docs/source`, and Sphinx resolves | ||
| templates_path against the confdir, so this reaches the frozen scylla-3.*.x | ||
| branches too -- none of which need to be touched. | ||
|
|
||
| The migration link deliberately points at the guide's root rather than at | ||
| upgrade_guide/from_3x/. Page *content* does come from each version's own ref, | ||
| and /stable/ is built from the newest release branch in BRANCHES, not from | ||
| this one -- so from_3x/ only exists at /stable/ once a release branch is cut | ||
| that contains it. Repoint this href then. #} | ||
| {% if versions and current_version and latest_version and current_version.name in theme_versions_deprecated %} | ||
| <div class="admonition caution"> | ||
| <p class="admonition-title">Caution</p> | ||
| <p> | ||
| Java Driver 3.x is deprecated and in maintenance mode — it receives critical | ||
| bug fixes only. New projects and active development should use | ||
| <a href="{{ vpathto(latest_version.name) }}">Java Driver 4.x</a>; see the | ||
| <a href="{{ html_baseurl }}/stable/upgrade_guide/">migration guide</a>. | ||
| </p> | ||
| </div> | ||
| {% else %} | ||
| {% include "!version-warning.html" %} | ||
| {% endif %} | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ | |
| index | ||
| api | ||
| manual/* | ||
| upgrade_guide/from_3x/* | ||
| upgrade_guide/* | ||
| faq/* | ||
| changelog/* | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nikagra , have you tested it locally ? how does it look like ?