Skip to content

Commit

Permalink
DOCSP-44714-compass-ref-prefix-replacements
Browse files Browse the repository at this point in the history
  • Loading branch information
ajhuh-mdb committed Oct 29, 2024
1 parent bf9b454 commit 014e153
Show file tree
Hide file tree
Showing 21 changed files with 36 additions and 36 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _pipeline-builder-settings:
.. _compass-pipeline-builder-settings:

=====================================
Aggregation Pipeline Builder Settings
Expand Down Expand Up @@ -51,6 +51,6 @@ Learn More

- :ref:`create-agg-pipeline`

- :ref:`pipeline-custom-collation`
- :ref:`compass-pipeline-custom-collation`

- :ref:`set-maxtime-ms-agg`
- :ref:`compass-set-maxtime-ms-agg`
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/count-pipeline-results.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _count-pipeline-results:
.. _compass-count-pipeline-results:

================================
Count Pipeline Results Documents
Expand Down
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/create-a-view.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _create-a-view:
.. _compass-create-a-view:

===================================
Create a View from Pipeline Results
Expand Down
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/export-pipeline-results.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _export-agg-builder-results:
.. _compass-export-agg-builder-results:

===================================
Export Aggregation Pipeline Results
Expand Down
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/maxtime-ms-pipeline.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _set-maxtime-ms-agg:
.. _compass-set-maxtime-ms-agg:

=======================================
Set Max Time MS for Aggregation Queries
Expand Down
6 changes: 3 additions & 3 deletions source/agg-pipeline-builder/open-saved-pipeline.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _open-saved-pipeline:
.. _compass-open-saved-pipeline:

=====================
Open a Saved Pipeline
Expand All @@ -22,7 +22,7 @@ If you don't already have a saved pipeline, you must first:

- :ref:`Create an aggregation pipeline <create-agg-pipeline>`.

- :ref:`Save your aggregation pipeline <save-agg-pipeline>`.
- :ref:`Save your aggregation pipeline <compass-save-agg-pipeline>`.

Steps
-----
Expand Down Expand Up @@ -62,6 +62,6 @@ Steps
Learn More
----------

- :ref:`save-agg-pipeline`
- :ref:`compass-save-agg-pipeline`

- :ref:`saved-query-view`
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/pipeline-custom-collation.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _pipeline-custom-collation:
.. _compass-pipeline-custom-collation:

==========================================
Specify Custom Collation For Your Pipeline
Expand Down
6 changes: 3 additions & 3 deletions source/agg-pipeline-builder/save-agg-pipeline.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _save-agg-pipeline:
.. _compass-save-agg-pipeline:

===============
Save a Pipeline
Expand All @@ -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`
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/view-pipeline-explain-plan.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _view-pipeline-explain-plans:
.. _compass-view-pipeline-explain-plans:

=================================
View Explain Plans for a Pipeline
Expand Down
4 changes: 2 additions & 2 deletions source/collections.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _collection-tab:
.. _compass-collection-tab:

===========
Collections
Expand Down Expand Up @@ -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
-------------------
Expand Down
2 changes: 1 addition & 1 deletion source/connect/required-access.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ privileges:
- :authrole:`dbAdmin`

* - :guilabel:`Collection`
- :ref:`create-collection`
- :ref:`compass-create-collection`
- :authaction:`createCollection`
- :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
Expand Up @@ -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`

Expand Down
6 changes: 3 additions & 3 deletions source/databases.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -28,8 +28,8 @@ 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.
Expand Down
2 changes: 1 addition & 1 deletion source/documents.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ 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:

Expand Down
2 changes: 1 addition & 1 deletion source/editions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ suit your needs.
- Compass Isolated

* - Interact with :ref:`documents <compass-documents>`,
:ref:`collections <collection-tab>`, and
:ref:`collections <compass-collection-tab>`, and
:ref:`databases <database-tab>` with full CRUD functionality
- |checkmark|
-
Expand Down
6 changes: 3 additions & 3 deletions source/import-export.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Import and Export Data
:keywords: atlas

You can use |compass| to import and export data to and from
:ref:`collections <collection-tab>`. |compass-short| supports import and
: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
Expand Down Expand Up @@ -190,15 +190,15 @@ Procedure
.. procedure::
:style: normal

.. step:: Connect to the deployment containing the :ref:`collection <collection-tab>` 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`.

.. step:: Navigate to your target collection.

You can either select the collection from the
:ref:`Collections <collection-tab>` tab or click the collection
:guilable:`Collections` tab or click the collection
in the left-hand pane.

.. step:: Create an aggregation pipeline and run for results.
Expand Down
4 changes: 2 additions & 2 deletions source/includes/steps-export-filter.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title: Connect to the deployment containing the
:ref:`collection <collection-tab>` you wish to export data from.
:ref:`collection <compass-collection-tab>` you wish to export data from.
level: 4
ref: connect-deployment
content: |
Expand All @@ -11,7 +11,7 @@ level: 4
ref: select-collection
content: |
You can either select the collection from the
:ref:`Collections <collection-tab>` tab or click the collection in the
:ref:`Collections <compass-collection-tab>` tab or click the collection in the
left-hand pane.
---
title: Specify a filter in the :guilabel:`query bar`.
Expand Down
4 changes: 2 additions & 2 deletions source/includes/steps-export.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title: Connect to the deployment containing the
:ref:`collection <collection-tab>` you wish to export data from.
:ref:`collection <compass-collection-tab>` you wish to export data from.
level: 4
ref: connect-deployment
content: |
Expand All @@ -11,7 +11,7 @@ level: 4
ref: select-collection
content: |
You can either select the collection from the
:ref:`Collections <collection-tab>` tab or click the collection in the
:ref:`Collections <compass-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`.
Expand Down
4 changes: 2 additions & 2 deletions source/includes/steps-import.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title: Connect to the deployment containing the
:ref:`collection <collection-tab>` you wish to import data into.
:ref:`collection <compass-collection-tab>` you wish to import data into.
level: 4
ref: connect-deployment
content: |
Expand All @@ -11,7 +11,7 @@ level: 4
ref: select-collection
content: |
You can either select the collection from the
:ref:`Collections <collection-tab>` tab or click the collection in the
:ref:`Collections <compass-collection-tab>` tab or click the collection in the
left-hand pane.
---
title: Click the :guilabel:`Add Data` dropdown and select
Expand Down
2 changes: 1 addition & 1 deletion source/manage-data.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Interact with Your Data
:ref:`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`
Expand Down
4 changes: 2 additions & 2 deletions source/release-notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1819,7 +1819,7 @@ Bug Fixes:

- Added :manual:`collation </reference/collation>` support to the following features:

- :ref:`create-collection`
- :ref:`compass-create-collection`
- :ref:`create-database`
- :ref:`create-index`
- :ref:`compass-query-bar`
Expand Down Expand Up @@ -2017,7 +2017,7 @@ Bug Fixes:
- Added ability to :ref:`create <create-database>` and :ref:`drop
<drop-database>` databases.

- Added ability to :ref:`create <create-collection>` and :ref:`drop
- Added ability to :ref:`create <compass-create-collection>` and :ref:`drop
<drop-collection>` collections.

- Added ability to :ref:`create indexes <create-index>`.
Expand Down

0 comments on commit 014e153

Please sign in to comment.