Skip to content
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

DOCS-33261: Add note that Java SDK is in Maintenance Mode #3061

Merged
merged 5 commits into from
Oct 31, 2023
Merged

DOCS-33261: Add note that Java SDK is in Maintenance Mode #3061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c873fd3
Add note to Java SDK
cbullinger Oct 30, 2023
fdda8cc
Move note to fix collision with banner
cbullinger Oct 30, 2023
2185bc9
Redo note as section on landing page
cbullinger Oct 30, 2023
2a6e783
Try note in a container
cbullinger Oct 30, 2023
27ec16c
just kidding - putting back as a section
cbullinger Oct 30, 2023
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
8 changes: 8 additions & 0 deletions source/includes/note-java-maintenance-mode.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. note:: Java SDK in Maintenance Mode

The Java SDK is in best-effort maintenance mode and **no longer receives
new development or non-critical bug fixes**. To develop your app with new
features, use the :ref:`Kotlin SDK <kotlin-intro>`. You can use the Java SDK
with the Kotlin SDK in the same project.

Learn more about how to :ref:`<kotlin-migrate-from-java-sdk-to-kotlin-sdk>`.
11 changes: 11 additions & 0 deletions source/sdk/java.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,21 @@ Realm Java SDK
:depth: 2
:class: singlecol


Use the Realm Java SDK to develop Android apps in Java or Kotlin. To develop
multiplatform apps using Kotlin Multiplatform (KMP), refer to the
:ref:`Realm Kotlin SDK <kotlin-intro>`.

SDK in Maintenance Mode
-----------------------

This SDK is in best-effort maintenance mode and **no longer receives
new development or non-critical bug fixes**. To develop your app with new
features, use the :ref:`Kotlin SDK <kotlin-intro>`. You can use the Java SDK
with the Kotlin SDK.

Learn more about how to :ref:`<kotlin-migrate-from-java-sdk-to-kotlin-sdk>`.

.. kicker:: What You Can Do

Develop Apps with Realm
Expand Down
10 changes: 9 additions & 1 deletion source/sdk/java/install.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,20 @@ Install Realm - Java SDK
:depth: 2
:class: singlecol

.. include:: /includes/note-java-maintenance-mode.rst

Overview
--------

This page details how to install Realm in your project
This page details how to install Realm using the Java SDK in your project
and get started.

You can use multiple SDKs in your project. Because the Java SDK is no longer
receiving new development, this is useful if you want to
use new features in your app. For example, you can add Atlas
Device Sync's :ref:`Data Ingest <optimize-data-ingest>` feature to your
app using the Kotlin SDK while continuing to use Java for everything else.

Prerequisites
-------------

Expand Down