Skip to content

Commit

Permalink
Deprecation (#842)
Browse files Browse the repository at this point in the history
* Add deprecation structure

* Add deprecation pages to TOC

* Unlist introductory content

* Remove unnecessary committed file

* Programmatically add noindex and norobots to all pages

* Add deprecation content

* Minor wording update for Edge Server
  • Loading branch information
krollins-mdb authored Sep 9, 2024
1 parent b44a920 commit ef7207d
Show file tree
Hide file tree
Showing 322 changed files with 1,238 additions and 14 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

This repository contains documentation for MongoDB Atlas App Services.

> [!WARNING]
> As of September 2024, the following App Services features are deprecated:
>
> - Authentication
> - Device Sync
> - Data API and HTTPS Endpoints
> - Edge Server
>
> 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

The MongoDB Documentation Project is governed by the terms of the
Expand Down
15 changes: 7 additions & 8 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ intersphinx = [
"https://www.mongodb.com/docs/manual/objects.inv",
"https://www.mongodb.com/docs/atlas/objects.inv",
"https://www.mongodb.com/docs/atlas/device-sdks/objects.inv",
"https://www.mongodb.com/docs/compass/current/objects.inv"
"https://www.mongodb.com/docs/compass/current/objects.inv",
]

# These are the pages that open when you click on them (instead of just being containers)
Expand Down Expand Up @@ -89,24 +89,23 @@ min-user-session-refresh-token-expiration-time = "30 minutes"
max-user-session-refresh-token-expiration-time = "5 years"
default-user-session-refresh-token-expiration-time = "60 days"

# 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 Sync, Atlas Edge Server, Data API, and Custom Endpoints are deprecated. Refer to the ref:`deprecation page for details <app-services-deprecation>`.\
"""

[[banners]]
targets = ["hosting/*.txt"]
targets = ["admin/*.txt"]
variant = "warning"
value = """\
Static Hosting is deprecated. :ref:`Learn More <migrate-hosting-graphql>`.\
Atlas Device Sync, Atlas Edge Server, Data API, Custom Endpoints, GraphQL, and Static Hosting are deprecated. Endpoints related to these features are also deprecated.\
"""

[[banners]]
targets = ["graphql/*.txt"]
targets = ["cli/*.txt"]
variant = "warning"
value = """\
GraphQL is deprecated. :ref:`Learn More <migrate-hosting-graphql>`.\
Atlas Device Sync, Atlas Edge Server, Data API, Custom Endpoints, GraphQL, and Static Hosting are deprecated. Commands related to these features are also deprecated.\
"""
3 changes: 0 additions & 3 deletions source/.vscode/settings.json

This file was deleted.

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

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

.. _alerts:

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

.. _forward-logs:

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

.. _view-logs:

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

:orphan:
:template: openapi
:title: Atlas App Services Admin API
Expand Down
4 changes: 3 additions & 1 deletion source/apps.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:robots: noindex, nosnippet

.. _deploy:

=====================
Expand All @@ -9,7 +12,6 @@ Develop & Deploy Apps
:caption: Manage & Deploy Apps
:hidden:

Create an App </apps/create>
Get App Metadata </apps/metadata>
Update an App </apps/update>
Copy an App </apps/copy>
Expand Down
3 changes: 3 additions & 0 deletions source/apps/change-deployment-models.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:robots: noindex, nosnippet

.. _change-deployment-models:

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

.. _ci-cd-pipeline:

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

.. _copy-app:
.. _copy-realm-app:

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

.. _create-app:
.. _create-a-realm-app:

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

.. _delete-an-app:

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

.. _deploy-github:

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

.. _deployment-model:
.. _deployment-region:

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

.. _app-environment:

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

.. _export-app:

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

.. _app-metadata:

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

.. _rollback-deployments:

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

.. _import-realm-app:
.. _update-realm-app:

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

.. _authentication-providers:

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

.. _anonymous-authentication:

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

.. _api-key-authentication:

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

.. _apple-id-authentication:

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

.. _custom-function-authentication:

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

.. _custom-jwt-authentication:

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

.. _email-password-authentication:

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

.. _facebook-authentication:

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

.. _custom-jwt-authentication-firebase:

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

.. _google-authentication:

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

.. _custom-jwt-authentication-okta:

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

.. _billing:

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

.. _appservices-cli:

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

.. _appservices-accessList-create:

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

.. _appservices-accessList-delete:

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

.. _appservices-accessList-list:

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

.. _appservices-accessList-update:

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

.. _appservices-accessList:

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

.. _appservices-apps-create:

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

.. _appservices-apps-delete:

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

.. _appservices-apps-describe:

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

.. _appservices-apps-diff:

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

.. _appservices-apps-init:

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

.. _appservices-apps-list:

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

.. _appservices-apps:

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

.. _appservices-deploy-configure:

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

.. _appservices-deploy-describe:

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

.. _appservices-deploy-disable:

==========================
Expand Down
Loading

0 comments on commit ef7207d

Please sign in to comment.