Skip to content

docs: deprecate Java Driver 3.x and announce maintenance mode #919

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

Draft
nikagra wants to merge 1 commit into
base: scylla-3.x
Choose a base branch
from
Draft

docs: deprecate Java Driver 3.x and announce maintenance mode #919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# Scylla Java Driver for Scylla and Apache Cassandra®

> **Deprecation Notice:** Scylla Java Driver 3.x is now **deprecated** and has
> entered **maintenance mode**. Only critical bug fixes will be accepted.
> For new projects and active development, please migrate to
> [Scylla Java Driver 4.x](https://github.com/scylladb/java-driver/tree/scylla-4.x)
> ([documentation](https://java-driver.docs.scylladb.com/stable/)).

*If you're reading this on github.com, please note that this is the readme
for the development version and that some features described here might
not yet have been released. You can find the documentation for the latest
version through the [Java driver
docs](https://docs.scylladb.com/using-scylla/scylla-java-driver/) or via the release tags,
[e.g.
3.11.5.0](https://github.com/scylladb/java-driver/releases/tag/3.11.5.0).*
3.11.5.15](https://github.com/scylladb/java-driver/releases/tag/3.11.5.15).*

A modern, [feature-rich](manual/) and highly tunable Java client
library for Apache Cassandra (2.1+) and using exclusively Cassandra's binary protocol
Expand Down Expand Up @@ -73,7 +79,7 @@ it in your application using the following Maven dependency
<dependency>
<groupId>com.scylladb</groupId>
<artifactId>scylla-driver-core</artifactId>
<version>3.11.5.0</version>
<version>3.11.5.15</version>
</dependency>
```

Expand All @@ -83,7 +89,7 @@ Note that the object mapper is published as a separate artifact:
<dependency>
<groupId>com.scylladb</groupId>
<artifactId>scylla-driver-mapping</artifactId>
<version>3.11.5.0</version>
<version>3.11.5.15</version>
</dependency>
```

Expand All @@ -93,7 +99,7 @@ The 'extras' module is also published as a separate artifact:
<dependency>
<groupId>com.scylladb</groupId>
<artifactId>scylla-driver-extras</artifactId>
<version>3.11.5.0</version>
<version>3.11.5.15</version>
</dependency>
```

Expand All @@ -107,7 +113,7 @@ by running `dnf -y install libxcrypt-compat`

## Compatibility

The Java client driver 3.11.5.0 ([branch scylla-3.x](https://github.com/scylladb/java-driver/tree/scylla-3.x)) is compatible with
The Java client driver 3.11.5.15 ([branch scylla-3.x](https://github.com/scylladb/java-driver/tree/scylla-3.x)) is compatible with
Scylla and Apache Cassandra 2.1, 2.2, 3.0+.

UDT and tuple support is available only when using Apache Cassandra 2.1 or higher.
Expand Down
5 changes: 5 additions & 0 deletions changelog/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
3.x versions get published.
-->

### Deprecation Notice
- [notice] DRIVER-632: Java Driver 3.x is now deprecated and in maintenance mode. Only critical
bug fixes will be accepted. For new projects and active development, please migrate to
[Java Driver 4.x](https://java-driver.docs.scylladb.com/stable/).

### 3.11.5
- [improvement] JAVA-3114: Shade io.dropwizard.metrics:metrics-core in shaded driver
- [improvement] JAVA-3115: SchemaChangeListener#onKeyspaceChanged can fire when keyspace has not changed if using SimpleStrategy replication
Expand Down
5 changes: 5 additions & 0 deletions docs/source/_templates/notice.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<div class="notice notice--warning">
<p><strong>Deprecation Notice:</strong> ScyllaDB Java Driver 3.x is deprecated and in maintenance mode.
Only critical bug fixes will be accepted. Please migrate to
<a href="https://java-driver.docs.scylladb.com/stable/">ScyllaDB Java Driver 4.x</a>.</p>
</div>
<div class="notice">
<p>ScyllaDB Java Driver is available under the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache v2 License</a>.
ScyllaDB Java Driver is a fork of <a href="https://github.com/datastax/java-driver">DataStax Java Driver</a>.
Expand Down
7 changes: 6 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,12 @@
# 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',
]

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand Down
Loading