DOCSP-45459 Mark Compass-Exclusive Content

ajhuh-mdb · ajhuh-mdb · commit 08e02ed35513 · 2024-11-19T18:46:55.000-05:00
diff --git a/source/agg-pipeline-builder/export-pipeline-results.txt b/source/agg-pipeline-builder/export-pipeline-results.txt
@@ -59,6 +59,10 @@ Steps
 Learn More 
 ----------
 
+.. BEGIN-COMPASS-ONLY
+
 - :ref:`export-data-collection`
 
+.. END-COMPASS-ONLY
+
 - :ref:`compass-export-pipeline`
diff --git a/source/agg-pipeline-builder/maxtime-ms-pipeline.txt b/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.
 
diff --git a/source/agg-pipeline-builder/view-pipeline-explain-plan.txt b/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`
diff --git a/source/collections.txt b/source/collections.txt
@@ -100,13 +100,17 @@ 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`
 
diff --git a/source/documents/delete-multiple.txt b/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
 -----
 
diff --git a/source/documents/delete.txt b/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:
 
@@ -76,9 +80,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
diff --git a/source/documents/modify-multiple.txt b/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
diff --git a/source/documents/modify.txt b/source/documents/modify.txt
@@ -213,9 +213,11 @@ 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
diff --git a/source/includes/steps-create-collection.yaml b/source/includes/steps-create-collection.yaml
@@ -20,9 +20,13 @@ content: |
    - :ref:`Create a Clustered Collection <compass-clustered-collection>`
 
    - :ref:`Create a Collection with Collation <compass-collation-collection>`
+   
+   .. BEGIN-COMPASS-ONLY 
 
    - :ref:`Create a Collection with Encrypted Fields <compass-encrypted-collection>`
 
+   .. END-COMPASS-ONLY
+
    - :ref:`Create a Time Series Collection <compass-time-series-collection>`
 ---
 title: Click :guilabel:`Create Collection` to create the collection.
diff --git a/source/indexes.txt b/source/indexes.txt
@@ -81,6 +81,8 @@ Create an Index
 
 .. include:: /includes/steps/create-index.rst
 
+.. BEGIN-COMPASS-ONLY
+
 Create an Atlas Search Index
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -95,6 +97,8 @@ Atlas Vector Search indexes enable you to index vector data *and* other data
 types, which facilitates semantic searches on the indexed fields. For more
 information, see :ref:`compass-create-vector-search`. 
 
+.. END-COMPASS-ONLY
+
 .. _compass-wildcard-index:
 
 Create a Wildcard Index
@@ -185,8 +189,12 @@ Limitations
      :ref:`Atlas CLI <atlas-cli>`, or the 
      :ref:`Atlas Administration API <atlas-admin-api>`. 
 
+.. BEGIN-COMPASS-ONLY
+
 .. toctree::
    :titlesonly:
 
    Atlas Search Index </indexes/create-search-index>
    Atlas Vector Search Index </indexes/create-vector-search-index>
+
+.. END-COMPASS-ONLY
diff --git a/source/query-plan.txt b/source/query-plan.txt
@@ -1,4 +1,4 @@
-.. _explain-plans:
+.. _compass-explain-plans:
 
 ======================
 View Query Performance
diff --git a/source/query-with-natural-language/ai-and-data-usage-information.txt b/source/query-with-natural-language/ai-and-data-usage-information.txt
@@ -31,16 +31,23 @@ AI provider:
 - The full text of your natural language prompt.
 - The schema of the collection you are querying, 
   including database name, collection name, field names, and types. 
+
+.. BEGIN-COMPASS-ONLY
+
 - Enable sending sample field values. This is an optional setting to 
   improve the quality of recommendations. You can manage this through the
   ``Enable sending sample field values`` setting in 
   :ref:`Compass settings <compass-settings-reference>`. This setting 
   is off by default.
 
+.. END-COMPASS-ONLY
+
 The information that is sent will not be shared with any other third 
 parties or stored by the AI provider. We do not send database 
 connection strings, credentials, or rows/documents from your databases. 
 
+.. BEGIN-COMPASS-ONLY
+
 Disable Natural Language Querying
 ---------------------------------
 
@@ -51,4 +58,6 @@ Disable Natural Language Querying
   :guilabel:`Enable AI Features` in the 
   :guilabel:`Artificial Intelligence` settings. 
 - To prevent usage of this feature entirely, you can disable it in the 
-  :ref:`global configuration file <config-file>`.
+  :ref:`global configuration file <config-file>`.
+
+.. END-COMPASS-ONLY
diff --git a/source/query-with-natural-language/enable-natural-language-querying.txt b/source/query-with-natural-language/enable-natural-language-querying.txt
@@ -36,6 +36,8 @@ you must:
 - Sign into Atlas. For details on how to get a free Atlas 
   account and deploy a free M0 cluster, see :ref:`atlas-getting-started`.
 
+.. BEGIN-COMPASS-ONLY
+
 - Install |compass-short| version 1.40.0 or later. For instructions on 
   downloading and installing the latest version, see :ref:`download-install`.
 
@@ -44,6 +46,8 @@ you must:
    You can also enable Natural Language Querying using the configuration 
    file. For details, see :ref:`config-file`. 
 
+.. END-COMPASS-ONLY
+
 Steps
 -----
 
diff --git a/source/query/filter.txt b/source/query/filter.txt
@@ -448,11 +448,15 @@ Clear the Query
 
 .. include:: /includes/clear-query.rst
 
+.. BEGIN-COMPASS-ONLY
+
 Query Collections with Invalid UTF8 Data
 ----------------------------------------
 
 .. include:: /includes/fact-non-utf8-data.rst
 
+.. END-COMPASS-ONLY
+
 How Does the Compass Query Compare to MongoDB and SQL Queries?
 --------------------------------------------------------------
 

Original file line number	Diff line number	Diff line change
`@@ -72,4 +72,4 @@ Learn More`
`72`	`72`
`73`	`73`	- :manual:`Analyze Query Performance </tutorial/analyze-query-plan/>`
`74`	`74`
`75`		-- :ref:`explain-plans`
	`75`	+- :ref:`compass-explain-plans`