Skip to content

Commit

Permalink
*
Browse files Browse the repository at this point in the history
  • Loading branch information
ajhuh-mdb committed Oct 29, 2024
1 parent 014e153 commit 3af764e
Show file tree
Hide file tree
Showing 43 changed files with 93 additions and 93 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ 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:`compass-pipeline-custom-collation`

Expand Down
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/count-pipeline-results.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/open-saved-pipeline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ 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 <compass-save-agg-pipeline>`.

Expand Down
8 changes: 4 additions & 4 deletions source/collections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------
Expand Down Expand Up @@ -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
-----------------
Expand All @@ -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
Expand Down Expand Up @@ -125,7 +125,7 @@ view:

- Set Validation Rules for Your Schema

.. _tabbed-view:
.. _compass-tabbed-view:

Tabbed View
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion source/collections/clustered-collection.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _clustered-collection:
.. _compass-clustered-collection:

=============================
Create a Clustered Collection
Expand Down
2 changes: 1 addition & 1 deletion source/collections/collation-collection.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _collation-collection:
.. _compass-collation-collection:

==================================
Create a Collection with Collation
Expand Down
2 changes: 1 addition & 1 deletion source/collections/encrypted-collection.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _encrypted-collection:
.. _compass-encrypted-collection:

=============================================
Create a Collection with Queryable Encryption
Expand Down
2 changes: 1 addition & 1 deletion source/collections/time-series-collection.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _time-series-collection:
.. _compass-time-series-collection:

===============================
Create a Time Series Collection
Expand Down
2 changes: 1 addition & 1 deletion source/connect/connections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------
Expand Down
6 changes: 3 additions & 3 deletions source/connect/required-access.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ 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`

Expand All @@ -48,7 +48,7 @@ privileges:
- :authrole:`readWrite`

* - :guilabel:`Collection`
- :ref:`drop-collection`
- :ref:`compass-drop-collection`
- :authaction:`dropCollection`
- :authrole:`readWrite`

Expand Down
2 changes: 1 addition & 1 deletion source/create-agg-pipeline.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. _compass-agg-builder:
.. _create-agg-pipeline:
.. _compass-create-agg-pipeline:

==============================
Create an Aggregation Pipeline
Expand Down
10 changes: 5 additions & 5 deletions source/databases.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _database-tab:
.. _compass-database-tab:

=========
Databases
Expand Down Expand Up @@ -31,17 +31,17 @@ From this view, you can click a database name in the sidebar to view its
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
---------------
Expand Down
10 changes: 5 additions & 5 deletions source/documents.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ Manage Documents
Documents are individual records in a MongoDB :ref:`collection
<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.
Expand All @@ -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`

Expand Down
4 changes: 2 additions & 2 deletions source/documents/clone.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _clone-documents:
.. _compass-clone-documents:

===============
Clone Documents
Expand Down Expand Up @@ -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`.
2 changes: 1 addition & 1 deletion source/documents/insert.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _insert-documents:
.. _compass-insert-documents:

================
Insert Documents
Expand Down
6 changes: 3 additions & 3 deletions source/documents/view.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/export-query-to-language.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions source/import-export.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You can use |compass| to import and export data to and from
:ref:`collections <compass-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 :ref:`Databases <database-tab>` tab or
selecting the collection from the :ref:`Databases <compass-database-tab>` tab or
clicking the collection in the left-side navigation.

.. note::
Expand Down Expand Up @@ -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 <query-bar-filter>` or :ref:`aggregation pipeline
:ref:`filter <compass-query-bar-filter>` or :ref:`aggregation pipeline
<compass-agg-builder>` for your collection, |compass-short| only exports
documents which match the specified query or
pipeline results.
Expand Down Expand Up @@ -204,7 +204,7 @@ Procedure
.. step:: Create an aggregation pipeline and run for results.

To learn how to create an aggregation pipeline, see :ref:`Create an
Aggregation Pipeline <create-agg-pipeline>`.
Aggregation Pipeline <compass-create-agg-pipeline>`.

.. step:: Click :guilabel:`Export`.

Expand Down
2 changes: 1 addition & 1 deletion source/includes/fact-collections-screen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <database-tab>` either:
:ref:`Databases screen <compass-database-tab>` either:

