diff --git a/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt b/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt index e5e780037..8cf80526c 100644 --- 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 index 946bd9c92..4a19b5384 100644 --- 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 -` your aggregation pipeline. You can't count result +` 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 index 06cf1335e..c1ad87ad9 100644 --- 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 index cc36d5cf0..0ec4cc4ab 100644 --- 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 index e59ca7cec..cda02da3c 100644 --- 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 `, :ref:`sort `, :ref:`maxtimems - `, :ref:`collation `, + `, :ref:`collation `, :ref:`skip ` and :ref:`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 index 3c660db8d..ba8e5ea0c 100644 --- 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 index 02f40cf2b..54c02fdb2 100644 --- 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 `. +- :ref:`Create an aggregation pipeline `. -- :ref:`Save your aggregation pipeline `. +- :ref:`Save your aggregation 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 index a04da81d8..3de390826 100644 --- 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 index cd9981bca..c66bb72e0 100644 --- 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 index 1d9e3d962..ca38502d3 100644 --- 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 index bf9e8c0ac..9870fd7de 100644 --- 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 `. 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 ` +single :ref:`database `. 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 `. +- Open the collection in a :ref:`new tab `. After you select a collection, |compass-short| shows you that collection's :ref:`Documents tab `. |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 index 5473d04b4..1fddda6bc 100644 --- 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 index ea09aaf4a..37552bdd2 100644 --- 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 index b052be1cc..4c381601d 100644 --- 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 index fc4dd2f75..ee0953d02 100644 --- 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 index b552c04aa..8984d1a4a 100644 --- 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 index e1d094ed1..31aec6049 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 :ref:`Databases `. +see :ref:`Databases `. Connection Options ------------------ diff --git a/source/connect/required-access.txt b/source/connect/required-access.txt index 0aee95c40..135ca68e0 100644 --- 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 index 4fa909812..5a09320e8 100644 --- 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 ` -- :ref:`pipeline-builder-settings` +- :ref:`compass-pipeline-builder-settings` - :ref:`compass-export-pipeline` diff --git a/source/databases.txt b/source/databases.txt index 015c06979..ca53dbe13 100644 --- 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 `. +A database is a container for :ref:`collections `. 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 `. 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 ` or -:ref:`drop databases ` from this view. +You can also :ref:`create ` or +:ref:`drop databases ` 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 index e618f752d..3b908ec11 100644 --- 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 -` and are the basic unit of data in MongoDB. +` and are the basic unit of data in MongoDB. -.. _documents-tab: +.. _compass-documents-tab: From the :guilabel:`Documents` tab, you can -:ref:`view `, :ref:`insert `, +:ref:`view `, :ref:`insert `, :ref:`modify `, :ref:`modify multiple `, -:ref:`clone `, +:ref:`clone `, :ref:`delete `, and :ref:`delete multiple ` 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 index 0e7ee52be..571466626 100644 --- 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 index 43d70eed8..e96b09fc3 100644 --- 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 index f6b004bd0..330bc3854 100644 --- 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 index 09ee74615..3259cd240 100644 --- a/source/editions.txt +++ b/source/editions.txt @@ -17,8 +17,8 @@ suit your needs. - Compass Isolated * - Interact with :ref:`documents `, - :ref:`collections `, and - :ref:`databases ` with full CRUD functionality + :ref:`collections `, and + :ref:`databases ` with full CRUD functionality - |checkmark| - - |checkmark| diff --git a/source/export-query-to-language.txt b/source/export-query-to-language.txt index b5c5bb2db..c515109d1 100644 --- 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 `, :ref:`sort `, :ref:`maxtimems `, - :ref:`collation `, :ref:`skip ` + :ref:`collation `, :ref:`skip ` and :ref:`limit ` options. #. Click :icon-fa5:`copy` at the top-right of the formatted diff --git a/source/import-export.txt b/source/import-export.txt index 635f3f9ea..c54cf85fe 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 -:ref:`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 :ref:`Databases ` tab or +selecting the collection from the :ref:`Databases ` tab or clicking the collection in the left-side navigation. .. note:: @@ -143,7 +143,7 @@ Export Data from a Collection |compass| can export data from a collection as either a **JSON** or **CSV** file. If you specify a -:ref:`filter ` or :ref:`aggregation pipeline +:ref:`filter ` or :ref:`aggregation pipeline ` for your collection, |compass-short| only exports documents which match the specified query or pipeline results. @@ -190,7 +190,7 @@ Procedure .. procedure:: :style: normal - .. step:: Connect to the deployment containing the :ref:`collection ` you wish to export data from. + .. step:: Connect to the deployment containing the collection you wish to export data from. To learn how to connect to a deployment, see :ref:`connect-run-compass`. @@ -198,13 +198,13 @@ Procedure .. step:: Navigate to your target collection. You can either select the collection from the - :ref:`Collections ` tab or click the collection + :guilabel:`Collections` tab or click the collection in the left-hand pane. .. step:: Create an aggregation pipeline and run for results. To learn how to create an aggregation pipeline, see :ref:`Create an - Aggregation Pipeline `. + Aggregation Pipeline `. .. step:: Click :guilabel:`Export`. diff --git a/source/includes/fact-collections-screen.rst b/source/includes/fact-collections-screen.rst index 7ffdf401e..4951f0cb8 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 -:ref:`Databases screen ` either: +:ref:`Databases screen ` either: - Click a :guilabel:`Database Name` in the main :guilabel:`Databases` view, or diff --git a/source/includes/fact-release-notes-1.11.rst b/source/includes/fact-release-notes-1.11.rst index 545052b0d..e08791407 100644 --- a/source/includes/fact-release-notes-1.11.rst +++ b/source/includes/fact-release-notes-1.11.rst @@ -4,5 +4,5 @@ - Added support for :ref:`disconnecting ` from the active MongoDB instance without restarting |compass|. -- Added :ref:`Table View ` for documents as a +- Added :ref:`Table View ` for documents as a method of viewing the contents of a collection in tabular format. \ No newline at end of file diff --git a/source/includes/steps-create-collection.yaml b/source/includes/steps-create-collection.yaml index c8ea9044e..6a0144507 100644 --- a/source/includes/steps-create-collection.yaml +++ b/source/includes/steps-create-collection.yaml @@ -15,15 +15,15 @@ content: | |compass-short| also provides you with :guilabel:`Additional preferences`. You can select from the following: - - :ref:`Create a Capped Collection ` + - :ref:`Create a Capped Collection ` - - :ref:`Create a Clustered Collection ` + - :ref:`Create a Clustered Collection ` - - :ref:`Create a Collection with Collation ` + - :ref:`Create a Collection with Collation ` - - :ref:`Create a Collection with Encrypted Fields ` + - :ref:`Create a Collection with Encrypted Fields ` - - :ref:`Create a Time Series Collection ` + - :ref:`Create a Time Series Collection ` --- title: Click :guilabel:`Create Collection` to create the collection. level: 4 diff --git a/source/includes/steps-create-index.yaml b/source/includes/steps-create-index.yaml index eb2c1795b..1971605c4 100644 --- a/source/includes/steps-create-index.yaml +++ b/source/includes/steps-create-index.yaml @@ -3,7 +3,7 @@ level: 4 ref: create-collection stepnum: 1 content: | - From the :ref:`Indexes ` tab, click the :guilabel:`Create + From the :ref:`Indexes ` tab, click the :guilabel:`Create Index` button. --- title: Add fields to the index diff --git a/source/includes/steps-delete-database.yaml b/source/includes/steps-delete-database.yaml index 03d59fb71..acbdb3100 100644 --- a/source/includes/steps-delete-database.yaml +++ b/source/includes/steps-delete-database.yaml @@ -2,7 +2,7 @@ title: Click the trash can icon for the database. level: 4 ref: drop-database content: | - From the :ref:`Databases ` tab, to delete a + From the :ref:`Databases ` tab, to delete a database, click on the trash can icon for that database. A confirmation dialog appears. diff --git a/source/includes/steps-drop-index.yaml b/source/includes/steps-drop-index.yaml index 186ee943c..df49e4c1a 100644 --- a/source/includes/steps-drop-index.yaml +++ b/source/includes/steps-drop-index.yaml @@ -2,7 +2,7 @@ title: Click the trash can icon for the index to drop. level: 4 ref: drop-index content: | - From the :ref:`Indexes ` tab, to delete an index, + From the :ref:`Indexes ` tab, to delete an index, click on the trash can icon for that index. A confirmation dialog appears. diff --git a/source/includes/steps-export-filter.yaml b/source/includes/steps-export-filter.yaml index beac09615..1a8b98f62 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 - :ref:`collection ` you wish to export data from. + :ref:`collection ` you wish to export data from. level: 4 ref: connect-deployment content: | @@ -11,14 +11,14 @@ level: 4 ref: select-collection content: | You can either select the collection from the - :ref:`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`. level: 4 ref: export-specify-filter content: | - Specify a :ref:`filter ` in the + Specify a :ref:`filter ` in the :ref:`query bar ` to export only the documents which match the filter. --- diff --git a/source/includes/steps-export.yaml b/source/includes/steps-export.yaml index 2ad451a3e..df05b4cc7 100644 --- a/source/includes/steps-export.yaml +++ b/source/includes/steps-export.yaml @@ -1,5 +1,5 @@ title: Connect to the deployment containing the - :ref:`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 - :ref:`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 955b0a712..926b44486 100644 --- a/source/includes/steps-import.yaml +++ b/source/includes/steps-import.yaml @@ -1,5 +1,5 @@ title: Connect to the deployment containing the - :ref:`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 - :ref:`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 da0ac5437..5ec1c825a 100644 --- a/source/index.txt +++ b/source/index.txt @@ -63,7 +63,7 @@ Explore some of the tasks Compass can help you accomplish, such as importing and Paste documents into the JSON view, or manually insert documents using a field-by-field editor. - :ref:`To learn more, see Insert Documents` + :ref:`To learn more, see Insert Documents` .. step:: Query your data @@ -73,8 +73,8 @@ Explore some of the tasks Compass can help you accomplish, such as importing and To learn more, see: - - :ref:`Query Your Data` - - :ref:`Query with Natural Language` + - :ref:`Query Your Data` + - :ref:`Query with Natural Language` .. image:: /images/tabs/query-your-data.png :alt: MongoDB Compass collection query image @@ -88,7 +88,7 @@ Explore some of the tasks Compass can help you accomplish, such as importing and Insert documents into your collections in two ways, JSON Mode and a Field-by-Field Editor. - :ref:`To learn more, see Insert Documents` + :ref:`To learn more, see Insert Documents` .. step:: Create aggregation pipelines diff --git a/source/indexes.txt b/source/indexes.txt index 3f4c67be6..8a0bc4289 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -37,7 +37,7 @@ To learn more about indexes, see :manual:`Indexes `. of considerations for indexes, see :ref:`Operational Considerations for Indexes `. -.. _indexes-tab: +.. _compass-indexes-tab: Indexes Tab ----------- @@ -73,7 +73,7 @@ For each index, Compass displays the following information: - Any special properties (such as uniqueness, partial) of the index. -.. _create-index: +.. _compass-create-index: Create an Index --------------- @@ -157,7 +157,7 @@ index. :guilabel:`Properties` column. -.. _drop-index: +.. _compass-drop-index: Drop an Index ------------- diff --git a/source/indexes/create-search-index.txt b/source/indexes/create-search-index.txt index ca490080c..227e4f270 100644 --- a/source/indexes/create-search-index.txt +++ b/source/indexes/create-search-index.txt @@ -42,7 +42,7 @@ Create an Index .. step:: Open the index creation dialog - From the :ref:`Indexes ` tab, click the + From the :ref:`Indexes ` tab, click the :guilabel:`Create` button, then click :guilabel:`Search Index`. .. step:: Specify a name for the index diff --git a/source/indexes/create-vector-search-index.txt b/source/indexes/create-vector-search-index.txt index 113c33ece..2dfa60dff 100644 --- a/source/indexes/create-vector-search-index.txt +++ b/source/indexes/create-vector-search-index.txt @@ -42,7 +42,7 @@ Steps .. step:: Open the index creation dialog - From the :ref:`Indexes ` tab, click the + From the :ref:`Indexes ` tab, click the :guilabel:`Create` button and then click :guilabel:`Search Index`. .. step:: Specify a name for the index diff --git a/source/manage-data.txt b/source/manage-data.txt index 5cb0a9d3b..13dbe4306 100644 --- a/source/manage-data.txt +++ b/source/manage-data.txt @@ -6,10 +6,10 @@ Interact with Your Data .. include:: /includes/atlas-sample-data-note.rst -:ref:`database-tab` +:ref:`compass-database-tab` Learn how to create and manage databases in your deployment. -:ref:`collection-tab` +:ref:`compass-collection-tab` Learn how to manage collections in your databases. :ref:`compass-views` @@ -20,7 +20,7 @@ Interact with Your Data :ref:`compass-documents` Learn how to manage documents in your collections. -:ref:`query-bar-filter` +:ref:`compass-query-bar-filter` Learn how to query your data to return data that matches a specified criteria. diff --git a/source/query-with-natural-language/ai-and-data-usage-information.txt b/source/query-with-natural-language/ai-and-data-usage-information.txt index 4add39750..83ba9f1b4 100644 --- a/source/query-with-natural-language/ai-and-data-usage-information.txt +++ b/source/query-with-natural-language/ai-and-data-usage-information.txt @@ -46,7 +46,7 @@ Disable Natural Language Querying - Natural language querying in Compass is available if you have enabled the :ref:`Generative AI setting - ` and logged into Atlas. + ` and logged into Atlas. - If you no longer want to use the feature, uncheck :guilabel:`Enable AI Features` in the :guilabel:`Artificial Intelligence` settings. diff --git a/source/query-with-natural-language/enable-natural-language-querying.txt b/source/query-with-natural-language/enable-natural-language-querying.txt index e326ea91a..d64468eea 100644 --- a/source/query-with-natural-language/enable-natural-language-querying.txt +++ b/source/query-with-natural-language/enable-natural-language-querying.txt @@ -1,4 +1,4 @@ -.. _enable-natural-language-querying: +.. _compass-enable-natural-language-querying: ================================ Enable Natural Language Querying @@ -99,4 +99,4 @@ Steps Next Steps ---------- -:ref:`prompt-natural-language-query` +:ref:`compass-prompt-natural-language-query` diff --git a/source/query-with-natural-language/prompt-natural-language-aggregation.txt b/source/query-with-natural-language/prompt-natural-language-aggregation.txt index c04ed4ad1..c4b57da25 100644 --- a/source/query-with-natural-language/prompt-natural-language-aggregation.txt +++ b/source/query-with-natural-language/prompt-natural-language-aggregation.txt @@ -1,4 +1,4 @@ -.. _prompt-natural-language-agg: +.. _compass-prompt-natural-language-agg: ===================================== Prompt a Natural Language Aggregation @@ -24,7 +24,7 @@ About this Task .. include:: /includes/fact-natural-language-query.rst - You can also provide natural language prompts on the - :ref:`documents tab `. + :ref:`documents tab `. - This page uses the :ref:`sample_mflix.movies ` collection from the Atlas sample dataset. @@ -34,7 +34,7 @@ About this Task Before you Begin ---------------- -You must :ref:`enable natural language querying in Compass`. +You must :ref:`enable natural language querying in Compass`. Steps ----- @@ -161,9 +161,9 @@ when using natural language prompts for aggregation. Next Steps ---------- -:ref:`prompt-natural-language-query` +:ref:`compass-prompt-natural-language-query` Learn More ---------- -:ref:`query-natural-language` \ No newline at end of file +:ref:`compass-query-natural-language` \ No newline at end of file diff --git a/source/query-with-natural-language/prompt-natural-language-query.txt b/source/query-with-natural-language/prompt-natural-language-query.txt index 5b17bedeb..1631034b6 100644 --- a/source/query-with-natural-language/prompt-natural-language-query.txt +++ b/source/query-with-natural-language/prompt-natural-language-query.txt @@ -1,4 +1,4 @@ -.. _prompt-natural-language-query: +.. _compass-prompt-natural-language-query: =============================== Prompt a Natural Language Query @@ -29,7 +29,7 @@ About this Task a pop-up displays indicating your prompt requires aggregation stages. - You can also provide natural language prompts on the - :ref:`aggregations tab `. + :ref:`aggregations tab `. - This page uses the :ref:`sample_mflix.movies ` collection from the Atlas sample dataset. @@ -39,7 +39,7 @@ About this Task Before you Begin ---------------- -You must :ref:`enable natural language querying in Compass`. +You must :ref:`enable natural language querying in Compass`. Steps ----- @@ -110,9 +110,9 @@ when using natural language prompts. Next Steps ---------- -:ref:`prompt-natural-language-agg` +:ref:`compass-prompt-natural-language-agg` Learn More ---------- -:ref:`query-natural-language` \ No newline at end of file +:ref:`compass-query-natural-language` \ No newline at end of file diff --git a/source/query-with-natural-language/query-with-natural-language.txt b/source/query-with-natural-language/query-with-natural-language.txt index da62e1cf4..5a3a7d6f8 100644 --- a/source/query-with-natural-language/query-with-natural-language.txt +++ b/source/query-with-natural-language/query-with-natural-language.txt @@ -1,4 +1,4 @@ -.. _query-natural-language: +.. _compass-query-natural-language: =========================== Query with Natural Language @@ -43,9 +43,9 @@ Behavior Get Started ----------- -- :ref:`enable-natural-language-querying` -- :ref:`prompt-natural-language-query` -- :ref:`prompt-natural-language-agg` +- :ref:`compass-enable-natural-language-querying` +- :ref:`compass-prompt-natural-language-query` +- :ref:`compass-prompt-natural-language-agg` Details ------- diff --git a/source/query/atlas-search.txt b/source/query/atlas-search.txt index 905765a5f..5cc81d8c5 100644 --- a/source/query/atlas-search.txt +++ b/source/query/atlas-search.txt @@ -1,4 +1,4 @@ -.. _run-atlas-search-query: +.. _compass-run-atlas-search-query: ======================== Run Atlas Search Queries diff --git a/source/query/collation.txt b/source/query/collation.txt index 2f8ed1b90..e3587ca87 100644 --- a/source/query/collation.txt +++ b/source/query/collation.txt @@ -1,4 +1,4 @@ -.. _query-bar-collation: +.. _compass-query-bar-collation: ================================================= Set Language Specific Rules for String Comparison diff --git a/source/query/filter.txt b/source/query/filter.txt index e1ffd130b..413ffb6f0 100644 --- a/source/query/filter.txt +++ b/source/query/filter.txt @@ -1,4 +1,4 @@ -.. _query-bar-filter: +.. _compass-query-bar-filter: .. _query-bar: .. _compass-query-bar: diff --git a/source/release-notes.txt b/source/release-notes.txt index 262a2088c..8c39d69a0 100644 --- a/source/release-notes.txt +++ b/source/release-notes.txt @@ -490,7 +490,7 @@ New Features: - For more details, see :ref:`` and :ref:``. - Improved AI feedback experience. For more information on - Generative AI natural language queries in Compass, see :ref:`query-natural-language`. + Generative AI natural language queries in Compass, see :ref:`compass-query-natural-language`. (:issue:`COMPASS-7211`, :issue:`COMPASS-7251`). - Removed ``useNewUrlParser`` and ``useUnifiedTopology`` from export to language options (:issue:`COMPASS-4897`). @@ -1521,7 +1521,7 @@ New Features: - Allows functions in the query bar and aggregations. -- When navigating to the :ref:`Databases ` view, +- When navigating to the :ref:`Databases ` view, |compass-short| now clears a previously selected collection from the left navigation. @@ -1699,7 +1699,7 @@ Bug Fixes: now insert multiple documents at once. - Added support for querying UUIDs via the - :ref:`Documents ` query bar or in the + :ref:`Documents ` query bar or in the :ref:`Aggregation Pipeline Builder `. - Added support for the following aggregation pipeline operators: @@ -1819,9 +1819,9 @@ Bug Fixes: - Added :manual:`collation ` support to the following features: - - :ref:`create-collection` - - :ref:`create-database` - - :ref:`create-index` + - :ref:`compass-create-collection` + - :ref:`compass-create-database` + - :ref:`compass-create-index` - :ref:`compass-query-bar` - :ref:`compass-agg-builder` @@ -2014,13 +2014,13 @@ Bug Fixes: *Released Nov 29, 2016* -- Added ability to :ref:`create ` and :ref:`drop - ` databases. +- Added ability to :ref:`create ` and :ref:`drop + ` databases. -- Added ability to :ref:`create ` and :ref:`drop - ` collections. +- Added ability to :ref:`create ` and :ref:`drop + ` collections. -- Added ability to :ref:`create indexes `. +- Added ability to :ref:`create indexes `. - Added support for :ref:`document validation `. diff --git a/source/settings/config-file.txt b/source/settings/config-file.txt index e89c419a0..303a99fbd 100644 --- a/source/settings/config-file.txt +++ b/source/settings/config-file.txt @@ -65,7 +65,7 @@ Settings * - autoUpdates - Allow |compass-short| to periodically check for new updates. - * - :ref:`enableGenAIFeatures ` + * - :ref:`enableGenAIFeatures ` - Allow |compass-short| to use generative AI for natural language querying. This feature requires an Atlas login and a deployed Atlas cluster. diff --git a/source/settings/settings-reference.txt b/source/settings/settings-reference.txt index c25615336..3df79d886 100644 --- a/source/settings/settings-reference.txt +++ b/source/settings/settings-reference.txt @@ -181,14 +181,14 @@ You can configure the following settings on the |compass| interface: * - Enable AI Features - Artificial Intelligence - - Enables :ref:`natural language querying ` and allows + - Enables :ref:`natural language querying ` and allows the use of AI features in Compass which make requests to 3rd party services. * - Enable sending sample field values - Artificial Intelligence - Enables sharing of sample field values with the MongoDB AI provider. This setting can improve responses from - :ref:`natural language querying ` + :ref:`natural language querying ` prompts. Learn More diff --git a/source/views.txt b/source/views.txt index a785e2e52..c34ae6147 100644 --- a/source/views.txt +++ b/source/views.txt @@ -56,7 +56,7 @@ To create a view from your pipeline results: 1. Create an aggregation pipeline in the pipeline builder. For detailed instructions on using the pipeline builder, see - :ref:`create-agg-pipeline`. + :ref:`compass-create-agg-pipeline`. #. Click the arrow next to the :guilabel:`Save` button at the top of the pipeline builder. @@ -132,7 +132,7 @@ To modify the source of a view: #. Modify the pipeline as desired. For detailed instructions on using the pipeline builder, see - :ref:`create-agg-pipeline`. + :ref:`compass-create-agg-pipeline`. #. Click :guilabel:`Update View` at the top of the pipeline builder.