(DOCSP-23676): Source constant, admonition, term cleanup (mongodb#2034)

Author: nathan-contino-mongo

snooty.toml

@@ -44,29 +44,6 @@ toc_landing_pages = [
 atlas = "Atlas"
 
 [constants]
-realm = "realm"
-realms = "realms"
-client-database = "Realm Database"
-client-db-short = "Realm"
-atlas = "MongoDB Atlas"
-atlas-short = "Atlas"
-compass = "MongoDB Compass"
-compass-short = "Compass"
-charts = "MongoDB Charts"
-charts-short = "Charts"
-service = "Realm" # product (backend + sdks)
-service-short = "Realm" # use as shorthand, AND as a prefix for features
-backend = "Atlas App Services"
-backend-short = "App Services"
-sync = "Atlas Device Sync"
-sync-short = "Sync" # feature/product name, NOT verb
-backend-schema = "Realm Schema"
-frontend-schema = "Realm Object Model"
-cli-bin = ":binary:`realm-cli`" # binary -- DO NOT USE IN LINKS! Will break them.
-cli = "Realm CLI"
-ui = "Atlas App Services UI"
-app = "App"
-leftnav = "left navigation menu"
 admin-api-page = "/admin/api/v3/#"
 base-url = "https://www.mongodb.com/docs/realm"
 kotlin-sdk-version = "1.0.1"
@@ -77,4 +54,3 @@ java-sdk-version = "10.11.1"
 max-graphql-resolvers = "ten"
 max-graphql-relationship-depth = "five"
 log-retention-time = "10 days"
-encrypted-interprocess-sharing-error-message = "Encrypted interprocess sharing is currently unsupported."

source/glossary.txt

@@ -12,17 +12,15 @@ Get Help
    :depth: 1
    :class: singlecol
 
-
-
 Overview
 --------
 
-{+service+} provides various resources for getting help with your {+app+}.
+MongoDB provides various resources for getting help with App Services.
 
 Professional Support
 --------------------
 
-MongoDB offers professional support for {+service+} and Atlas. Paid
+MongoDB offers professional support for App Services and Atlas. Paid
 support includes help with training, upgrades, and general technical
 support for issues in your database or app. We strongly recommend
 MongoDB's professional support for production apps and mission-critical
@@ -39,7 +37,7 @@ Community Forums
 The official `MongoDB Community Forums
 <https://www.mongodb.com/community/forums/c/realm/9>`__ are a great
 place to meet other developers, ask and answer questions, and stay
-up-to-date with the latest Realm features and releases. You can also
+up-to-date with the latest Realm and App Services features and releases. You can also
 interact with MongoDB employees, like our community team, engineers, and
 product managers, who are active forum contributors.
 
@@ -48,7 +46,7 @@ Stack Overflow
 
 MongoDB monitors & answers questions with the ``realm`` tag on Stack
 Overflow, a forum to ask programming questions and get help with
-specific errors. `Ask a {+service-short+} related question
+specific errors. `Ask a Realm related question
 <https://stackoverflow.com/questions/ask?tags=realm>`_ or read through
 the `existing questions
 <https://stackoverflow.com/questions/tagged/realm?sort=Newest&edited=true>`_.
@@ -57,7 +55,7 @@ Feature Requests
 ----------------
 
 To request a feature, check the status of your feedback, or see top feature
-requests from other users, check out the `MongoDB Feedback Engine for {+service-short+} <https://feedback.mongodb.com/forums/923521-realm>`_. 
+requests from other users, check out the `MongoDB Feedback Engine for Realm <https://feedback.mongodb.com/forums/923521-realm>`_. 
 
 Bug Reporting, and Changelogs
 -----------------------------

source/help.txt

@@ -6,7 +6,7 @@
 
 If your project was already using `Fody
 <https://github.com/Fody/Fody>`__, you must manually add the
-{+service-short+} weaver to your ``FodyWeavers.xml`` file. When done,
+Realm weaver to your ``FodyWeavers.xml`` file. When done,
 your ``FodyWeavers.xml`` file should look something like
 this:
 

source/includes/add-realm-fody-weaver.rst

@@ -8,7 +8,7 @@ Use your MongoDB Cloud API key pair to call the authentication endpoint:
      --data '{"username": "<Public API Key>", "apiKey": "<Private API Key>"}' \
      https://realm.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login
 
-If authentication succeeds, {+backend+} returns an access token as part of
+If authentication succeeds, App Services returns an access token as part of
 the JSON response document:
 
 .. code-block:: json

source/includes/api-authenticate-instructions.rst

@@ -1,4 +1,4 @@
-To find an Application ID, make a request to the {+service-short+}
+To find an Application ID, make a request to the App Services
 :admin-api-endpoint:`GET /groups/{groupid}/apps <operation/adminListApplications>` API endpoint.
 
 This request has the following format, referencing the ``access_token`` and the Group ID:
@@ -9,7 +9,7 @@ This request has the following format, referencing the ``access_token`` and the
      --header 'Authorization: Bearer <access_token>' \
      https://realm.mongodb.com/api/admin/v3.0/groups/{groupId}/apps
 
-This will return a list of objects describing each {+app+} in the provided
+This will return a list of objects describing each App in the provided
 group. For Admin API requests, your Application ID is the ObjectId value in the
 ``_id`` field, *not* the ``client_app_id``.
 

source/includes/api-get-application-id.rst

@@ -3,17 +3,17 @@
    The following diagram illustrates the commit process:
 
    .. figure:: /images/mvcc-diagram.png
-      :alt: {+client-database+} copies the relevant part of the tree for writes, then replaces the latest version by updating a pointer.
+      :alt: Realm Database copies the relevant part of the tree for writes, then replaces the latest version by updating a pointer.
       :lightbox:
 
-   1. The {+realm+} is structured as a tree. The {+realm+} has a pointer
+   1. The realm is structured as a tree. The realm has a pointer
       to its latest version, V1.
 
-   #. When writing, {+client-database+} creates a new version V2 based on V1.
-      {+client-database+} makes copies of objects for modification (A\ :sup:`1`,
+   #. When writing, Realm Database creates a new version V2 based on V1.
+      Realm Database makes copies of objects for modification (A\ :sup:`1`,
       C\ :sup:`1`),  while links to unmodified objects continue to
       point to the original versions (B, D).
 
-   #. After validating the commit, {+client-database+} updates the {+realm+}'s
-      pointer to the new latest version, V2. {+client-database+} then discards
+   #. After validating the commit, Realm Database updates the realm's
+      pointer to the new latest version, V2. Realm Database then discards
       old nodes no longer connected to the tree.

source/includes/commit-process-diagram.rst

@@ -1,11 +1,11 @@
 .. warning:: Custom Data May Be Stale
 
-   {+backend+} does not dynamically update a user's custom data if the
-   underlying document changes. Instead, {+backend+} fetches a new copy
+   App Services does not dynamically update a user's custom data if the
+   underlying document changes. Instead, App Services fetches a new copy
    of the data whenever a user refreshes their access token, such as
    when they log in. This may mean that the custom data won't
    immediately reflect changes, e.g. updates from an authentication
-   Trigger. If the token is not refreshed, {+service-short+} waits 
+   Trigger. If the token is not refreshed, the SDK waits 
    30 minutes and then refreshes it on the next call to the backend, so custom user 
    data could be stale for up to 30 minutes plus the time until the next SDK 
    call to the backend occurs.

source/includes/custom-data-may-be-stale.rst

@@ -42,7 +42,7 @@ required, depending on whether you are linking a Data Lake or a cluster.
 
    * - | ``id``
        | String
-     - A string that uniquely identifies the service. {+service-short+}
+     - A string that uniquely identifies the service. App Services
        automatically generates a unique ID for a MongoDB service when you create
        it.
 

source/includes/data-source-configuration.rst

@@ -3,7 +3,7 @@
    :widths: 1 4
 
    * - Region
-     - {+service-short+} Authentication Callback URL
+     - App Services Authentication Callback URL
 
    * - | **Global**
      - .. code-block:: text

source/includes/deployment-region-auth-callback-urls.rst

@@ -1,5 +1,5 @@
 .. warning::
 
-   Do not use cryptographically-weak hashes for {+realm+} encryption keys. 
+   Do not use cryptographically-weak hashes for realm encryption keys. 
    For optimal security, we recommend generating random rather than derived 
    encryption keys.

source/includes/encrypt-use-strong-cryptographic-hash.rst

@@ -1,17 +1,17 @@
 Initialize Realm
 ----------------
 
-Before you can use {+service-short+} in your app, you must
-initialize the {+service-short+} library. Your application should
-initialize {+service-short+} just once each time the application runs.
+Before you can use Realm in your app, you must
+initialize the Realm library. Your application should
+initialize Realm just once each time the application runs.
 
-To initialize the {+service-short+} library, provide an Android
+To initialize the Realm library, provide an Android
 ``context`` to the ``Realm.init()`` static function. You can provide
 an Activity, Fragment, or Application ``context`` for initialization with no
-difference in behavior. You can initialize the {+service-short+} library
+difference in behavior. You can initialize the Realm library
 in the ``onCreate()`` method of an `application subclass
 <https://developer.android.com/reference/android/app/Application>`__ to
-ensure that you only initialize {+service-short+} once each time the
+ensure that you only initialize Realm once each time the
 application runs.
 
 .. tabs-realm-languages::

source/includes/java-initialize-realm.rst

@@ -1,8 +1,8 @@
-To open a synced {+realm+}, call 
+To open a synced realm, call 
 :java-sdk:`getInstanceAsync()
 <io/realm/Realm.html#getInstanceAsync-io.realm.RealmConfiguration-io.realm.Realm.Callback->`, 
 passing in a :java-sdk:`SyncConfiguration <io/realm/mongodb/sync/SyncConfiguration.html>` 
-object. The following code demonstrates how to create a {+realm+} with 
+object. The following code demonstrates how to create a realm with 
 specific sync settings created using a ``SyncConfiguration`` object:
 
 .. tabs-realm-languages::
@@ -21,17 +21,17 @@ specific sync settings created using a ``SyncConfiguration`` object:
          :language: java
          :copyable: false
 
-The code above shows how to open the {+realm+} *asynchronously* 
+The code above shows how to open the realm *asynchronously* 
 by using :java-sdk:`getInstanceAsync()
 <io/realm/Realm.html#getInstanceAsync-io.realm.RealmConfiguration-io.realm.Realm.Callback->`. 
-You can also open a {+realm+} synchronously by using :java-sdk:`getInstance()
+You can also open a realm synchronously by using :java-sdk:`getInstance()
 <io/realm/Realm.html#getInstance-io.realm.RealmConfiguration->`, which
-returns an open {+realm+} before synchronizing all data from the backend.
+returns an open realm before synchronizing all data from the backend.
 However, this may lead to temporary data inconsistencies while the
 remote data is downloaded, and is generally not recommended. You can
 use the :java-sdk:`waitForInitialRemoteData() <io/realm/mongodb/sync/SyncConfiguration.Builder.html#waitForInitialRemoteData-->`
 configuration option to force the SDK to fetch remote data before
-opening the {+realm+} to avoid these inconsistencies.
+opening the realm to avoid these inconsistencies.
 
 The :ref:`partition value <partition-value>` specifies which subset of your data to sync.
 This is typically a user ID, project ID, store ID, or some other category identifier in

source/includes/java-open-synced-realm.rst

@@ -1,4 +1,4 @@
-{+service+}'s Java SDK enables you to build apps for the
+Realm's Java SDK enables you to build apps for the
 following platforms:
 
 - Android

source/includes/java-sdk-supported-platforms.rst

@@ -1,6 +1,6 @@
 .. important:: Synchronous Reads and Writes on the UI Thread
 
-   By default, you can only read or write to a {+realm+} in your
+   By default, you can only read or write to a realm in your
    application's UI thread using
    :ref:`asynchronous transactions <java-async-api>`. That is,
    you can only use ``Realm`` methods whose name ends with the word
@@ -12,7 +12,7 @@
    unresponsive or slow UI interactions, so it's usually best to handle
    these operations either asynchronously or in a background thread.
    However, if your application requires the use of synchronous
-   {+realm+} reads or writes on the UI thread, you can explicitly allow
+   realm reads or writes on the UI thread, you can explicitly allow
    the use of synchronous methods with the following
    ``SyncConfiguration`` options:
 

source/includes/java-synchronous-reads-writes-ui-thread.rst

@@ -1,5 +1,5 @@
 It is important to remember to call the ``close()`` method when done with a
-{+realm+} instance to avoid memory leaks.
+realm instance to avoid memory leaks.
 
 .. literalinclude:: /examples/generated/node/open-and-close-a-local-realm.snippet.close-local-realm.js
   :language: javascript

source/includes/js-close-a-realm.rst

@@ -1,4 +1,4 @@
-To open a local (non-synced) {+realm+}, pass a :js-sdk:`Realm.Configuration
+To open a local (non-synced) realm, pass a :js-sdk:`Realm.Configuration
 <Realm.html#~Configuration>` object to the asynchronous method :js-sdk:`Realm.open()
 <Realm.html#.open>`.
 

source/includes/js-open-a-local-realm.rst

@@ -9,5 +9,5 @@ add ``inMemory: true`` to your :js-sdk:`Realm.Configuration
 
 .. note:: 
 
-   In-memory {+realms+} may use disk space if memory is running low, but files
-   created by an in-memory {+realm+} are deleted when you close the {+realm+}.
+   In-memory realms may use disk space if memory is running low, but files
+   created by an in-memory realm are deleted when you close the realm.

source/includes/js-open-an-in-memory-realm.rst

@@ -1,7 +1,7 @@
 .. warning::
 
    When a user logs out, you can no longer read or write data in any
-   synced {+realm+}s that the user opened. As a result, any operation
+   synced realms that the user opened. As a result, any operation
    that has not yet completed before the initiating user logs out cannot
    complete successfully and will likely result in an error. Any data in
    a write operation that fails in this way will be lost.

source/includes/log-out-queries-in-progress.rst

@@ -1,5 +1,5 @@
 .. note:: MongoDB Version 4.4 or Higher Required
 
-   In order to use {+sync+}, your Atlas cluster must use MongoDB version 4.4 or higher.
+   In order to use Device Sync, your Atlas cluster must use MongoDB version 4.4 or higher.
    When setting up your cluster, select :guilabel:`MongoDB 4.4` (or a higher version)
    from the dropdown menu under :guilabel:`Additional Settings`.

source/includes/mongodb-4.4-required-for-sync-admonition.rst

@@ -1,4 +1,4 @@
-To open a {+realm+} with Partition-Based Sync, call :js-sdk:`Realm.open() <Realm.html#.open>`. 
+To open a realm with Partition-Based Sync, call :js-sdk:`Realm.open() <Realm.html#.open>`. 
 Pass in a :js-sdk:`Configuration <Realm.html#~Configuration>`
 object, which must include the ``sync`` property defining a 
 :js-sdk:`SyncConfiguration <Realm.App.Sync.html#~SyncConfiguration>` object. 

source/includes/node-open-a-synced-realm.rst

@@ -1,6 +1,6 @@
 .. important::
 
-   {+service+} evaluates and applies filters before it reads any
+   App Services evaluates and applies filters before reading any
    documents, so you cannot use :ref:`MongoDB document expansions
    <mongodb-document-expansions>` in a filter's Apply When expression.
    However, you can use other expansions like :json-expansion:`%%user`,

source/includes/note-filters-no-mongodb-expansions.rst

@@ -1,5 +1,5 @@
 .. note:: Flexible Sync Prerequisites
 
-   Enabling Flexible Sync in Your {+service-short+} Application requires a
-   non-sharded {+atlas+} cluster running :manual:`MongoDB 5.0 or greater
+   Enabling Flexible Sync in your App requires a
+   non-sharded Atlas cluster running :manual:`MongoDB 5.0 or greater
    </release-notes/>`

source/includes/note-flexible-sync-prerequisite.txt

@@ -1,8 +1,8 @@
 .. note:: Get Schema from UI if Development Mode Disabled
 
-   If you have enabled {+sync-short+} but turned off Development Mode,
-   you can copy and paste the object model definitions that {+backend-short+}
-   generated for you from the :guilabel:`SDKs` tab in the {+ui+}.
+   If you have enabled Sync but turned off Development Mode,
+   you can copy and paste the object model definitions that App Services
+   generated for you from the :guilabel:`SDKs` tab in the App Services UI.
    You must re-enable Development Mode if you want to make changes to the
    object model definition from client side code.
 

source/includes/note-get-schema-ui-dev-mode-disabled.rst

@@ -1,5 +1,5 @@
 .. note:: Modify Schema Properties of a Synced Realm
 
    The following page demonstrates how to modify schema properties of a local
-   {+realm+}. Learn how to :ref:`modify schema properties of a synced realm
+   realm. Learn how to :ref:`modify schema properties of a synced realm
    <synced-schema-overview>`.

source/includes/note-modify-schema-properties-of-synced-realms.rst

@@ -1,6 +1,6 @@
 When your Realm application authenticates a user, it caches the user's 
 credentials. You can check for existing user credentials to bypass the 
-login flow and access the cached user. Use this to open a {+realm+} offline. 
+login flow and access the cached user. Use this to open a realm offline. 
 
 .. note:: Initial login requires a network connection
 

source/includes/offline-login.rst

@@ -4,5 +4,5 @@ application-scale development more robust. If you'd like to
 use TypeScript in your project, follow the React Native
 team's official `TypeScript and React Native guide
 <https://facebook.github.io/react-native/docs/typescript#adding-typescript-to-an-existing-project>`__.
-{+service-short+} supports TypeScript natively and integrates easily
+Realm supports TypeScript natively and integrates easily
 into a TypeScript project.