DOCSP-47239 More Compass Cleanup (#721)

ajhuh-mdb · web-flow · commit 495e24c35361 · 2025-02-13T11:25:26.000-05:00
* DOCSP-47239 More Compass Cleanup

* *

* internal feedback
diff --git a/source/agg-pipeline-builder/count-pipeline-results.txt b/source/agg-pipeline-builder/count-pipeline-results.txt
@@ -35,7 +35,7 @@ Steps
 .. procedure:: 
    :style: normal
 
-   .. step:: Click the count results button
+   .. step:: Click :guilabel:`count results`
 
       After you run your pipeline, click :guilabel:`count results`, which 
       appears under the :guilabel:`Run` button. The :guilabel:`count results` 
@@ -46,8 +46,8 @@ Steps
 
    .. step:: (Optional) Click the refresh icon 
 
-      If you edit your pipeline, you must press the :icon-fa4:`refresh` button 
-      to update your document count.  
+      If you edit your pipeline, click refresh :icon-fa4:`refresh` to update 
+      your document count.  
 
 Learn More 
 ----------
diff --git a/source/agg-pipeline-builder/create-a-view.txt b/source/agg-pipeline-builder/create-a-view.txt
@@ -28,7 +28,7 @@ Steps
 .. procedure:: 
    :style: normal
 
-   .. step:: Click the Save drop-down button
+   .. step:: Click the :guilabel:`Save` drop-down button
 
       In the aggregation pipeline pane, click the :guilabel:`Save` drop-down 
       button and select :guilabel:`Create view`.
diff --git a/source/agg-pipeline-builder/export-pipeline-results.txt b/source/agg-pipeline-builder/export-pipeline-results.txt
@@ -27,7 +27,7 @@ Steps
 .. procedure::
    :style: normal
 
-   .. step:: Click the Export button
+   .. step:: Click :guilabel:`Export`
 
       In the top right of the aggregation pipeline builder, click the 
       :guilabel:`Export` button to open the modal.
@@ -49,7 +49,7 @@ Steps
 
       .. include:: /includes/extended-json-table.rst
 
-   .. step:: Click Export
+   .. step:: Click :guilabel:`Export`
 
    .. step:: Specify export destination
 
diff --git a/source/agg-pipeline-builder/export-pipeline-to-language.txt b/source/agg-pipeline-builder/export-pipeline-to-language.txt
@@ -30,7 +30,7 @@ Steps
 .. procedure::
    :style: normal
    
-   .. step:: Click the Export to Language button 
+   .. step:: Click :guilabel:`Export to Language` 
 
       In the aggregation pipeline pane, click the :guilabel:`Export to Language` 
       button to open the pipeline export card. 
diff --git a/source/agg-pipeline-builder/maxtime-ms-pipeline.txt b/source/agg-pipeline-builder/maxtime-ms-pipeline.txt
@@ -44,14 +44,14 @@ Steps
 .. procedure::
    :style: normal
 
-   .. step:: Click Options
+   .. step:: Click :guilabel:`Options`
       
       On the :guilabel:`Aggregations` tab, click :guilabel:`Options`
 
       .. figure:: /images/compass/agg-builder-click-more-options.png
          :alt: More Options dropdown.
 
-   .. step:: Specify a Max Time MS value
+   .. step:: Specify a :guilabel:`Max Time MS` value
 
       Next to the :guilabel:`Max Time MS` field, enter a numeric value to set as 
       the maximum amount of time in milliseconds that an aggregation 
diff --git a/source/agg-pipeline-builder/pipeline-custom-collation.txt b/source/agg-pipeline-builder/pipeline-custom-collation.txt
@@ -30,7 +30,7 @@ Steps
 .. procedure:: 
    :style: normal
    
-   .. step:: Click Options
+   .. step:: Click :guilabel:`Options`
     
       In the top-right corner of the pipeline builder, click 
       :guilabel:`Options`.
diff --git a/source/agg-pipeline-builder/view-pipeline-explain-plan.txt b/source/agg-pipeline-builder/view-pipeline-explain-plan.txt
@@ -41,7 +41,7 @@ Steps
 .. procedure:: 
    :style: normal
 
-   .. step:: Click the Explain button
+   .. step:: Click :guilabel:`Explain`
 
       In the top right of the aggregation pipeline builder, click the 
       :guilabel:`Explain` button to open the :guilabel:`Explain Plan` modal.
@@ -62,7 +62,7 @@ Steps
          :alt: Detailed Visual Tree view
          :width: 696px
          
-   .. step:: (Optional) Select the Raw Output view
+   .. step:: (Optional) Select the :guilabel:`Raw Output` view
       
       To view your full explain plan as raw JSON, select the 
       :guilabel:`Raw Output` view. 
diff --git a/source/collections.txt b/source/collections.txt
@@ -100,12 +100,8 @@ 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>`
@@ -116,8 +112,6 @@ view:
 
 - :ref:`compass-validation`
 
-.. BEGIN-COMPASS-ONLY
-
 .. note:: Data Lake Limitations
 
    The following functionality is not available if you are connected to
@@ -133,8 +127,6 @@ view:
 
    - Set Validation Rules for Your Schema
 
-.. END-COMPASS-ONLY
-
 .. _compass-tabbed-view:
 
 Tabbed View
@@ -145,8 +137,6 @@ open a new tab to view collection details:
 
 .. include:: /includes/shared/steps/open-new-tab.rst
 
-.. BEGIN-COMPASS-ONLY
-
 Limitations
 -----------
 
@@ -155,8 +145,6 @@ 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::
diff --git a/source/collections/capped-collection.txt b/source/collections/capped-collection.txt
@@ -16,6 +16,21 @@ Create a Capped Collection
 collections that support high-throughput operations that insert and retrieve 
 documents based on insertion order. 
 
+Limitations
+-----------
+
+The following restrictions and limitations apply when creating a 
+capped collection:
+
+- :guilabel:`Custom collation` is the only :guilabel:`Advanced Collection Option` 
+  that you can use alongside your capped collection.  
+
+- If you import a data set larger than the maximum size of the capped collection,
+  |compass-short| only loads the last documents of the data set and drops the oldest
+  documents.
+
+- Once the collection is created, you can't adjust the maximum number of bytes.
+
 Steps
 -----
 
@@ -38,18 +53,3 @@ Steps
       Enter the maximum number of bytes that the collection can hold.
 
    .. step:: Click :guilabel:`Create Collection` to create the collection
-
-Restrictions and Limitations
-----------------------------
-
-The following restrictions and limitations apply when creating a 
-capped collection:
-
-- :guilabel:`Custom collation` is the only :guilabel:`Advanced Collection Option` 
-  that can be used alongside your capped collection.  
-
-- If you import a data set larger than the maximum size of the capped collection,
-  |compass-short| only loads the last documents of the data set and drops the oldest
-  documents.
-
-- Once the collection is created, you cannot adjust the maximum number of bytes.
diff --git a/source/collections/clustered-collection.txt b/source/collections/clustered-collection.txt
@@ -17,7 +17,7 @@ with a clustered index. Clustered collections store documents ordered by :manual
 key value. You can use clustered collections when only one clustered index is 
 necessary.
 
-Restrictions 
+Limitations 
 ------------
 
 Clustered collection limitations:
diff --git a/source/collections/collation-collection.txt b/source/collections/collation-collection.txt
@@ -16,6 +16,25 @@ Create a Collection with Collation
 language-specific rules for string comparison, such as rules for lettercase 
 and accent marks.
 
+Limitations
+-----------
+
+The following restrictions apply when the parameter ``numericOrdering`` 
+is set to ``true``:
+
+- Only contiguous non-negative integer substrings of digits are 
+  considered in the comparisons. ``numericOrdering`` does not support:
+
+  - ``+``
+  - ``-``
+  - exponents
+
+- Only Unicode code points in the Number or Decimal Digit (Nd) category 
+  are treated as digits.
+
+- If the number length exceeds 254 characters, the excess characters are 
+  treated as a separate number.
+
 Procedure
 ---------
 
@@ -43,27 +62,8 @@ Procedure
 
    .. step:: Click :guilabel:`Create Collection` to create the collection.
 
-Restrictions and Limitations
-----------------------------
-
-The following restrictions apply when the parameter ``numericOrdering`` 
-is set to ``true``:
-
-- Only contiguous non-negative integer substrings of digits are 
-  considered in the comparisons. ``numericOrdering`` does not support:
-
-  - ``+``
-  - ``-``
-  - exponents
-
-- Only Unicode code points in the Number or Decimal Digit (Nd) category 
-  are treated as digits.
-
-- If the number length exceeds 254 characters, the excess characters are 
-  treated as a separate number.
-
 Example 
-~~~~~~~
+-------
 
 Consider a collection with the following string number and decimal values:
 
diff --git a/source/collections/encrypted-collection.txt b/source/collections/encrypted-collection.txt
@@ -15,6 +15,15 @@ Create a Collection with Queryable Encryption
 :manual:`Queryable Encryption </core/queryable-encryption/>` allows you to 
 encrypt a subset of fields in your collection.
 
+Limitations
+-----------
+
+- Your deployment must be connected using In-Use Encryption to encrypt your 
+  collection using Queryable Encryption.
+
+- :guilabel:`Custom collation` is the only :guilabel:`Advanced Collection Option` 
+  that you can use with {+qe+}. 
+
 Procedure
 ---------
 
@@ -48,12 +57,3 @@ Procedure
 
       Your collection will be marked by a :guilabel:`Queryable Encryption` 
       badge.
-
-Restrictions and Limitations
-----------------------------
-
-- Your deployment must be connected using In-Use Encryption to encrypt your 
-  collection using Queryable Encryption.
-
-- :guilabel:`Custom collation` is the only :guilabel:`Advanced Collection Option` 
-  that can be used alongside Queryable Encryption. 
diff --git a/source/collections/time-series-collection.txt b/source/collections/time-series-collection.txt
@@ -15,6 +15,18 @@ Create a Time Series Collection
 :manual:`Time series collections </core/timeseries-collections/>` efficiently 
 store sequences of measurements over a period of time. 
 
+Limitations
+-----------
+
+The following restrictions and limitations apply when creating a time series 
+collection:
+
+- :guilabel:`Custom collation` is the only :guilabel:`Advanced Collection Option` 
+  that you can use with your time series collection.  
+
+- See :manual:`Time Series Collection Limitations </core/timeseries/timeseries-limitations/>` 
+  for all time series collection limitations.
+
 Procedure
 ---------
 
@@ -88,15 +100,3 @@ Procedure
 
 For more information on time series fields, see :manual:`Time Series
 Object Fields </core/timeseries/timeseries-procedures/#timeseries-object-fields>`.  
-
-Restrictions and Limitations
-----------------------------
-
-The following restrictions and limitations apply when creating a time series 
-collection:
-
-- :guilabel:`Custom collation` is the only :guilabel:`Advanced Collection Option` 
-  that can be used alongside your time series collation.  
-
-- See :manual:`Time Series Collection Limitations </core/timeseries/timeseries-limitations/>` 
-  for all time series collection limitations.
diff --git a/source/create-agg-pipeline.txt b/source/create-agg-pipeline.txt
@@ -70,7 +70,7 @@ your chosen view mode:
       .. procedure:: 
          :style: normal
 
-         .. step:: Select the Stages view
+         .. step:: Select the :guilabel:`Stages` view
             
             In the aggregation pipeline pane, ensure the 
             :guilabel:`{} Stages` toggle switch is selected.
@@ -140,7 +140,7 @@ your chosen view mode:
       .. procedure::
          :style: normal
          
-         .. step:: Select the Stages view
+         .. step:: Select the :guilabel:`Stages` view
             
             In the aggregation pipeline pane, ensure the 
             :guilabel:`{} Stages` toggle switch is selected.
@@ -149,7 +149,7 @@ your chosen view mode:
                :figwidth: 300 px
                :alt: Toggle on stage view mode 
 
-         .. step:: Open the Stage Wizard card
+         .. step:: Open the :guilabel:`Stage Wizard` card
             
             To the right of the view mode toggle, click the wand icon to open 
             the :guilabel:`Stage Wizard` card.
@@ -224,7 +224,7 @@ your chosen view mode:
       .. procedure::
          :style: normal
          
-         .. step:: Select the Stages view
+         .. step:: Select the :guilabel:`Stages` view
             
             In the aggregation pipeline pane, ensure the 
             :guilabel:`{} Stages` toggle switch is selected.
@@ -320,7 +320,7 @@ your chosen view mode:
       .. procedure::
          :style: normal
          
-         .. step:: Select the Text view
+         .. step:: Select the :guilabel:`Text` view
             
             In the aggregation pipeline pane, click the 
             :guilabel:`</> Text` toggle switch to enable text mode for pipeline 
diff --git a/source/databases.txt b/source/databases.txt
@@ -51,14 +51,10 @@ Drop a Database
 
 .. include:: /includes/shared/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
diff --git a/source/documents.txt b/source/documents.txt
@@ -21,15 +21,12 @@ 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-short| 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.
diff --git a/source/export-query-to-language.txt b/source/export-query-to-language.txt
diff --git a/source/indexes.txt b/source/indexes.txt
diff --git a/source/query-plan.txt b/source/query-plan.txt
