diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt index 91ee19315..2c22a8abb 100644 --- a/source/fundamentals/connection.txt +++ b/source/fundamentals/connection.txt @@ -33,6 +33,17 @@ learn: - :ref:`How to Enable TLS on a Connection ` - :atlas:`How to Connect to MongoDB Atlas from AWS Lambda ` +Compatibility +------------- + +.. |page-topic| replace:: use the {+driver-short+} +.. |link-topic-ing| replace:: using drivers to connect + +.. |atlas-url| replace:: :atlas:`Connect Your Application ` + +.. include:: /includes/fact-atlas-compatible.rst +.. include:: /includes/fact-atlas-link.rst + For information about authenticating to MongoDB, see :ref:`node-authentication-mechanisms` and :ref:`node-enterprise-authentication-mechanisms`. diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt index 585a7618b..8276c9d38 100644 --- a/source/fundamentals/crud.txt +++ b/source/fundamentals/crud.txt @@ -28,6 +28,17 @@ Some operations combine aspects of read and write operations. See our guide on :doc:`compound operations ` to learn more about these hybrid methods. +Compatibility +------------- + +.. |page-topic| replace:: perform CRUD operations +.. |link-topic-ing| replace:: performing CRUD operations in the Atlas UI + +.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents ` + +.. include:: /includes/fact-atlas-compatible.rst +.. include:: /includes/fact-atlas-link.rst + .. note:: If you are looking for additional resources for learning topics related diff --git a/source/fundamentals/crud/read-operations/retrieve.txt b/source/fundamentals/crud/read-operations/retrieve.txt index 0589a53bc..662b3e9c4 100644 --- a/source/fundamentals/crud/read-operations/retrieve.txt +++ b/source/fundamentals/crud/read-operations/retrieve.txt @@ -41,6 +41,17 @@ matching data is inserted. .. include:: /includes/access-cursor-note.rst +Compatibility +------------- + +.. |page-topic| replace:: perform read operations +.. |link-topic-ing| replace:: performing read operations in the Atlas UI + +.. |atlas-url| replace:: :atlas:`View, Filter, and Sort Documents ` + +.. include:: /includes/fact-atlas-compatible.rst +.. include:: /includes/fact-atlas-link.rst + Find ---- diff --git a/source/includes/fact-atlas-compatible.rst b/source/includes/fact-atlas-compatible.rst new file mode 100644 index 000000000..3cf5ac9a9 --- /dev/null +++ b/source/includes/fact-atlas-compatible.rst @@ -0,0 +1,4 @@ +You can use the {+driver-short+} to connect and |page-topic| for +deployments hosted in the following environments: + +.. include:: /includes/fact-environments.rst \ No newline at end of file diff --git a/source/includes/fact-atlas-link.rst b/source/includes/fact-atlas-link.rst new file mode 100644 index 000000000..60c914dea --- /dev/null +++ b/source/includes/fact-atlas-link.rst @@ -0,0 +1,2 @@ +To learn more about |link-topic-ing| for deployments hosted in MongoDB +Atlas, see |atlas-url|. \ No newline at end of file diff --git a/source/includes/fact-environments.rst b/source/includes/fact-environments.rst new file mode 100644 index 000000000..03daf302f --- /dev/null +++ b/source/includes/fact-environments.rst @@ -0,0 +1,7 @@ +- `MongoDB Atlas + `__: The fully + managed service for MongoDB deployments in the cloud +- :ref:`MongoDB Enterprise `: The + subscription-based, self-managed version of MongoDB +- :ref:`MongoDB Community `: The + source-available, free-to-use, and self-managed version of MongoDB \ No newline at end of file diff --git a/source/index.txt b/source/index.txt index aed1f14cd..88fdd016a 100644 --- a/source/index.txt +++ b/source/index.txt @@ -34,6 +34,11 @@ in JavaScript or TypeScript. For more information about downloading and installing the {+driver-short+}, see the :ref:``. +You can connect using the {+driver-short+} for +deployments hosted in the following environments: + +.. include:: /includes/fact-environments.rst + Quick Start ----------- diff --git a/source/quick-reference.txt b/source/quick-reference.txt index f720a504e..138a9116f 100644 --- a/source/quick-reference.txt +++ b/source/quick-reference.txt @@ -9,6 +9,17 @@ Quick Reference This page shows the driver syntax for several MongoDB commands and links to their related reference and API documentation. +Compatibility +------------- + +.. |page-topic| replace:: execute commands +.. |link-topic-ing| replace:: performing common CRUD operations in the Atlas UI + +.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents ` + +.. include:: /includes/fact-atlas-compatible.rst +.. include:: /includes/fact-atlas-link.rst + .. list-table:: :header-rows: 1 :widths: 25 75 diff --git a/source/usage-examples/find.txt b/source/usage-examples/find.txt index 1d8af6f88..1a0a5be71 100644 --- a/source/usage-examples/find.txt +++ b/source/usage-examples/find.txt @@ -33,6 +33,17 @@ documents using one of the following :ref:`cursor methods `: If no documents match the query, ``find()`` returns an empty cursor. +Compatibility +------------- + +.. |page-topic| replace:: use the ``find()`` method +.. |link-topic-ing| replace:: finding documents in the Atlas UI + +.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents ` + +.. include:: /includes/fact-atlas-compatible.rst +.. include:: /includes/fact-atlas-link.rst + Example ------- diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt index 1a14394a1..88d3988d3 100644 --- a/source/usage-examples/findOne.txt +++ b/source/usage-examples/findOne.txt @@ -23,6 +23,17 @@ in the ``options`` object passed as the second parameter of the ``findOne`` method. For detailed reference documentation, see `collection.findOne() <{+api+}/classes/Collection.html#findOne>`__. +Compatibility +------------- + +.. |page-topic| replace:: use the ``findOne()`` method +.. |link-topic-ing| replace:: finding documents in the Atlas UI + +.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents ` + +.. include:: /includes/fact-atlas-compatible.rst +.. include:: /includes/fact-atlas-link.rst + Example ------- diff --git a/source/usage-examples/insertOne.txt b/source/usage-examples/insertOne.txt index acfffa495..de6b43df4 100644 --- a/source/usage-examples/insertOne.txt +++ b/source/usage-examples/insertOne.txt @@ -22,6 +22,17 @@ If the operation successfully inserts a document, it appends an ``insertedId`` field to the object passed in the method call, and sets the value of the field to the ``_id`` of the inserted document. +Compatibility +------------- + +.. |page-topic| replace:: use the ``insertOne()`` method +.. |link-topic-ing| replace:: inserting documents in the Atlas UI + +.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents ` + +.. include:: /includes/fact-atlas-compatible.rst +.. include:: /includes/fact-atlas-link.rst + Example -------