DOCSP-45459 Mark Compass-Exclusive Content (#696)

* DOCSP-45459 Mark Compass-Exclusive Content

* fix yaml syntax

* *

* *

* databases - documents

* query directory

* aggregation

* *

* *

* *

Author: ajhuh-mdb

source/agg-pipeline-builder/maxtime-ms-pipeline.txt

@@ -25,12 +25,16 @@ frequently time out. Alternatively, consider lowering the
 :guilabel:`Max Time MS` value to quickly identify inefficient or 
 resource-intensive pipeline operations.
 
+.. BEGIN-COMPASS-ONLY
+
 If you already specified a ``maxTimeMS`` value in the :ref:`Compass Settings 
 panel <compass-interface-settings>`, the :ref:`command line <cli-options>`, or 
 a :ref:`configuration file <config-file-options>`, the :guilabel:`Max Time MS` 
 that you specify for your pipeline must be lower than the limit you previously 
 specified.
 
+.. END-COMPASS-ONLY
+
 If your aggregation operation goes over the time limit, |compass-short| raises 
 a timeout error.
 
@@ -57,11 +61,14 @@ Steps
 
 Learn More 
 ----------
+.. BEGIN-COMPASS-ONLY
 
 - :ref:`cli-options`
 
 - :ref:`config-file-options`
 
 - :ref:`compass-interface-settings`
 
+.. END-COMPASS-ONLY
+
 - :ref:`compass-query-bar-max-time-ms`

source/agg-pipeline-builder/view-pipeline-explain-plan.txt

@@ -72,4 +72,4 @@ Learn More
 
 - :manual:`Analyze Query Performance </tutorial/analyze-query-plan/>`
 
-- :ref:`explain-plans`
+- :ref:`compass-explain-plans`

source/collections.txt

@@ -100,18 +100,24 @@ view:
 
 - :ref:`compass-documents`
 
+.. BEGIN-COMPASS-ONLY
+
 - :ref:`compass-import-export` to and from the collection
 
+.. END-COMPASS-ONLY
+
 - :ref:`compass-agg-builder`
 
 - :ref:`Schema Analysis <compass-schema-tab>`
 
-- :ref:`explain-plans`
+- :ref:`compass-explain-plans`
 
 - :ref:`compass-indexes`
 
 - :ref:`compass-validation`
 
+.. BEGIN-COMPASS-ONLY
+
 .. note:: Data Lake Limitations
 
    The following functionality is not available if you are connected to
@@ -127,6 +133,8 @@ view:
 
    - Set Validation Rules for Your Schema
 
+.. END-COMPASS-ONLY
+
 .. _compass-tabbed-view:
 
 Tabbed View
@@ -137,6 +145,8 @@ open a new tab to view collection details:
 
 .. include:: /includes/steps/open-new-tab.rst
 
+.. BEGIN-COMPASS-ONLY
+
 Limitations
 -----------
 
@@ -145,6 +155,8 @@ Limitations
 - The :guilabel:`Create Collection` button is not available if you are 
   connected to a :atlas:`Data Lake </data-lake>`.
 
+.. END-COMPASS-ONLY
+
 .. |home| unicode:: U+2302
 
 .. toctree::

source/connect/required-access.txt

@@ -82,7 +82,7 @@ privileges:
      - :authrole:`readWrite`
 
    * - :guilabel:`Explain Plan`
-     - :ref:`Query/View a query plan <explain-plans>`
+     - :ref:`Query/View a query plan <compass-explain-plans>`
      - :authaction:`find`
      - :authrole:`read`
 

source/create-agg-pipeline.txt

@@ -48,14 +48,12 @@ collection.
 
 .. note:: Atlas Search Stages
 
-   When you connect |compass-short| to a MongoDB deployment hosted on 
+   When you connect to a MongoDB deployment hosted on 
    `Atlas <https://www.mongodb.com/cloud/atlas?tck=docs_compass>`_,
-   additional Atlas-only stages 
-   :atlas:`$search </reference/atlas-search/query-syntax/#-search>` and
-   :atlas:`$searchMeta </reference/atlas-search/query-syntax/#-searchmeta>`
-   are available in the Aggregation Pipeline Builder. Use these stages 
-   to perform 
-   :atlas:`full-text search</atlas-search/atlas-search-overview>` 
+   Atlas-only stages :atlas:`$search </reference/atlas-search/query-syntax/#-search>` 
+   and :atlas:`$searchMeta </reference/atlas-search/query-syntax/#-searchmeta>`
+   become available in the Aggregation Pipeline Builder. Use these stages 
+   to perform :atlas:`full-text search</atlas-search/atlas-search-overview>` 
    on Atlas collections.
 
 Steps

source/databases.txt

@@ -51,10 +51,14 @@ Drop a Database
 
 .. include:: /includes/steps/delete-database.rst
 
+.. BEGIN-COMPASS-ONLY
+
 Limitations
 -----------
 
 -  .. include:: /includes/extracts/readonly-not-permitted-databases.rst
 
 -  Creating databases is not permitted if you are connected to a 
    :atlas:`Data Lake </data-lake>`.
+
+.. END-COMPASS-ONLY

source/documents.txt

@@ -21,11 +21,15 @@ From the :guilabel:`Documents` tab, you can
 :ref:`delete multiple <compass-bulk-delete>` 
 documents in your selected collection or view.
 
+.. BEGIN-COMPASS-ONLY
+
 .. note::
 
    For query result sets larger than 20 documents, Compass shows 
    paginated results. By default, pages display 20 documents at a time.
 
+.. END-COMPASS-ONLY
+
 From the :ref:`query bar <compass-query-bar>`, you can specify a query to
 filter the displayed documents. Click :guilabel:`Options` to
 specify query options.

source/documents/clone.txt

@@ -12,11 +12,15 @@ Clone Documents
    :depth: 1
    :class: singlecol
 
+.. BEGIN-COMPASS-ONLY
+
 .. important::
 
    Cloning documents is not permitted in
    :guilabel:`MongoDB Compass Readonly Edition`.
 
+.. END-COMPASS-ONLY
+
 You can insert new documents by cloning the schema and values of
 an existing document in a collection.
 
@@ -38,10 +42,6 @@ documents in List, JSON, or Table view:
    .. tab:: JSON View
       :tabid: json
 
-      .. note::
-
-         JSON View is available starting in Compass 1.20.
-
       To clone a document, hover over the desired document
       and click the :guilabel:`Clone` button.
 

source/documents/delete-multiple.txt

@@ -26,13 +26,17 @@ Validate documents in the :guilabel:`Preview` of the
 :guilabel:`Delete Documents` modal before confirming the 
 delete operation.
 
+.. BEGIN-COMPASS-ONLY
+
 Before you Begin
 ----------------
 
 The :guilabel:`Delete Documents` modal is available starting
 in Compass version ``1.42.0``. For instructions on updating or installing
 the latest Compass version, see :ref:`download-install`. 
 
+.. END-COMPASS-ONLY
+
 Steps
 -----
 

source/documents/delete.txt

@@ -12,11 +12,15 @@ Delete Single Document
    :depth: 1
    :class: singlecol
 
+.. BEGIN-COMPASS-ONLY 
+
 .. important::
 
    Deleting documents is not permitted in
    :guilabel:`MongoDB Compass Readonly Edition`.
 
+.. END-COMPASS-ONLY
+
 Select the appropriate tab based on whether you are viewing your
 documents in List, JSON, or Table view:
 
@@ -39,10 +43,6 @@ documents in List, JSON, or Table view:
    .. tab:: JSON View
       :tabid: json
 
-      .. note::
-
-         JSON View is available starting in Compass 1.20.
-
       To delete a document, hover over the document and click the
       :icon-fa5:`trash-alt` icon.
 
@@ -76,9 +76,11 @@ Delete Multiple Documents
 You can use the bulk delete operations workflow to delete multiple 
 documents in Compass. For details, see :ref:`compass-bulk-delete`.
 
+.. BEGIN-COMPASS-ONLY
 .. note::
 
    You can also use the :manual:`db.collection.deleteMany()
    </reference/method/db.collection.deleteMany/>` method in the
    :ref:`embedded MongoDB Shell <embedded-mongodb-shell>` to delete
    multiple documents in a single operation.
+.. END-COMPASS-ONLY

source/documents/insert.txt

@@ -12,15 +12,19 @@ Insert Documents
    :depth: 1
    :class: singlecol
 
+.. BEGIN-COMPASS-ONLY
+
 .. important::
 
    Inserting documents is not permitted in
    :guilabel:`MongoDB Compass Readonly Edition`.
 
+.. END-COMPASS-ONLY
+
 |compass-short| provides two ways to insert documents into your
 collections: JSON Mode and a Field-by-Field Editor.
 
-JSON Mode (*New in Compass 1.20*)
+JSON Mode
   Allows you to write or paste JSON documents in the editor. Use
   this mode to insert multiple documents at once as an array.
 
@@ -136,8 +140,12 @@ To insert documents into your collection:
 
          4. Click :guilabel:`Insert`.
 
+.. BEGIN-COMPASS-ONLY
+
 Limitation
 ----------
 
 The :guilabel:`Insert Document` button is not available if you are connected 
 to a :atlas:`Data Lake </data-lake>`.
+
+.. END-COMPASS-ONLY

source/documents/modify-multiple.txt

@@ -32,13 +32,17 @@ About this Task
   only visible if your database is configured to support transactions.
   For details, see :ref:`transactions`. 
 
+.. BEGIN-COMPASS-ONLY
+
 Before you Begin
 ----------------
 
 The :guilabel:`Update Documents` modal is available starting
 in Compass version ``1.42.0``. For instructions on updating or installing
 the latest Compass version, see :ref:`download-install`. 
 
+.. END-COMPASS-ONLY
+
 Steps
 -----
 
@@ -95,6 +99,8 @@ Steps
          The documents under the :guilabel:`Preview` header show how the 
          :guilabel:`Update` syntax affects documents in your collection.
 
+   .. BEGIN-COMPASS-ONLY
+
    .. step:: (Optional) Name and save your :guilabel:`Update`
 
       You can name and save the update query in the 
@@ -108,6 +114,8 @@ Steps
       #. Enter a name for the update syntax.
       #. Click the green :guilabel:`Save` button.
 
+   .. END-COMPASS-ONLY
+
    .. step:: Update your documents
 
       Click :guilabel:`Update Documents`.
@@ -169,4 +177,9 @@ Learn More
 ----------
 
 - :ref:`compass-bulk-delete`
+
+.. BEGIN-COMPASS-ONLY
+
 - :ref:`compass-saved-favorite-query-view`
+
+.. END-COMPASS-ONLY

source/documents/modify.txt

@@ -18,13 +18,16 @@ You can edit existing documents in your collection.
 
 .. include:: /includes/fact-modify-findOneAndReplace.rst
 
+.. BEGIN-COMPASS-ONLY
 
 Limitations
 -----------
 
 - Modifying documents is not permitted in
   :guilabel:`MongoDB Compass Readonly Edition`.
 
+.. END-COMPASS-ONLY
+
 Procedure
 ---------
 
@@ -117,10 +120,6 @@ documents in List, JSON, or Table view:
    .. tab:: JSON View
       :tabid: json
 
-      .. note::
-
-         JSON View is available starting in Compass 1.20.
-
       To modify a document, hover over the document and click the pencil
       icon:
 
@@ -213,9 +212,13 @@ Modify Multiple Documents
 You can use the bulk update operations workflow to update multiple 
 documents in Compass. For details, see :ref:`compass-bulk-update`.
 
+.. BEGIN-COMPASS-ONLY
+
 .. note::
 
    You can also use the :manual:`db.collection.updateMany()
    </reference/method/db.collection.updateMany/>` method in the
    :ref:`embedded MongoDB Shell <embedded-mongodb-shell>` to update
    multiple documents in a single operation.
+
+.. END-COMPASS-ONLY

source/documents/view.txt

@@ -22,7 +22,7 @@ List View
   of a list. In this view you can easily expand embedded objects
   and arrays.
 
-JSON View (*New in Compass 1.20*)
+JSON View 
   Documents are shown as properly-formatted JSON objects. In this view
   |compass-short| uses extended JSON to display the data types of
   fields where appropriate.
@@ -46,10 +46,6 @@ following examples:
 
    .. tab:: JSON View
       :tabid: json
-
-      .. note::
-
-         JSON View is available starting in Compass 1.20.
 
       .. figure:: /images/compass/documents-json.png
          :figwidth: 700px
@@ -159,7 +155,7 @@ Copy Documents to Clipboard
          :figwidth: 696px
          :alt: Copy Document from Table View
 
-      
+.. BEGIN-COMPASS-ONLY
 
 Encrypted Fields
 ----------------
@@ -195,3 +191,5 @@ Encrypted Fields
          :alt: Encrypted field in table view
 
       .. include:: /includes/fact-qe-description.rst
+
+.. END-COMPASS-ONLY