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.

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

Deprecation #3377

Merged
merged 8 commits into from
Sep 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
11 changes: 11 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,17 @@ MongoDB Realm Documentation

This repository contains documentation for MongoDB Realm.

> [!WARNING]
> As of September 2024, Atlas Device SDKs are deprecated. Atlas Device SDKs
> will reach end-of-life and be removed on September 30, 2025.
>
> These services will reach end-of-life and be removed on September 30, 2025.
>
> With the previously-announced GraphQL and Static Hosting deprecations, all of
> the documentation in this repository is also deprecated. The documentation will
> be updated on a best-effort basis until September 30, 2025. After that date,
> the documentation will no longer be maintained.

Contribute
----------

Expand Down
4 changes: 2 additions & 2 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ sync-short = "Device Sync"
# Realm Rebrand announcement for .local London
[[banners]]
targets = ["*"]
variant = "info"
variant = "warning"
value = """\
Realm is now Atlas Device SDK – `Learn More <http://www.mongodb.com/blog/post/realm-now-part-atlas-platform>`__ \
Atlas Device SDKs are deprecated. Refer to the :ref:`deprecation page <device-sdks-deprecation>` for details. \
"""
38 changes: 38 additions & 0 deletions source/deprecation.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
.. meta::
:robots: noindex, nosnippet

.. _device-sdks-deprecation:

=============================
Atlas Device SDKs Deprecation
=============================

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

As of September 2024, Atlas Device SDKs are deprecated. Atlas Device SDKs will
reach end-of-life and be removed on **September 30, 2025**.

The Atlas Device SDKs are made up of two parts: the on-device database and
Atlas Device Sync. The on-device database will continue to exist as an open
source project.

Atlas Device Sync is deprecated. This means that apps built using Sync need to
move to an alternative solution or remove Sync before September 30, 2025. Refer
to the :ref:`App Services deprecation page <app-services-deprecation>` for more
information.

Device SDKs Community Branches
------------------------------

The Device SDKs will have community branches that remove Device Sync code from
their codebases. Learn more in the SDKs' README files:

- `Flutter <https://github.com/realm/realm-dart>`__
- `Kotlin <https://github.com/realm/realm-kotlin>`__
- `.NET <https://github.com/realm/realm-dotnet>`__
- `JavaScript <https://github.com/realm/realm-js>`__
- `Swift <https://github.com/realm/realm-swift>`__
3 changes: 3 additions & 0 deletions source/example-projects.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:robots: noindex, nosnippet

.. _realm-examples:

=================================
Expand Down
3 changes: 3 additions & 0 deletions source/help.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:robots: noindex, nosnippet

.. _getting-help:

========
Expand Down
11 changes: 5 additions & 6 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
:hidefeedback: header
:noprevnext:

.. meta::
:robots: noindex, nosnippet


====================================
Welcome to the Atlas Device SDK Docs
====================================
Expand All @@ -13,7 +17,7 @@ Welcome to the Atlas Device SDK Docs
:titlesonly:
:hidden:

Introduction </introduction>
Device SDKs Deprecation </deprecation>
C++ SDK </sdk/cpp>
Flutter SDK </sdk/flutter>
Java SDK </sdk/java>
Expand All @@ -23,7 +27,6 @@ Welcome to the Atlas Device SDK Docs
React Native SDK </sdk/react-native>
Swift SDK </sdk/swift>
Web SDK </web>
Atlas App Services <https://mongodb.com/docs/atlas/app-services>
Realm Studio </studio>
Realm Query Language </realm-query-language>
Example Projects </example-projects>
Expand All @@ -38,8 +41,6 @@ Welcome to the Atlas Device SDK Docs
.. button:: Get started with a tutorial
:uri: https://mongodb.com/docs/atlas/app-services/get-started/

:doc:`Read the 5-Minute Introduction <introduction>`

.. image:: /images/hero.png
:alt: Atlas Device SDK landing page hero image
:class: hero-img
Expand Down Expand Up @@ -144,5 +145,3 @@ SDK is language-idiomatic and includes:
:icon-alt: C++ SDK icon

Build applications in C++. Access data stored in realms and sync data with Atlas.

For legacy (pre-v10) Realm Documentation, see https://www.mongodb.com/docs/realm-legacy/docs/.
Loading
Loading