Skip to content

docs: add redirection warning #119

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

Merged
wprzytula merged 2 commits into from
Nov 4, 2025
Merged

docs: add redirection warning #119

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04b5ddf
docs: add redirection warning
dgarcia360 Nov 4, 2025
46507c7
docs: revise version warning for deprecated driver
dgarcia360 Nov 4, 2025
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
7 changes: 7 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,7 @@
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>
You're viewing documentation for a previous version.
Copy link

@tzach tzach Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest

Development has advanced to the new ScyllaDB CPP Rust-base Driver ,offering similar functionality with better performance

Copy link

@wprzytula wprzytula Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest

Development has advanced to the new ScyllaDB CPP Rust-base Driver ,offering similar functionality with better performance

Let's directly mention "ScyllaDB CPP-RS Driver", not to create any confusion about naming.

Copy link

@wprzytula wprzytula Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd also very clearly state here something like: "This driver is not developed anymore. For an API-compatible replacement with active support, see ScyllaDB CPP-RS Driver ".

Copy link
Author

@dgarcia360 dgarcia360 Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated:

image

Copy link

@wprzytula wprzytula Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect.

<a href="https://cpp-rs-driver.docs.scylladb.com/stable/">Switch to the latest stable version.</a>
</p>
</div>
1 change: 1 addition & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ def generate_doxygen(app):
# a list of builtin themes.
#
html_theme = 'sphinx_scylladb_theme'
templates_path = ['_templates', ]

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down