DOCSP-26498 - Standardize MongoDB Server Naming (#399)

mongoKart · mongoKart · commit cc860b5a768e · 2023-05-05T16:11:21.000-05:00
(cherry picked from commit a460fec)
diff --git a/snooty.toml b/snooty.toml
@@ -11,9 +11,10 @@ toc_landing_pages = [
 sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
 
 [constants]
+<<<<<<< HEAD
 version = 4.3
 full-version = "{+version+}.4"
-mdb-server = "MongoDB server"
+mdb-server = "MongoDB Server"
 
 package-name-org = "mongodb-org"
 api = "https://mongodb.github.io/mongo-java-driver/{+version+}"
diff --git a/source/fundamentals/auth.txt b/source/fundamentals/auth.txt
@@ -19,7 +19,7 @@ Overview
 
 In this guide, you can learn how to authenticate with MongoDB using each
 **authentication mechanism** available in the MongoDB Community Edition.
-Authentication mechanisms are processes by which the driver and server
+Authentication mechanisms are processes by which the driver and MongoDB deployment
 confirm identity and establish trust to ensure security.
 
 The mechanisms that you can use with the latest version of MongoDB Community
@@ -51,23 +51,24 @@ Default
 ~~~~~~~
 
 The default authentication mechanism setting uses one of the following
-authentication mechanisms depending on what your MongoDB server supports:
+authentication mechanisms depending on what your version of {+mdb-server+} 
+supports:
 
 #. ``SCRAM-SHA-256``
 #. ``SCRAM-SHA-1``
 #. ``MONGODB-CR``
 
 Server versions 3.6 and earlier use ``MONGODB-CR`` as the default
-mechanism. Newer versions of the server use one of the mechanisms for
+mechanism. Newer versions of {+mdb-server+} use one of the mechanisms for
 which they advertise support.
 
 The following code snippets show how to specify the authentication mechanism,
 using the following placeholders:
 
 * ``username`` - your MongoDB username
 * ``password`` - your MongoDB user's password
-* ``hostname`` - network address of your MongoDB server, accessible by your client
-* ``port`` - port number of your MongoDB server
+* ``hostname`` - network address of your MongoDB deployment, accessible by your client
+* ``port`` - port number of your MongoDB deployment
 * ``authenticationDb`` - MongoDB database that contains your user's
   authentication data. If you omit this parameter, the driver uses the
   default value ``admin``.
@@ -102,7 +103,8 @@ mechanism:
 
 For more information on the challenge-response (CR) and salted
 challenge-response authentication mechanisms (SCRAM) that MongoDB supports,
-see the :manual:`SCRAM </core/security-scram/>` section of the server manual.
+see the :manual:`SCRAM </core/security-scram/>` section of the {+mdb-server+}
+manual.
 
 .. _scram-sha-256-auth-mechanism:
 
@@ -123,8 +125,8 @@ using the following placeholders:
 
 * ``username`` - your MongoDB username.
 * ``password`` - your MongoDB user's password.
-* ``hostname`` - network address of your MongoDB server, accessible by your client.
-* ``port`` - port number of your MongoDB server.
+* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
+* ``port`` - port number of your MongoDB deployment.
 * ``authenticationDb`` - MongoDB database that contains your user's
   authentication data. If you omit this parameter, the driver uses the
   default value ``admin``.
@@ -175,8 +177,8 @@ using the following placeholders:
 
 * ``username`` - your MongoDB username.
 * ``password`` - your MongoDB user's password.
-* ``hostname`` - network address of your MongoDB server, accessible by your client.
-* ``port`` - port number of your MongoDB server.
+* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
+* ``port`` - port number of your MongoDB deployment.
 * ``authenticationDb`` - MongoDB database that contains your user's
   authentication data. If you omit this parameter, the driver uses the
   default value ``admin``.
@@ -357,8 +359,8 @@ the subject name of the client certificate.
 The following code snippets show how to specify the authentication mechanism,
 using the following placeholders:
 
-* ``hostname`` - network address of your MongoDB server, accessible by your client.
-* ``port`` - port number of your MongoDB server.
+* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
+* ``port`` - port number of your MongoDB deployment.
 * ``authenticationDb`` - MongoDB database that contains your user's
   authentication data. If you omit this parameter, the driver uses the
   default value ``admin``.
diff --git a/source/fundamentals/connection/connect.txt b/source/fundamentals/connection/connect.txt
@@ -97,7 +97,7 @@ method. Chain the ``applyConnectionString()`` method to the builder to specify y
 connection URI.
 
 You can set the {+stable-api+} version client option to avoid
-breaking changes when you upgrade to a new server version. To 
+breaking changes when you upgrade to a new version of {+mdb-server+}. To 
 learn more about the {+stable-api+} feature, see the :ref:`{+stable-api+} page
 <stable-api-java>`.
 
@@ -114,18 +114,18 @@ deployment on Atlas and verify that the connection is successful:
 Other Ways to Connect to MongoDB
 --------------------------------
 
-If you are connecting to a single MongoDB server instance or replica set
+If you are connecting to a single MongoDB deployment or replica set
 that is not hosted on Atlas, see the following sections to find out how to
 connect.
 
 .. _connect-local-java-driver:
 
-Connect to a MongoDB Server on Your Local Machine
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Connect to a MongoDB Deployment on Your Local Machine
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. include:: /includes/fundamentals/localhost-connection.rst
 
-To test whether you can connect to your server, replace the connection
+To test whether you can connect to your deployment, replace the connection
 string in the :ref:`Connect to MongoDB Atlas <connect-atlas-java-driver>` code
 example and run it.
 
diff --git a/source/fundamentals/connection/mongoclientsettings.txt b/source/fundamentals/connection/mongoclientsettings.txt
@@ -220,17 +220,22 @@ settings to modify the driver's behavior:
    * - ``applySettings()``
      - Uses the cluster settings specified in a ``ClusterSettings`` object.
 
-   * - ``hosts​()``
-     - Sets all the specified locations of a Mongo server.
+   * - ``hosts()``
+     - Sets all the specified locations of a Mongo deployment.
 
    * - ``localThreshold()``
      - | Sets the amount of time that a server’s round trip can take and still
          be eligible for server selection.
        |
        | **Default**: ``15 milliseconds``
 
+<<<<<<< HEAD
    * - ``mode​()``
      - Sets how to connect to a MongoDB server.
+=======
+   * - ``mode()``
+     - Sets how to connect to a MongoDB deployment.
+>>>>>>> a460fec (DOCSP-26498 - Standardize MongoDB Server Naming (#399))
 
    * - ``requiredClusterType()``
      - Sets the type of cluster required for the cluster.
@@ -377,7 +382,7 @@ Server Settings
 
 Chain the `applyToServerSettings() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToServerSettings(com.mongodb.Block)>`__
 method to modify the driver's behavior when monitoring each MongoDB
-server.
+deployment.
 
 The following table describes the methods you can chain to your
 settings to modify the driver's behavior:
@@ -414,7 +419,7 @@ settings to modify the driver's behavior:
 Example
 ~~~~~~~
 
-This example specifies the following driver behavior in a MongoDB server:
+This example specifies the following driver behavior in a MongoDB deployment:
 
 - The minimum interval for server monitoring checks to be at least
   ``700 MILLISECONDS``
@@ -434,7 +439,7 @@ Socket Settings
 
 Chain the `applyToSocketSettings() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToSocketSettings(com.mongodb.Block)>`__
 method to modify the driver's behavior when connecting and communicating
-with your MongoDB server.
+with your MongoDB deployment.
 
 The following table describes all the methods you can chain to your settings
 to modify the driver's behavior:
diff --git a/source/fundamentals/connection/tls.txt b/source/fundamentals/connection/tls.txt
@@ -144,7 +144,7 @@ genuine and secure from tampering by third parties.
 
 An application that initiates TLS/SSL requests needs to set two JVM system
 properties to ensure that the client presents a TLS/SSL certificate to
-the MongoDB server:
+the MongoDB deployment:
 
 - ``javax.net.ssl.keyStore``: the path to a key store containing the client's
   TLS/SSL certificates
diff --git a/source/fundamentals/crud/read-operations/cursor.txt b/source/fundamentals/crud/read-operations/cursor.txt
@@ -41,7 +41,7 @@ to see by setting parameters through methods.
 Terminal Methods
 ----------------
 
-Terminal methods execute an operation on the MongoDB server after
+Terminal methods execute an operation on the MongoDB deployment after
 configuring all parameters of an ``Iterable`` instance controlling the
 operation.
 
@@ -196,9 +196,9 @@ Cursor Cleanup
 Close
 ~~~~~
 
-Use the ``close()`` method in a finally block to free up a cursor's
+Use the ``close()`` method in a ``finally`` block to free up a cursor's
 consumption of resources in both the client application and the MongoDB
-server:
+deployment:
 
 .. literalinclude:: /includes/fundamentals/code-snippets/Cursor.java
    :language: java
@@ -211,7 +211,7 @@ Try with Resources Statement
 
 Use a try-with-resources statement
 to automatically free up a cursor's consumption of resources in both the
-client application and the MongoDB server:
+client application and the MongoDB deployment:
 
 .. literalinclude:: /includes/fundamentals/code-snippets/Cursor.java
    :language: java
diff --git a/source/fundamentals/crud/read-operations/geo.txt b/source/fundamentals/crud/read-operations/geo.txt
@@ -134,7 +134,7 @@ For more information on the ``Indexes`` builder, see our
 :doc:`guide on the Indexes builder </fundamentals/builders/indexes>`. 
    
 For more information on legacy coordinate pairs, see the
-:manual:`MongoDB server manual page on legacy coordinate pairs </geospatial-queries/#legacy-coordinate-pairs>`.
+:manual:`{+mdb-server+} manual page on legacy coordinate pairs </geospatial-queries/#legacy-coordinate-pairs>`.
 
 .. external resource
 
@@ -301,6 +301,6 @@ For more information on the ``$geoWithin`` operator, see the
 .. external resource
 
 For more information on the operators you can use in your query, see the
-:manual:`MongoDB server manual page on geospatial query operators </geospatial-queries/index.html>`
+:manual:`{+mdb-server+} manual page on geospatial query operators </geospatial-queries/index.html>`
 
 .. external resource
diff --git a/source/fundamentals/crud/read-operations/retrieve.txt b/source/fundamentals/crud/read-operations/retrieve.txt
@@ -134,7 +134,7 @@ After the owner runs the aggregation, they find that "green" is the most
 purchased color.
 
 For more information on how to construct an aggregation pipeline, see
-the MongoDB server manual page on :manual:`Aggregation </aggregation>`.
+the {+mdb-server+} manual page on :manual:`Aggregation </aggregation>`.
 
 .. _retrieve-watch:
 
diff --git a/source/fundamentals/crud/write-operations/change-a-document.txt b/source/fundamentals/crud/write-operations/change-a-document.txt
@@ -128,8 +128,9 @@ documents match.
 
     The ``updateOne()`` and ``updateMany()`` methods cannot make changes
     to a document that violate unique index constraints on the
-    collection. See the MongoDB server manual for more information on
-    :manual:`unique indexes </core/index-unique/>`. 
+    collection. For more information about constraints on unique indexes,
+    see :manual:`Unique Indexes </core/index-unique/>` in the
+    {+mdb-server+} manual.
 
 .. _replace-operation:
 
@@ -205,5 +206,8 @@ the ``replaceOne()`` method, it replaces the first result.
 .. important::
 
     The ``replaceOne()`` method cannot make changes to a document that
-    violate unique index constraints on the collection. See the MongoDB
-    server manual for more information on :manual:`unique indexes </core/index-unique/>`.
+    violate unique index constraints on the collection.
+    For more information about constraints on unique indexes,
+    see :manual:`Unique Indexes </core/index-unique/>` in the
+    {+mdb-server+} manual.
+
diff --git a/source/fundamentals/enterprise-auth.txt b/source/fundamentals/enterprise-auth.txt
@@ -59,8 +59,8 @@ The following code snippets show how to specify the authentication mechanism,
 using the following placeholders:
 
 * ``username`` - your URL-encoded principal name, e.g. "username%40REALM.ME"
-* ``hostname`` - network address of your MongoDB server, accessible by your client
-* ``port`` - port number of your MongoDB server
+* ``hostname`` - network address of your MongoDB deployment, accessible by your client
+* ``port`` - port number of your MongoDB deployment
 
 Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
 tab below for instructions and sample code for specifying this authentication
@@ -242,8 +242,8 @@ using the following placeholders:
 
 * ``username`` - your LDAP username
 * ``password`` - your LDAP user's password
-* ``hostname`` - network address of your MongoDB server, accessible by your client
-* ``port`` - port number of your MongoDB server
+* ``hostname`` - network address of your MongoDB deployment, accessible by your client
+* ``port`` - port number of your MongoDB deployment
 
 Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
 tab below for instructions and sample code for specifying this authentication
diff --git a/source/fundamentals/indexes.txt b/source/fundamentals/indexes.txt
@@ -84,8 +84,7 @@ Since MongoDB supports dynamic schemas, applications can query against fields wh
 are arbitrary. MongoDB 4.2 introduced :manual:`wildcard indexes </core/index-wildcard/>` to help support these queries.
 Wildcard indexes are not designed to replace workload-based index planning.
 
-For more information on designing your data model and choosing indexes appropriate for your application, see the MongoDB
-server documentation on :manual:`Indexing Strategies </applications/indexes>` and
+For more information on designing your data model and choosing indexes appropriate for your application, see the {+mdb-server+}
 :manual:`Data Modeling and Indexes </core/data-model-operations/#indexes>`.
 
 Index Types
@@ -165,7 +164,7 @@ The following is an example of a query that would be covered by the index create
 
 .. common-content-begin
 
-See the MongoDB server manual section on :manual:`single field indexes </core/index-single>` for more information.
+For more information, see :manual:`Single Field Indexes </core/index-single>` in the {+mdb-server+} manual.
 
 Compound Indexes
 ++++++++++++++++
@@ -200,7 +199,7 @@ The following is an example of a query that would be covered by the index create
 
 .. common-content-begin
 
-See the MongoDB server manual section on :manual:`Compound indexes </core/index-compound>` for more information.
+For more information, see :manual:`Compound Indexes </core/index-compound>` in the {+mdb-server+} manual.
 
 Multikey Indexes (Indexes on Array Fields)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -306,7 +305,7 @@ the geospatial data for inclusion, intersection, and proximity. For more informa
 :manual:`Geospatial Queries </geospatial-queries/>`.
 
 To create a ``2dsphere`` index, you must specify a field that contains only **GeoJSON objects**. For more details on this
-type, see the MongoDB server manual page on :manual:`GeoJSON objects </reference/geojson>`.
+type, see the {+mdb-server+} manual page on :manual:`GeoJSON objects </reference/geojson>`.
 
 The ``location.geo`` field in the following sample document from the ``theaters`` collection in the ``sample_mflix``
 database is a GeoJSON Point object that describes the coordinates of the theater:
@@ -360,8 +359,8 @@ The following is an example of a geospatial query using the "location.geo" index
 .. common-content-begin
 
 MongoDB also supports ``2d`` indexes for calculating distances on a Euclidean plane and for working with the "legacy
-coordinate pairs" syntax used in MongoDB 2.2 and earlier. See the :manual:`Geospatial Queries page </geospatial-queries>`
-in the MongoDB server manual for more information.
+coordinate pairs" syntax used in MongoDB 2.2 and earlier. For more information, see the :manual:`Geospatial Queries page </geospatial-queries>`
+in the {+mdb-server+} manual. 
 
 Unique Indexes
 ~~~~~~~~~~~~~~
@@ -393,7 +392,7 @@ The following example creates a unique, descending index on the ``theaterId`` fi
 
       E11000 duplicate key error index
 
-Refer to the :manual:`Unique Indexes page </core/index-unique>` in the MongoDB server manual for more information.
+For more information, see the :manual:`Unique Indexes</core/index-unique>` page in the {+mdb-server+} manual.
 
 .. driver-content-end
 
diff --git a/source/fundamentals/logging.txt b/source/fundamentals/logging.txt
@@ -376,11 +376,11 @@ and the logging events they correspond to.
 
 * ``org.mongodb.driver.authenticator`` : authentication
 * ``org.mongodb.driver.client`` : events related to ``MongoClient`` instances
-* ``org.mongodb.driver.cluster`` : monitoring of MongoDB servers
+* ``org.mongodb.driver.cluster`` : monitoring of MongoDB deployments
 * ``org.mongodb.driver.connection`` : connections and connection pools
 * ``org.mongodb.driver.connection.tls`` : TLS/SSL
 * ``org.mongodb.driver.operation`` : operations, including logging related to automatic retries
-* ``org.mongodb.driver.protocol`` : commands sent to and replies received from MongoDB servers
+* ``org.mongodb.driver.protocol`` : commands sent to and replies received from MongoDB deployments
 * ``org.mongodb.driver.uri`` : connection string parsing
 * ``org.mongodb.driver.management`` : JMX (Java Management Extensions)
 
diff --git a/source/fundamentals/stable-api.txt b/source/fundamentals/stable-api.txt
@@ -15,7 +15,7 @@
 
 .. note::
 
-   The {+stable-api+} feature requires MongoDB Server 5.0 or later.
+   The {+stable-api+} feature requires {+mdb-server+} 5.0 or later.
 
    You should only use the {+stable-api+} feature if all the MongoDB
    servers you are connecting to support this feature.
@@ -80,9 +80,9 @@ following operations:
 
 .. warning::
 
-   If you specify an API version and connect to a MongoDB server that does
+   If you specify an API version and connect to a MongoDB deployment that does
    not support the {+stable-api+}, your application may raise an exception when
-   executing a command on your MongoDB server. If you use a ``MongoClient``
+   executing a command on your MongoDB deployment. If you use a ``MongoClient``
    that specifies the API version to query a server that does not support it,
    your query could fail with an exception message that includes the
    following text:
diff --git a/source/includes/fundamentals/localhost-connection.rst b/source/includes/fundamentals/localhost-connection.rst
diff --git a/source/index.txt b/source/index.txt
diff --git a/source/usage-examples/bulkWrite.txt b/source/usage-examples/bulkWrite.txt
diff --git a/source/usage-examples/command.txt b/source/usage-examples/command.txt
diff --git a/source/usage-examples/count.txt b/source/usage-examples/count.txt
