Skip to content

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.

Sign up for GitHub

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

Open
nikagra wants to merge 4 commits into
base: scylla-4.x
Choose a base branch
from
Open

docs: deprecate the 3.x doc versions and route their readers to 4.x #997

Show file tree
Hide file tree
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 Aug 13, 2026
04bc74b
docs: fix the coordinates the 3.x migration guide advertises
nikagra Aug 13, 2026
e931773
docs: mark the 3.x doc versions deprecated on the docs site
nikagra Aug 13, 2026
cce4001
docs: point deprecated 3.x doc versions at the migration guide
nikagra Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/source/_templates/version-warning.html
View file
Open in desktop
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 &mdash; 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 %}
9 changes: 8 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,14 @@
# Set which versions are not released yet.
UNSTABLE_VERSIONS = []
# Set which versions are deprecated
DEPRECATED_VERSIONS = []
DEPRECATED_VERSIONS = [
'scylla-3.7.2.x',
'scylla-3.10.2.x',
'scylla-3.11.0.x',
'scylla-3.11.2.x',
'scylla-3.11.4.x',
'scylla-3.11.5.x'
]

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand Down
1 change: 1 addition & 0 deletions docs/source/contents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
index
api
manual/*
upgrade_guide/from_3x/*
upgrade_guide/*
faq/*
changelog/*
Loading
Loading