DOCSP-44850-compass-prefix-updates (#692)

ajhuh-mdb · web-flow · commit c2574096dd53 · 2024-11-04T09:27:25.000-05:00
diff --git a/source/agg-pipeline-builder/export-pipeline-to-language.txt b/source/agg-pipeline-builder/export-pipeline-to-language.txt
@@ -60,9 +60,9 @@ Steps
       Click the :guilabel:`Include Driver Syntax` checkbox to include 
       application code for the selected programming language. If you include 
       driver syntax, the copyable code reflects :ref:`project 
-      <query-bar-project>`, :ref:`sort <query-bar-sort>`, :ref:`maxtimems 
-      <query-bar-max-time-ms>`, :ref:`collation <compass-query-bar-collation>`, 
-      :ref:`skip <query-bar-skip>` and :ref:`limit <query-bar-limit>` options. 
+      <compass-query-bar-project>`, :ref:`sort <compass-query-bar-sort>`, :ref:`maxtimems 
+      <compass-query-bar-max-time-ms>`, :ref:`collation <compass-query-bar-collation>`, 
+      :ref:`skip <compass-query-bar-skip>` and :ref:`limit <compass-query-bar-limit>` options. 
 
    .. step:: Click :icon-fa4:`files-o`
 
diff --git a/source/agg-pipeline-builder/maxtime-ms-pipeline.txt b/source/agg-pipeline-builder/maxtime-ms-pipeline.txt
@@ -64,4 +64,4 @@ Learn More
 
 - :ref:`compass-interface-settings`
 
-- :ref:`query-bar-max-time-ms`
+- :ref:`compass-query-bar-max-time-ms`
diff --git a/source/agg-pipeline-builder/open-saved-pipeline.txt b/source/agg-pipeline-builder/open-saved-pipeline.txt
@@ -57,11 +57,11 @@ Steps
    after you connect to your cluster.
 
    To learn more, see 
-   :ref:`viewing saved aggregations <saved-query-view>` for details.
+   :ref:`viewing saved aggregations <compass-saved-query-view>` for details.
 
 Learn More
 ----------
 
 - :ref:`compass-save-agg-pipeline`
 
-- :ref:`saved-query-view`
+- :ref:`compass-saved-query-view`
diff --git a/source/agg-pipeline-builder/save-agg-pipeline.txt b/source/agg-pipeline-builder/save-agg-pipeline.txt
@@ -15,7 +15,7 @@ Save a Pipeline
 You can save your aggregation pipelines to find and use them again later. If 
 you load a saved pipeline, you can make edits to the pipeline stages without 
 changing the original saved pipeline. You can also create a :ref:`view 
-<view-details>` from your pipeline results.
+<compass-view-details>` from your pipeline results.
 
 Steps
 -----
@@ -29,4 +29,4 @@ Learn More
 
 - :ref:`compass-create-a-view`
 
-- :ref:`saved-queries-agg`
+- :ref:`compass-saved-queries-agg`
diff --git a/source/collections.txt b/source/collections.txt
@@ -102,13 +102,13 @@ view:
 
 - :ref:`compass-agg-builder`
 
-- :ref:`Schema Analysis <schema-tab>`
+- :ref:`Schema Analysis <compass-schema-tab>`
 
 - :ref:`explain-plans`
 
 - :ref:`compass-indexes`
 
-- :ref:`validation`
+- :ref:`compass-validation`
 
 .. note:: Data Lake Limitations
 
diff --git a/source/collections/clustered-collection.txt b/source/collections/clustered-collection.txt
@@ -71,4 +71,4 @@ Next Steps
 
 - :ref:`Query Your Data<compass-query-bar>`
 
-- :ref:`Analyze Your Data Scheme <schema-tab>`
+- :ref:`Analyze Your Data Scheme <compass-schema-tab>`
diff --git a/source/connect/required-access.txt b/source/connect/required-access.txt
@@ -53,7 +53,7 @@ privileges:
      - :authrole:`readWrite`
 
    * - :guilabel:`Schema`
-     - :ref:`Query/View a Schema <schema-tab>`
+     - :ref:`Query/View a Schema <compass-schema-tab>`
      - :authaction:`find`
      - :authrole:`read`
 
@@ -87,12 +87,12 @@ privileges:
      - :authrole:`read`
 
    * - :guilabel:`Validation`
-     - :ref:`View rules <validation>`
+     - :ref:`View rules <compass-validation>`
      - :authaction:`listCollections`
      - :authrole:`read`
 
    * - :guilabel:`Validation`
-     - :ref:`Update rules <update-validation>`
+     - :ref:`Update rules <compass-update-validation>`
      - :authaction:`collMod`
      - :authrole:`dbAdmin`
 
diff --git a/source/documents.txt b/source/documents.txt
@@ -25,7 +25,7 @@ documents in your selected collection or view.
    For query result sets larger than 20 documents, Compass shows 
    paginated results. By default, pages display 20 documents at a time.
 
-From the :ref:`query bar <query-bar>`, you can specify a query to
+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/documents/modify-multiple.txt b/source/documents/modify-multiple.txt
@@ -99,7 +99,7 @@ Steps
 
       You can name and save the update query in the 
       :guilabel:`Update Documents` modal. Saving your query adds it 
-      to your :ref:`favorite queries <saved-favorite-query-view>` for 
+      to your :ref:`favorite queries <compass-saved-favorite-query-view>` for 
       that collection and allows you to load and copy the query after 
       you close the modal.
 
@@ -169,4 +169,4 @@ Learn More
 ----------
 
 - :ref:`compass-bulk-delete`
-- :ref:`saved-favorite-query-view`
+- :ref:`compass-saved-favorite-query-view`
diff --git a/source/editions.txt b/source/editions.txt
@@ -45,7 +45,7 @@ suit your needs.
      - |checkmark|
      - |checkmark|
 
-   * - :ref:`Schema Analysis <schema-tab>`
+   * - :ref:`Schema Analysis <compass-schema-tab>`
      - |checkmark|
      - |checkmark|
      - |checkmark|
@@ -55,7 +55,7 @@ suit your needs.
      - |checkmark|
      - |checkmark|
 
-   * - Create, delete and edit :ref:`document validation <validation>`
+   * - Create, delete and edit :ref:`document validation <compass-validation>`
        rules
      - |checkmark|
      - 
diff --git a/source/export-query-to-language.txt b/source/export-query-to-language.txt
@@ -44,10 +44,10 @@ Procedure
 #. *(Optional)*: Check the :guilabel:`Include Driver Syntax` option
    to include application code for the language selected. If you 
    include driver syntax, the copyable code reflects
-   :ref:`project <query-bar-project>`, :ref:`sort <query-bar-sort>`, 
-   :ref:`maxtimems <query-bar-max-time-ms>`, 
-   :ref:`collation <compass-query-bar-collation>`, :ref:`skip <query-bar-skip>` 
-   and :ref:`limit <query-bar-limit>` options.
+   :ref:`project <compass-query-bar-project>`, :ref:`sort <compass-query-bar-sort>`, 
+   :ref:`maxtimems <compass-query-bar-max-time-ms>`, 
+   :ref:`collation <compass-query-bar-collation>`, :ref:`skip <compass-query-bar-skip>` 
+   and :ref:`limit <compass-query-bar-limit>` options.
 
 #. Click :icon-fa5:`copy` at the top-right of the formatted
    query to copy the query for the selected language to your clipboard.
diff --git a/source/faq.txt b/source/faq.txt
@@ -82,7 +82,7 @@ Slow Sampling
 All queries that Compass sends to your MongoDB instance have a timeout
 flag set which automatically aborts a request if it takes longer than
 the specified timeout. This timeout is currently set to 10 seconds. If
-:ref:`sampling <sampling>` on the database takes longer, Compass will 
+:ref:`sampling <compass-sampling>` on the database takes longer, Compass will 
 notify you about the timeout and give you the options of (a) retrying 
 with a longer timeout (60 seconds) or (b) running a different query.
 
diff --git a/source/import-export.txt b/source/import-export.txt
@@ -156,7 +156,7 @@ Behavior
 
 - You can use a query filter to export only the documents that match the filter.
 
-- You can use the :ref:`Project <query-bar-project>` field in the query bar to 
+- You can use the :ref:`Project <compass-query-bar-project>` field in the query bar to 
   specify the fields to return or export. 
 
 Procedure
diff --git a/source/includes/extracts-query-bar.yaml b/source/includes/extracts-query-bar.yaml
@@ -4,7 +4,7 @@ content: |
    subset of the results.  Otherwise, Compass shows the entire result
    set.
    
-   For details on sampling, see :ref:`Sampling <sampling>`.
+   For details on sampling, see :ref:`Sampling <compass-sampling>`.
 ---
 ref: query-bar-type-schema
 content: |
diff --git a/source/includes/fact-natural-language-querying-maxTimems.rst b/source/includes/fact-natural-language-querying-maxTimems.rst
@@ -2,4 +2,4 @@ It can be difficult to predict the complexity of the query or pipeline
 returned by the Compass AI. You may need to adjust the 
 :guilabel:`MAX TIME MS` query bar option to either allow longer query 
 processing time or prevent long-running queries. For details, see 
-:ref:`query-bar-max-time-ms`.
+:ref:`compass-query-bar-max-time-ms`.
diff --git a/source/includes/steps-export-filter.yaml b/source/includes/steps-export-filter.yaml
@@ -49,7 +49,7 @@ content: |
      fields. Fields which only appear in a small percentage of 
      documents may not be automatically detected.
 
-     For details on sampling, see :ref:`Sampling <sampling>`.
+     For details on sampling, see :ref:`Sampling <compass-sampling>`.
 
 ---
 title: Select the appropriate file type.
diff --git a/source/indexes.txt b/source/indexes.txt
@@ -19,7 +19,7 @@ ordered by the value of the field.
 
 To improve query performance, build indexes on fields that appear often 
 in queries and for all operations that 
-:ref:`sort by a field <query-bar-sort>`.
+:ref:`sort by a field <compass-query-bar-sort>`.
 
 - Queries on an indexed field can use the index to limit the number of 
   documents that must be scanned to find matching documents.
diff --git a/source/instance.txt b/source/instance.txt
@@ -26,7 +26,7 @@ The Compass Home screen includes the following sections:
 
 - :ref:`Connections Sidebar <connections-sidebar>`
 
-- Your :ref:`saved queries and aggregation pipelines <view-favorite-queries>`. 
+- Your :ref:`saved queries and aggregation pipelines <compass-view-favorite-queries>`. 
 
 Once connected to a MongoDB instance, you can reach the Compass
 Home screen by clicking a cluster name in the :guilabel:`Connections
diff --git a/source/manage-data.txt b/source/manage-data.txt
@@ -27,18 +27,18 @@ Interact with Your Data
 :ref:`compass-indexes`
   Learn how to create indexes to improve query performance.
 
-:ref:`schema-tab`
+:ref:`compass-schema-tab`
   Learn how to analyze your data schema and shape of the fields in a
   particular collection.
 
 :ref:`compass-performance`
   Learn how to view and analyze deployment performance.
 
-:ref:`validation`
+:ref:`compass-validation`
   Learn how to ensure that all documents in a collection
   follow a defined set of rules.
 
-:ref:`sampling`
+:ref:`compass-sampling`
   Learn how |compass-short| samples documents to provide 
   insights about a collection.
 
diff --git a/source/query/filter.txt b/source/query/filter.txt
@@ -1,5 +1,4 @@
 .. _compass-query-bar-filter:
-.. _query-bar:
 .. _compass-query-bar:
 
 ===============
diff --git a/source/query/limit.txt b/source/query/limit.txt
@@ -1,4 +1,4 @@
-.. _query-bar-limit:
+.. _compass-query-bar-limit:
 
 ======================================
 Limit the Number of Returned Documents
diff --git a/source/query/maxtimems.txt b/source/query/maxtimems.txt
@@ -1,4 +1,4 @@
-.. _query-bar-max-time-ms:
+.. _compass-query-bar-max-time-ms:
 
 ========================================
 Adjust Maximum Time for Query Operations
diff --git a/source/query/project.txt b/source/query/project.txt
@@ -1,4 +1,4 @@
-.. _query-bar-project:
+.. _compass-query-bar-project:
 
 =============================
 Set Which Fields Are Returned
diff --git a/source/query/queries.txt b/source/query/queries.txt
@@ -1,4 +1,4 @@
-.. _saved-queries-agg:
+.. _compass-saved-queries-agg:
 
 =======================================
 Managing Saved Queries and Aggregations
@@ -31,13 +31,13 @@ Saving an Aggregation Pipeline
 You can save a pipeline so that you can find it later. If you
 load a saved pipeline, you can change it without
 changing the original saved copy. You can also create a :ref:`view
-<view-details>` from your pipeline results.
+<compass-view-details>` from your pipeline results.
 
 To save your pipeline: 
 
 .. include:: /includes/fact-save-pipeline.rst
 
-.. _favorite-queries:
+.. _compass-favorite-queries:
 
 Saving a Favorite Query
 -----------------------
@@ -50,7 +50,7 @@ To add a query to your favorites:
 
 .. include:: /includes/fact-favorite-query.rst
 
-.. _view-favorite-queries:
+.. _compass-view-favorite-queries:
 
 Viewing Saved Queries
 ---------------------
@@ -59,7 +59,7 @@ Starting in |compass| 1.31, you can view your saved queries
 and aggregation pipelines on the :guilabel:`My Queries` tab 
 once connected to your cluster.
 
-.. _saved-query-view:
+.. _compass-saved-query-view:
 
 Using the :guilabel:`My Queries` Tab
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -70,7 +70,7 @@ When you click a saved or favorite query tile, Compass opens the
 When you click a saved or favorite pipeline tile, Compass opens the 
 :guilabel:`Aggregations` tab with the pipeline loaded.
 
-.. _saved-favorite-query-view:
+.. _compass-saved-favorite-query-view:
 
 Using the :guilabel:`Favorites` Tab 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -85,7 +85,7 @@ Viewing Query History
 ---------------------
 
 For details on how to view query history see
-:ref:`viewing recent query history <recent-queries>`.
+:ref:`viewing recent query history <compass-recent-queries>`.
 
 .. toctree::
    :titlesonly:
diff --git a/source/query/recent.txt b/source/query/recent.txt
@@ -1,5 +1,5 @@
-.. _recent-queries:
-.. _past-query-view:
+.. _compass-recent-queries:
+.. _compass-past-query-view:
 
 ===================
 View Recent Queries
@@ -32,7 +32,7 @@ You can also hover over a query and perform the following actions:
      - Action
 
    * - :icon-fa5:`star`
-     - Save the query as a :ref:`favorite <favorite-queries>`. Specify
+     - Save the query as a :ref:`favorite <compass-favorite-queries>`. Specify
        a name for the query and click :guilabel:`Save`.
 
    * - :icon-fa5:`copy`
@@ -64,4 +64,4 @@ include those fields.
 .. seealso::
 
    To learn how to write queries to filter your data, see
-   :ref:`query-bar`.
+   :ref:`compass-query-bar`.
diff --git a/source/query/skip.txt b/source/query/skip.txt
@@ -1,4 +1,4 @@
-.. _query-bar-skip:
+.. _compass-query-bar-skip:
 
 ==========================
 Skip a Number of Documents
diff --git a/source/query/sort.txt b/source/query/sort.txt
@@ -1,4 +1,4 @@
-.. _query-bar-sort:
+.. _compass-query-bar-sort:
 
 ===========================
 Sort the Returned Documents
diff --git a/source/release-notes.txt b/source/release-notes.txt
diff --git a/source/sampling.txt b/source/sampling.txt
diff --git a/source/schema.txt b/source/schema.txt
diff --git a/source/schema/export.txt b/source/schema/export.txt
diff --git a/source/settings/restrict-outgoing-connections.txt b/source/settings/restrict-outgoing-connections.txt
diff --git a/source/validation.txt b/source/validation.txt
diff --git a/source/views.txt b/source/views.txt

Original file line number	Diff line number	Diff line change
`@@ -64,4 +64,4 @@ Learn More`
`64`	`64`
`65`	`65`	- :ref:`compass-interface-settings`
`66`	`66`
`67`		-- :ref:`query-bar-max-time-ms`
	`67`	+- :ref:`compass-query-bar-max-time-ms`
Original file line number	Diff line number	Diff line change
`@@ -71,4 +71,4 @@ Next Steps`
`71`	`71`
`72`	`72`	- :ref:`Query Your Data<compass-query-bar>`
`73`	`73`
`74`		-- :ref:`Analyze Your Data Scheme <schema-tab>`
	`74`	+- :ref:`Analyze Your Data Scheme <compass-schema-tab>`