- Click a :guilabel:`Database Name` in the main :guilabel:`Databases`
view, or
Expand Down
2 changes: 1 addition & 1 deletion source/includes/fact-release-notes-1.11.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
- Added support for :ref:`disconnecting <disconnect-tab>` from the active
MongoDB instance without restarting |compass|.

- Added :ref:`Table View <docs-list-table-view>` for documents as a
- Added :ref:`Table View <compass-docs-list-table-view>` for documents as a
method of viewing the contents of a collection in tabular format.
10 changes: 5 additions & 5 deletions source/includes/steps-create-collection.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 <capped-collection>`
- :ref:`Create a Capped Collection <compass-capped-collection>`
- :ref:`Create a Clustered Collection <clustered-collection>`
- :ref:`Create a Clustered Collection <compass-clustered-collection>`
- :ref:`Create a Collection with Collation <collation-collection>`
- :ref:`Create a Collection with Collation <compass-collation-collection>`
- :ref:`Create a Collection with Encrypted Fields <encrypted-collection>`
- :ref:`Create a Collection with Encrypted Fields <compass-encrypted-collection>`
- :ref:`Create a Time Series Collection <time-series-collection>`
- :ref:`Create a Time Series Collection <compass-time-series-collection>`
---
title: Click :guilabel:`Create Collection` to create the collection.
level: 4
Expand Down
2 changes: 1 addition & 1 deletion source/includes/steps-create-index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ level: 4
ref: create-collection
stepnum: 1
content: |
From the :ref:`Indexes <indexes-tab>` tab, click the :guilabel:`Create
From the :ref:`Indexes <compass-indexes-tab>` tab, click the :guilabel:`Create
Index` button.
---
title: Add fields to the index
Expand Down
2 changes: 1 addition & 1 deletion source/includes/steps-delete-database.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ title: Click the trash can icon for the database.
level: 4
ref: drop-database
content: |
From the :ref:`Databases <database-tab>` tab, to delete a
From the :ref:`Databases <compass-database-tab>` tab, to delete a
database, click on the trash can icon for that database. A
confirmation dialog appears.
Expand Down
2 changes: 1 addition & 1 deletion source/includes/steps-drop-index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 <indexes-tab>` tab, to delete an index,
From the :ref:`Indexes <compass-indexes-tab>` tab, to delete an index,
click on the trash can icon for that index. A confirmation
dialog appears.
Expand Down
2 changes: 1 addition & 1 deletion source/includes/steps-export-filter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ title: Specify a filter in the :guilabel:`query bar`.
level: 4
ref: export-specify-filter
content: |
Specify a :ref:`filter <query-bar-filter>` in the
Specify a :ref:`filter <compass-query-bar-filter>` in the
:ref:`query bar <compass-query-bar>` to export only the documents
which match the filter.
---
Expand Down
8 changes: 4 additions & 4 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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<insert-documents>`
:ref:`To learn more, see Insert Documents<compass-insert-documents>`

.. step:: Query your data

Expand All @@ -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<query-bar-filter>`
- :ref:`Query with Natural Language<query-natural-language>`
- :ref:`Query Your Data<compass-query-bar-filter>`
- :ref:`Query with Natural Language<compass-query-natural-language>`

.. image:: /images/tabs/query-your-data.png
:alt: MongoDB Compass collection query image
Expand All @@ -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<insert-documents>`
:ref:`To learn more, see Insert Documents<compass-insert-documents>`

.. step:: Create aggregation pipelines

Expand Down
6 changes: 3 additions & 3 deletions source/indexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To learn more about indexes, see :manual:`Indexes </indexes>`.
of considerations for indexes, see
:ref:`Operational Considerations for Indexes <data-model-indexes>`.

.. _indexes-tab:
.. _compass-indexes-tab:

Indexes Tab
-----------
Expand Down Expand Up @@ -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
---------------
Expand Down Expand Up @@ -157,7 +157,7 @@ index.
:guilabel:`Properties` column.


.. _drop-index:
.. _compass-drop-index:

Drop an Index
-------------
Expand Down
2 changes: 1 addition & 1 deletion source/indexes/create-search-index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Create an Index

.. step:: Open the index creation dialog

From the :ref:`Indexes <indexes-tab>` tab, click the
From the :ref:`Indexes <compass-indexes-tab>` tab, click the
:guilabel:`Create` button, then click :guilabel:`Search Index`.

.. step:: Specify a name for the index
Expand Down
Loading

0 comments on commit 3af764e

Please sign in to comment.