diff --git a/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt b/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt index 4e7438e71..e5e780037 100644 --- 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 index 4104298b5..946bd9c92 100644 --- 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 index 12e3ecd64..bf9e8c0ac 100644 --- 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 ` -.. _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 ` in the collection +- Number of :ref:`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 ` on the collection +- Number of :ref:`indexes ` on the collection - Total size of all indexes on the collection - :manual:`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 `. After you select a collection, |compass-short| shows you that -collection's :doc:`Documents tab `. |compass-short| provides +collection's :ref:`Documents tab `. |compass-short| provides the following collection information and functionality in the detailed view: -- :doc:`/documents` +- :ref:`compass-documents` -- :doc:`Import and Export Data ` to / from the collection +- :ref:`compass-import-export` to and from the collection - :ref:`compass-agg-builder` -- :doc:`Schema Analysis ` +- :ref:`Schema Analysis ` -- :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 index a1e15c535..e1d094ed1 100644 --- 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 `. +see :ref:`Databases `. Connection Options ------------------ diff --git a/source/connect/required-access.txt b/source/connect/required-access.txt index a4f479b1c..0aee95c40 100644 --- 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 ` + - :ref:`View performance ` - | :authaction:`dbStats` | :authaction:`getCmdLineOpts` | :authaction:`inprog` @@ -53,17 +53,17 @@ privileges: - :authrole:`readWrite` * - :guilabel:`Schema` - - :doc:`Query/View a Schema ` + - :ref:`Query/View a Schema ` - :authaction:`find` - :authrole:`read` * - :guilabel:`Documents` - - :doc:`Query/View a Document ` + - :ref:`Query/View a Document ` - :authaction:`find` - :authrole:`read` * - :guilabel:`Documents` - - :doc:`Clone, insert, update, delete a document ` + - :ref:`Clone, insert, update, delete a document ` - | :authaction:`find` | :authaction:`insert` | :authaction:`update` @@ -71,23 +71,23 @@ privileges: - :authrole:`readWrite` * - :guilabel:`Indexes` - - :doc:`View an index ` + - :ref:`View an index ` - :authaction:`listIndexes` - :authrole:`read` * - :guilabel:`Indexes` - - :doc:`Create, drop an index ` + - :ref:`Create, drop an index ` - | :authaction:`createIndex` | :authaction:`dropIndex` - :authrole:`readWrite` * - :guilabel:`Explain Plan` - - :doc:`Query/View a query plan ` + - :ref:`Query/View a query plan ` - :authaction:`find` - :authrole:`read` * - :guilabel:`Validation` - - :doc:`View rules ` + - :ref:`View rules ` - :authaction:`listCollections` - :authrole:`read` diff --git a/source/databases.txt b/source/databases.txt index 4cdb59ef6..015c06979 100644 --- 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 `. Alternatively, you can view +:ref:`collections `. Alternatively, you can view database collections by clicking the desired database in the left-hand navigation. You can also :ref:`create ` or diff --git a/source/documents.txt b/source/documents.txt index 924adc157..e618f752d 100644 --- 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 index 3f592f527..09ee74615 100644 --- a/source/editions.txt +++ b/source/editions.txt @@ -45,12 +45,12 @@ suit your needs. - |checkmark| - |checkmark| - * - :doc:`Schema Analysis ` + * - :ref:`Schema Analysis ` - |checkmark| - |checkmark| - |checkmark| - * - :doc:`Real Time Server Stats ` + * - :ref:`Real Time Server Stats ` - |checkmark| - |checkmark| - |checkmark| diff --git a/source/import-export.txt b/source/import-export.txt index a2d94dc5b..635f3f9ea 100644 --- 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 `. |compass-short| supports import and +:ref:`collections `. |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 ` tab or +selecting the collection from the :ref:`Databases ` tab or clicking the collection in the left-side navigation. .. note:: @@ -190,7 +190,7 @@ Procedure .. procedure:: :style: normal - .. step:: Connect to the deployment containing the :doc:`collection ` you wish to export data from. + .. step:: Connect to the deployment containing the :ref:`collection ` you wish to export data from. To learn how to connect to a deployment, see :ref:`connect-run-compass`. @@ -198,7 +198,7 @@ Procedure .. step:: Navigate to your target collection. You can either select the collection from the - :doc:`Collections ` tab or click the collection + :ref:`Collections ` 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 index bf3cf632a..7ffdf401e 100644 --- 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 ` either: +:ref:`Databases screen ` 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 index d02f5d8c8..38dcd56a7 100644 --- 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 `. + |compass-short| :ref:`Home Page `. .. important:: Required Access diff --git a/source/includes/steps-export-filter.yaml b/source/includes/steps-export-filter.yaml index a2a20fe56..beac09615 100644 --- 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 ` you wish to export data from. + :ref:`collection ` 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 ` tab or click the collection in the + :ref:`Collections ` 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 index 16b3d4e47..2ad451a3e 100644 --- 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 ` you wish to export data from. + :ref:`collection ` 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 ` tab or click the collection in the + :ref:`Collections ` 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 index 9107fcbf7..955b0a712 100644 --- 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 ` you wish to import data into. + :ref:`collection ` 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 ` tab or click the collection in the + :ref:`Collections ` 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 index a93b4dc8f..da0ac5437 100644 --- 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 ` + :ref:`View installation instructions ` .. image:: /images/hero-border.png :alt: Homepage hero image diff --git a/source/indexes.txt b/source/indexes.txt index 55d7c1d95..3f4c67be6 100644 --- 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 index b4196b526..53444b5c4 100644 --- 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 index 2b43846ff..5cb0a9d3b 100644 --- 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 ` 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 index 0c4ad6b0c..e1ffd130b 100644 --- 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 index 569026257..262a2088c 100644 --- a/source/release-notes.txt +++ b/source/release-notes.txt @@ -1906,7 +1906,7 @@ Bug Fixes: All other functionality remains the same as in standard |compass|. -- Added support for :doc:`connecting to Compass ` using an +- Added support for :ref:`connecting to Compass ` using an :abbr:`SRV record (Service record)`. In the connect dialog, if Compass detects an SRV record URI on the clipboard it auto-completes the dialog based on the SRV record. @@ -1935,11 +1935,11 @@ Bug Fixes: - x509 Authentication - - :doc:`Schema Analysis ` + - :ref:`Schema Analysis ` - - :doc:`Real Time Server Stats ` + - :ref:`Real Time Server Stats ` - - :doc:`Document Validation ` + - :ref:`Document Validation ` |compass| 1.9 ------------- @@ -1956,7 +1956,7 @@ Bug Fixes: information, see :ref:`past-query-view`. - Deployment Awareness - When a user connects to a :doc:`MongoDB instance `, + When a user connects to a :ref:`MongoDB instance `, Compass now displays: - The connection name if the connection is a favorite connection or @@ -1967,7 +1967,7 @@ Bug Fixes: specified in the connection window, the number of replica set members will also be displayed. - For more information, see :doc:`/instance`. + For more information, see :ref:`compass-home-screen`. |compass| 1.8 ------------- diff --git a/source/troubleshooting.txt b/source/troubleshooting.txt index fd3b4c167..a1b09163b 100644 --- a/source/troubleshooting.txt +++ b/source/troubleshooting.txt @@ -7,10 +7,10 @@ Troubleshooting This section provides advice for troubleshooting problems with |compass|. -:doc:`/troubleshooting/logs` +:ref:`compass-logs` Retrieve |compass| logs to diagnose errors. -:doc:`Connection Errors ` +:ref:`Connection Errors ` Resolve issues with connecting |compass| to the MongoDB server. .. default-domain:: mongodb diff --git a/source/troubleshooting/connection-errors.txt b/source/troubleshooting/connection-errors.txt index a6039993a..cbb2f03da 100644 --- a/source/troubleshooting/connection-errors.txt +++ b/source/troubleshooting/connection-errors.txt @@ -1,3 +1,5 @@ +.. _compass-connection-errors: + ========================= Compass Connection Errors ========================= @@ -162,7 +164,7 @@ Solutions Check Read Preference Setting ````````````````````````````` -In the |compass-short| :doc:`connection dialog `, set your +In the |compass-short| :ref:`connection dialog `, set your :guilabel:`Read Preference` to :guilabel:`Primary`. This will ensure that you connect to your cluster's primary member, which supports write operations. diff --git a/source/validation.txt b/source/validation.txt index 92f158387..1206b230e 100644 --- a/source/validation.txt +++ b/source/validation.txt @@ -12,8 +12,6 @@ Set Validation Rules for Your Schema :depth: 1 :class: singlecol -.. _validation-tab: - Validation Tab -------------- @@ -30,7 +28,6 @@ specific shape or only allowing a specified range of values in fields. :alt: Validation view .. _update-validation: -.. _create-validation-rules: Validation Rules ---------------- @@ -164,9 +161,6 @@ Using this validation, *one* of the following must be true: - The ``name`` field must be BSON type string. - The ``borough`` field must be one of the enum strings. - -.. _validation-actions-levels: - Validation Actions and Levels -----------------------------