DOCSP-44714-compass-ref-prefix-replacements (#688)

* DOCSP-44714-compass-ref-prefix-replacements * * * build errors * typo
mongodb · Oct 31, 2024 · e1bf9ce · e1bf9ce
1 parent bf9b454
commit e1bf9ce
Show file tree

Hide file tree

Showing 53 changed files with 131 additions and 131 deletions.
diff --git a/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt b/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt
@@ -1,4 +1,4 @@
-.. _pipeline-builder-settings: 
+.. _compass-pipeline-builder-settings: 
 
 =====================================
 Aggregation Pipeline Builder Settings
@@ -49,8 +49,8 @@ the upper right of the pipeline builder to open the :guilabel:`Settings` panel.
 Learn More 
 ----------
 
-- :ref:`create-agg-pipeline`
+- :ref:`compass-create-agg-pipeline`
 
-- :ref:`pipeline-custom-collation`
+- :ref:`compass-pipeline-custom-collation`
 
-- :ref:`set-maxtime-ms-agg`
+- :ref:`compass-set-maxtime-ms-agg`
diff --git a/source/agg-pipeline-builder/count-pipeline-results.txt b/source/agg-pipeline-builder/count-pipeline-results.txt
@@ -1,4 +1,4 @@
-.. _count-pipeline-results:
+.. _compass-count-pipeline-results:
 
 ================================
 Count Pipeline Results Documents
@@ -26,7 +26,7 @@ Before You Begin
 ----------------
 
 To count result documents, you must first :ref:`create and run 
-<create-agg-pipeline>` your aggregation pipeline. You can't count result 
+<compass-create-agg-pipeline>` your aggregation pipeline. You can't count result 
 documents while editing your pipeline.
 
 Steps

diff --git a/source/agg-pipeline-builder/create-a-view.txt b/source/agg-pipeline-builder/create-a-view.txt
@@ -1,4 +1,4 @@
-.. _create-a-view:
+.. _compass-create-a-view:
 
 ===================================
 Create a View from Pipeline Results

diff --git a/source/agg-pipeline-builder/export-pipeline-results.txt b/source/agg-pipeline-builder/export-pipeline-results.txt
@@ -1,4 +1,4 @@
-.. _export-agg-builder-results:
+.. _compass-export-agg-builder-results:
 
 ===================================
 Export Aggregation Pipeline Results

diff --git a/source/agg-pipeline-builder/export-pipeline-to-language.txt b/source/agg-pipeline-builder/export-pipeline-to-language.txt
@@ -61,7 +61,7 @@ Steps
       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 <query-bar-collation>`, 
+      <query-bar-max-time-ms>`, :ref:`collation <compass-query-bar-collation>`, 
       :ref:`skip <query-bar-skip>` and :ref:`limit <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
@@ -1,4 +1,4 @@
-.. _set-maxtime-ms-agg:
+.. _compass-set-maxtime-ms-agg:
 
 =======================================
 Set Max Time MS for Aggregation Queries

diff --git a/source/agg-pipeline-builder/open-saved-pipeline.txt b/source/agg-pipeline-builder/open-saved-pipeline.txt
@@ -1,4 +1,4 @@
-.. _open-saved-pipeline:
+.. _compass-open-saved-pipeline:
 
 =====================
 Open a Saved Pipeline
@@ -20,9 +20,9 @@ Before You Begin
 
 If you don't already have a saved pipeline, you must first: 
 
-- :ref:`Create an aggregation pipeline <create-agg-pipeline>`.
+- :ref:`Create an aggregation pipeline <compass-create-agg-pipeline>`.
 
-- :ref:`Save your aggregation pipeline <save-agg-pipeline>`.
+- :ref:`Save your aggregation pipeline <compass-save-agg-pipeline>`.
 
 Steps
 -----
@@ -62,6 +62,6 @@ Steps
 Learn More
 ----------
 
-- :ref:`save-agg-pipeline`
+- :ref:`compass-save-agg-pipeline`
 
 - :ref:`saved-query-view`
diff --git a/source/agg-pipeline-builder/pipeline-custom-collation.txt b/source/agg-pipeline-builder/pipeline-custom-collation.txt
@@ -1,4 +1,4 @@
-.. _pipeline-custom-collation:
+.. _compass-pipeline-custom-collation:
 
 ==========================================
 Specify Custom Collation For Your Pipeline

diff --git a/source/agg-pipeline-builder/save-agg-pipeline.txt b/source/agg-pipeline-builder/save-agg-pipeline.txt
@@ -1,4 +1,4 @@
-.. _save-agg-pipeline:
+.. _compass-save-agg-pipeline:
 
 ===============
 Save a Pipeline
@@ -25,8 +25,8 @@ Steps
 Learn More
 ----------
 
-- :ref:`open-saved-pipeline`
+- :ref:`compass-open-saved-pipeline`
 
-- :ref:`create-a-view`
+- :ref:`compass-create-a-view`
 
 - :ref:`saved-queries-agg`
diff --git a/source/agg-pipeline-builder/view-pipeline-explain-plan.txt b/source/agg-pipeline-builder/view-pipeline-explain-plan.txt
@@ -1,4 +1,4 @@
-.. _view-pipeline-explain-plans:
+.. _compass-view-pipeline-explain-plans:
 
 =================================
 View Explain Plans for a Pipeline

diff --git a/source/collections.txt b/source/collections.txt
@@ -1,4 +1,4 @@
-.. _collection-tab:
+.. _compass-collection-tab:
 
 ===========
 Collections
@@ -23,7 +23,7 @@ A collection is a grouping of MongoDB
 :ref:`documents <compass-documents>`. Documents within a collection can
 have different fields. A collection is the equivalent of a
 table in a relational database system. A collection exists within a
-single :ref:`database <database-tab>`
+single :ref:`database <compass-database-tab>`.
 
 Collections Screen
 ------------------
@@ -61,7 +61,7 @@ information for each collection in the selected database:
   collection. Hover over a :guilabel:`Collation` banner to view
   the properties for that collection.
 
-.. _create-collection:
+.. _compass-create-collection:
 
 Create a Collection
 -------------------
@@ -70,7 +70,7 @@ You can create new collections in an existing database.
 
 .. include:: /includes/steps/create-collection.rst
 
-.. _drop-collection:
+.. _compass-drop-collection:
 
 Drop a Collection
 -----------------
@@ -89,7 +89,7 @@ collection details, either:
 
 - Click a collection in the left navigation.
 
-- Open the collection in a :ref:`new tab <tabbed-view>`.
+- Open the collection in a :ref:`new tab <compass-tabbed-view>`.
 
 After you select a collection, |compass-short| shows you that
 collection's :ref:`Documents tab <compass-documents>`. |compass-short| provides
@@ -125,7 +125,7 @@ view:
 
    - Set Validation Rules for Your Schema
 
-.. _tabbed-view:
+.. _compass-tabbed-view:
 
 Tabbed View
 ~~~~~~~~~~~

diff --git a/source/collections/capped-collection.txt b/source/collections/capped-collection.txt
@@ -1,4 +1,4 @@
-.. _capped-collection:
+.. _compass-capped-collection:
 
 ==========================
 Create a Capped Collection

diff --git a/source/collections/clustered-collection.txt b/source/collections/clustered-collection.txt
@@ -1,4 +1,4 @@
-.. _clustered-collection:
+.. _compass-clustered-collection:
 
 =============================
 Create a Clustered Collection

diff --git a/source/collections/collation-collection.txt b/source/collections/collation-collection.txt
@@ -1,4 +1,4 @@
-.. _collation-collection:
+.. _compass-collation-collection:
 
 ==================================
 Create a Collection with Collation

diff --git a/source/collections/encrypted-collection.txt b/source/collections/encrypted-collection.txt
@@ -1,4 +1,4 @@
-.. _encrypted-collection:
+.. _compass-encrypted-collection:
 
 =============================================
 Create a Collection with Queryable Encryption

diff --git a/source/collections/time-series-collection.txt b/source/collections/time-series-collection.txt
@@ -1,4 +1,4 @@
-.. _time-series-collection:
+.. _compass-time-series-collection:
 
 ===============================
 Create a Time Series Collection

diff --git a/source/connect/connections.txt b/source/connect/connections.txt
@@ -60,7 +60,7 @@ to interact with to open the :guilabel:`Databases` tab. When you open a
 database, MongoDB opens a new tab and labels it with the name of the
 MongoDB instance that contains that database. For more information about
 the :guilabel:`Databases` tab and instructions on viewing a database,
-see :ref:`Databases <database-tab>`.
+see :ref:`Databases <compass-database-tab>`.
 
 Connection Options
 ------------------

diff --git a/source/connect/required-access.txt b/source/connect/required-access.txt
@@ -33,22 +33,22 @@ privileges:
      - :authrole:`clusterMonitor`
 
    * - :guilabel:`Database`
-     - :ref:`create-database`
+     - :ref:`compass-create-database`
      - :authaction:`createCollection`
      - :authrole:`readWrite`
 
    * - :guilabel:`Database`
-     - :ref:`drop-database`
+     - :ref:`compass-drop-database`
      - :authaction:`dropDatabase`
      - :authrole:`dbAdmin`
 
    * - :guilabel:`Collection`
-     - :ref:`create-collection`
+     - :ref:`compass-create-collection`
      - :authaction:`createCollection`
      - :authrole:`readWrite`
 
    * - :guilabel:`Collection`
-     - :ref:`drop-collection`
+     - :ref:`compass-drop-collection`
      - :authaction:`dropCollection`
      - :authrole:`readWrite`
 

diff --git a/source/create-agg-pipeline.txt b/source/create-agg-pipeline.txt
@@ -1,5 +1,5 @@
 .. _compass-agg-builder:
-.. _create-agg-pipeline:
+.. _compass-create-agg-pipeline:
 
 ==============================
 Create an Aggregation Pipeline
@@ -369,7 +369,7 @@ Learn More
 
 - :manual:`Aggregation Pipeline Stages </reference/operator/aggregation-pipeline/>`
 
-- :ref:`pipeline-builder-settings`
+- :ref:`compass-pipeline-builder-settings`
 
 - :ref:`compass-export-pipeline`
 

diff --git a/source/databases.txt b/source/databases.txt
@@ -1,4 +1,4 @@
-.. _database-tab:
+.. _compass-database-tab:
 
 =========
 Databases
@@ -12,7 +12,7 @@ Databases
    :depth: 1
    :class: singlecol
 
-A database is a container for :ref:`collections <collection-tab>`.
+A database is a container for :ref:`collections <compass-collection-tab>`.
 Each database gets its own set of files on the host file system.
 A single MongoDB server typically has multiple databases.
 
@@ -28,20 +28,20 @@ deployment name in the :guilabel:`Connections Sidebar`.
    :alt: Databases View
 
 From this view, you can click a database name in the sidebar to view its
-:ref:`collections <collection-tab>`. Alternatively, you can view
-database collections by clicking the desired database in the left-hand navigation.
+collections. Alternatively, you can view database collections by clicking the 
+desired database in the left-hand navigation.
 
-You can also :ref:`create <create-database>` or
-:ref:`drop databases <drop-database>` from this view.
+You can also :ref:`create <compass-create-database>` or
+:ref:`drop databases <compass-drop-database>` from this view.
 
-.. _create-database:
+.. _compass-create-database:
 
 Create a Database
 -----------------
 
 .. include:: /includes/steps/create-database.rst
 
-.. _drop-database:
+.. _compass-drop-database:
 
 Drop a Database
 ---------------

diff --git a/source/documents.txt b/source/documents.txt
@@ -7,15 +7,15 @@ Manage Documents
 .. default-domain:: mongodb
 
 Documents are individual records in a MongoDB :ref:`collection
-<collection-tab>` and are the basic unit of data in MongoDB.
+<compass-collection-tab>` and are the basic unit of data in MongoDB.
 
-.. _documents-tab:
+.. _compass-documents-tab:
 
 From the :guilabel:`Documents` tab, you can
-:ref:`view <compass-view-documents>`, :ref:`insert <insert-documents>`,
+:ref:`view <compass-view-documents>`, :ref:`insert <compass-insert-documents>`,
 :ref:`modify <compass-modify-documents>`, 
 :ref:`modify multiple <compass-bulk-update>`,
-:ref:`clone <clone-documents>`,
+:ref:`clone <compass-clone-documents>`,
 :ref:`delete <compass-delete-documents>`, and 
 :ref:`delete multiple <compass-bulk-delete>` 
 documents in your selected collection or view.
@@ -32,10 +32,10 @@ specify query options.
 .. seealso::
 
    - :ref:`compass-view-documents`
-   - :ref:`insert-documents`
+   - :ref:`compass-insert-documents`
    - :ref:`compass-modify-documents`
    - :ref:`compass-bulk-update`
-   - :ref:`clone-documents`
+   - :ref:`compass-clone-documents`
    - :ref:`compass-delete-documents`
    - :ref:`compass-bulk-delete`
 

diff --git a/source/documents/clone.txt b/source/documents/clone.txt
@@ -1,4 +1,4 @@
-.. _clone-documents:
+.. _compass-clone-documents:
 
 ===============
 Clone Documents
@@ -63,4 +63,4 @@ When you click the :guilabel:`Clone` button, |compass-short| opens the
 document insertion dialog with the same schema and values as the cloned
 document. You can edit any of these fields and values before you insert
 the new document. To learn more about inserting documents, see
-:ref:`insert-documents`.
+:ref:`compass-insert-documents`.
diff --git a/source/documents/insert.txt b/source/documents/insert.txt
@@ -1,4 +1,4 @@
-.. _insert-documents:
+.. _compass-insert-documents:
 
 ================
 Insert Documents

diff --git a/source/documents/view.txt b/source/documents/view.txt
@@ -1,7 +1,7 @@
 .. _compass-view-documents:
-.. _docs-list-table-view:
-.. _documents-table-view:
-.. _documents-list-view:
+.. _compass-docs-list-table-view:
+.. _compass-documents-table-view:
+.. _compass-documents-list-view:
 
 ==============
 View Documents

diff --git a/source/editions.txt b/source/editions.txt
@@ -17,8 +17,8 @@ suit your needs.
      - Compass Isolated
 
    * - Interact with :ref:`documents <compass-documents>`,
-       :ref:`collections <collection-tab>`, and
-       :ref:`databases <database-tab>` with full CRUD functionality
+       :ref:`collections <compass-collection-tab>`, and
+       :ref:`databases <compass-database-tab>` with full CRUD functionality
      - |checkmark|
      - 
      - |checkmark|

diff --git a/source/export-query-to-language.txt b/source/export-query-to-language.txt
@@ -46,7 +46,7 @@ Procedure
    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 <query-bar-collation>`, :ref:`skip <query-bar-skip>` 
+   :ref:`collation <compass-query-bar-collation>`, :ref:`skip <query-bar-skip>` 
    and :ref:`limit <query-bar-limit>` options.
 
 #. Click :icon-fa5:`copy` at the top-right of the formatted