DOCSP-44665-audit-compass-refs (#687)

ajhuh-mdb · web-flow · commit bf9b454fe1bc · 2024-10-29T13:42:23.000-04:00
* DOCSP-44665-audit-compass-refs

* replace :doc: directives
diff --git a/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt b/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt
@@ -1,6 +1,4 @@
 .. _pipeline-builder-settings: 
-.. _change-pipeline-settings:
-.. _use-sample-mode-or-auto-preview:
 
 =====================================
 Aggregation Pipeline Builder Settings
diff --git a/source/agg-pipeline-builder/count-pipeline-results.txt b/source/agg-pipeline-builder/count-pipeline-results.txt
@@ -1,4 +1,3 @@
-.. _refresh-document-counts:
 .. _count-pipeline-results:
 
 ================================
diff --git a/source/collections.txt b/source/collections.txt
@@ -25,8 +25,6 @@ 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>`
 
-.. _collections-screen-collections:
-
 Collections Screen
 ------------------
 
@@ -41,7 +39,7 @@ The :guilabel:`Collections` screen displays the following
 information for each collection in the selected database:
 
 - Collection name
-- Number of :doc:`documents </documents>` in the collection
+- Number of :ref:`documents <compass-documents>` in the collection
  
   .. note::
 
@@ -57,7 +55,7 @@ information for each collection in the selected database:
 
 - Average size of documents in the collection
 - Total size of all documents in the collection
-- Number of :doc:`indexes </indexes>` on the collection
+- Number of :ref:`indexes <compass-indexes>` on the collection
 - Total size of all indexes on the collection
 - :manual:`Collation </reference/collation/>` properties for the
   collection. Hover over a :guilabel:`Collation` banner to view
@@ -79,8 +77,6 @@ Drop a Collection
 
 .. include:: /includes/steps/delete-collection.rst
 
-.. _collection-details:
-
 Collection Details
 ------------------
 
@@ -96,23 +92,23 @@ collection details, either:
 - Open the collection in a :ref:`new tab <tabbed-view>`.
 
 After you select a collection, |compass-short| shows you that
-collection's :doc:`Documents tab </documents>`. |compass-short| provides
+collection's :ref:`Documents tab <compass-documents>`. |compass-short| provides
 the following collection information and functionality in the detailed
 view:
 
-- :doc:`/documents`
+- :ref:`compass-documents`
 
-- :doc:`Import and Export Data </import-export/>` to / from the collection
+- :ref:`compass-import-export` to and from the collection
 
 - :ref:`compass-agg-builder`
 
-- :doc:`Schema Analysis </schema>`
+- :ref:`Schema Analysis <schema-tab>`
 
-- :doc:`/query-plan`
+- :ref:`explain-plans`
 
-- :doc:`/indexes`
+- :ref:`compass-indexes`
 
-- :doc:`/validation`
+- :ref:`validation`
 
 .. note:: Data Lake Limitations
 
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 :doc:`Databases </databases>`.
+see :ref:`Databases <database-tab>`.
 
 Connection Options
 ------------------
diff --git a/source/connect/required-access.txt b/source/connect/required-access.txt
@@ -24,7 +24,7 @@ privileges:
      - MongoDB Built-In Role
 
    * - :guilabel:`Home/MongoDB Instance`
-     - :doc:`View performance </performance>`
+     - :ref:`View performance <compass-performance>`
      - | :authaction:`dbStats`
        | :authaction:`getCmdLineOpts`
        | :authaction:`inprog`
@@ -53,41 +53,41 @@ privileges:
      - :authrole:`readWrite`
 
    * - :guilabel:`Schema`
-     - :doc:`Query/View a Schema </schema>`
+     - :ref:`Query/View a Schema <schema-tab>`
      - :authaction:`find`
      - :authrole:`read`
 
    * - :guilabel:`Documents`
-     - :doc:`Query/View a Document </documents>` 
+     - :ref:`Query/View a Document <compass-documents>` 
      - :authaction:`find`
      - :authrole:`read`
 
    * - :guilabel:`Documents`
-     - :doc:`Clone, insert, update, delete a document </documents>` 
+     - :ref:`Clone, insert, update, delete a document <compass-documents>` 
      - | :authaction:`find`
        | :authaction:`insert`
        | :authaction:`update`
        | :authaction:`remove`
      - :authrole:`readWrite`
 
    * - :guilabel:`Indexes`
-     - :doc:`View an index </indexes>`
+     - :ref:`View an index <compass-indexes>`
      - :authaction:`listIndexes`
      - :authrole:`read`
 
    * - :guilabel:`Indexes`
-     - :doc:`Create, drop an index </indexes>`
+     - :ref:`Create, drop an index <compass-indexes>`
      - | :authaction:`createIndex`
        | :authaction:`dropIndex`
      - :authrole:`readWrite`
 
    * - :guilabel:`Explain Plan`
-     - :doc:`Query/View a query plan </query-plan>`
+     - :ref:`Query/View a query plan <explain-plans>`
      - :authaction:`find`
      - :authrole:`read`
 
    * - :guilabel:`Validation`
-     - :doc:`View rules </validation>`
+     - :ref:`View rules <validation>`
      - :authaction:`listCollections`
      - :authrole:`read`
 
diff --git a/source/databases.txt b/source/databases.txt
@@ -28,7 +28,7 @@ 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
-:doc:`collections </collections>`. Alternatively, you can view
+:ref:`collections <collection-tab>`. Alternatively, you can view
 database collections by clicking the desired database in the left-hand navigation.
 
 You can also :ref:`create <create-database>` or
diff --git a/source/documents.txt b/source/documents.txt
@@ -31,12 +31,12 @@ specify query options.
 
 .. seealso::
 
-   - :doc:`/documents/view`
-   - :doc:`/documents/insert`
-   - :doc:`/documents/modify`
+   - :ref:`compass-view-documents`
+   - :ref:`insert-documents`
+   - :ref:`compass-modify-documents`
    - :ref:`compass-bulk-update`
-   - :doc:`/documents/clone`
-   - :doc:`/documents/delete`
+   - :ref:`clone-documents`
+   - :ref:`compass-delete-documents`
    - :ref:`compass-bulk-delete`
 
 .. toctree::
diff --git a/source/editions.txt b/source/editions.txt
@@ -45,12 +45,12 @@ suit your needs.
      - |checkmark|
      - |checkmark|
 
-   * - :doc:`Schema Analysis </schema>`
+   * - :ref:`Schema Analysis <schema-tab>`
      - |checkmark|
      - |checkmark|
      - |checkmark|
 
-   * - :doc:`Real Time Server Stats </performance>`
+   * - :ref:`Real Time Server Stats <compass-performance>`
      - |checkmark|
      - |checkmark|
      - |checkmark|
diff --git a/source/import-export.txt b/source/import-export.txt
@@ -25,10 +25,10 @@ Import and Export Data
    :keywords: atlas
 
 You can use |compass| to import and export data to and from
-:doc:`collections </collections>`. |compass-short| supports import and
+:ref:`collections <collection-tab>`. |compass-short| supports import and
 export for both **JSON** and **CSV** files. To import or export data to
 or from a collection, navigate to the detailed collection view by either
-selecting the collection from the :doc:`Databases </databases>` tab or
+selecting the collection from the :ref:`Databases <database-tab>` tab or
 clicking the collection in the left-side navigation.
 
 .. note::
@@ -190,15 +190,15 @@ Procedure
       .. procedure::
          :style: normal
 
-         .. step:: Connect to the deployment containing the :doc:`collection </collections>` you wish to export data from.
+         .. step:: Connect to the deployment containing the :ref:`collection <collection-tab>` you wish to export data from.
 
             To learn how to connect to a deployment, see
             :ref:`connect-run-compass`.
 
          .. step:: Navigate to your target collection.
 
             You can either select the collection from the
-            :doc:`Collections </collections>` tab or click the collection 
+            :ref:`Collections <collection-tab>` tab or click the collection 
             in the left-hand pane. 
 
          .. step:: Create an aggregation pipeline and run for results. 
diff --git a/source/includes/fact-collections-screen.rst b/source/includes/fact-collections-screen.rst
@@ -5,7 +5,7 @@ list item includes the name and other general information for
 the collection or view.
 
 To access the :guilabel:`Collections` screen for a database, from the
-:doc:`Databases screen </databases>` either:
+:ref:`Databases screen <database-tab>` either:
 
 - Click a :guilabel:`Database Name` in the main :guilabel:`Databases`
   view, or
diff --git a/source/includes/starting-compass-paste-string.rst b/source/includes/starting-compass-paste-string.rst
@@ -50,7 +50,7 @@
    .. step:: Connect to your cluster.
 
       Click :guilabel:`Save` or :guilabel:`Save & Connect` to navigate to the 
-      |compass-short| :doc:`Home Page </instance>`. 
+      |compass-short| :ref:`Home Page <compass-home-screen>`. 
 
       .. important:: Required Access
         
diff --git a/source/includes/steps-export-filter.yaml b/source/includes/steps-export-filter.yaml
@@ -1,5 +1,5 @@
 title: Connect to the deployment containing the
-       :doc:`collection </collections>` you wish to export data from.
+       :ref:`collection <collection-tab>` you wish to export data from.
 level: 4
 ref: connect-deployment
 content: |
@@ -11,7 +11,7 @@ level: 4
 ref: select-collection
 content: |
   You can either select the collection from the
-  :doc:`Collections </collections>` tab or click the collection in the
+  :ref:`Collections <collection-tab>` tab or click the collection in the
   left-hand pane.
 ---
 title: Specify a filter in the :guilabel:`query bar`.
diff --git a/source/includes/steps-export.yaml b/source/includes/steps-export.yaml
@@ -1,5 +1,5 @@
 title: Connect to the deployment containing the
-       :doc:`collection </collections>` you wish to export data from.
+       :ref:`collection <collection-tab>` you wish to export data from.
 level: 4
 ref: connect-deployment
 content: |
@@ -11,7 +11,7 @@ level: 4
 ref: select-collection
 content: |
   You can either select the collection from the
-  :doc:`Collections </collections>` tab or click the collection in the
+  :ref:`Collections <collection-tab>` tab or click the collection in the
   left-hand pane.
 ---
 title: Click the :guilabel:`Export Data` dropdown and select :guilabel:`Export the full collection`.
diff --git a/source/includes/steps-import.yaml b/source/includes/steps-import.yaml
@@ -1,5 +1,5 @@
 title: Connect to the deployment containing the
-       :doc:`collection </collections>` you wish to import data into.
+       :ref:`collection <collection-tab>` you wish to import data into.
 level: 4
 ref: connect-deployment
 content: |
@@ -11,7 +11,7 @@ level: 4
 ref: select-collection
 content: |
   You can either select the collection from the
-  :doc:`Collections </collections>` tab or click the collection in the
+  :ref:`Collections <collection-tab>` tab or click the collection in the
   left-hand pane.
 ---
 title: Click the :guilabel:`Add Data` dropdown and select 
diff --git a/source/index.txt b/source/index.txt
@@ -20,7 +20,7 @@ What is MongoDB Compass?
    .. button:: Download Compass
       :uri: https://www.mongodb.com/try/download/compass
 
-   :doc:`View installation instructions <install>`
+   :ref:`View installation instructions <download-install>`
 
 .. image:: /images/hero-border.png
    :alt: Homepage hero image
diff --git a/source/indexes.txt b/source/indexes.txt
@@ -127,8 +127,6 @@ input.
    |compass-short| shows the type of your new index as
    :guilabel:`Wildcard`.
 
-.. _hide-index:
-
 Hide or Unhide an Index
 -----------------------
 
diff --git a/source/instance.txt b/source/instance.txt
@@ -1,3 +1,5 @@
+.. _compass-home-screen:
+
 ============
 Compass Home
 ============
diff --git a/source/manage-data.txt b/source/manage-data.txt
@@ -6,43 +6,43 @@ Interact with Your Data
 
 .. include:: /includes/atlas-sample-data-note.rst
 
-:doc:`/databases`
+:ref:`database-tab`
   Learn how to create and manage databases in your deployment.
 
-:doc:`/collections`
+:ref:`collection-tab`
   Learn how to manage collections in your databases.
 
-:doc:`/views`
+:ref:`compass-views`
   Learn how to manage views in your databases. Views are read-only
   results of an :ref:`aggregation <compass-agg-builder>` run against
   a collection.
 
-:doc:`/documents`
+:ref:`compass-documents`
   Learn how to manage documents in your collections.
 
-:doc:`/query/filter`
+:ref:`query-bar-filter`
   Learn how to query your data to return data that matches a specified
   criteria.
 
-:doc:`/indexes`
+:ref:`compass-indexes`
   Learn how to create indexes to improve query performance.
 
-:doc:`/schema`
+:ref:`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.
 
-:doc:`/validation`
+:ref:`validation`
   Learn how to ensure that all documents in a collection
   follow a defined set of rules.
 
-:doc:`/sampling`
+:ref:`sampling`
   Learn how |compass-short| samples documents to provide 
   insights about a collection.
 
-:doc:`/in-use-encryption-tutorial`
+:ref:`encryption-tutorial`
   Learn how to use In-Use Encryption to encrypt data in your collections.
 
 .. toctree::
diff --git a/source/query/filter.txt b/source/query/filter.txt
@@ -449,8 +449,6 @@ Clear the Query
 
 .. include:: /includes/clear-query.rst
 
-.. _compass-query-invalid-utf8-data:
-
 Query Collections with Invalid UTF8 Data
 ----------------------------------------
 
diff --git a/source/release-notes.txt b/source/release-notes.txt
diff --git a/source/troubleshooting.txt b/source/troubleshooting.txt
diff --git a/source/troubleshooting/connection-errors.txt b/source/troubleshooting/connection-errors.txt
diff --git a/source/validation.txt b/source/validation.txt

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-.. _refresh-document-counts:`
`2`	`1`	`.. _count-pipeline-results:`
`3`	`2`
`4`	`3`	`================================`