Skip to content

Commit 9a19c87

Browse files
authored
Merge compass-atlas-unification feature branch (#693)
* DOCSP-44714-compass-ref-prefix-replacements (#688) * DOCSP-44714-compass-ref-prefix-replacements * * * build errors * typo * DOCSP-44850-compass-prefix-updates (#692)
1 parent ee2facd commit 9a19c87

File tree

70 files changed

+208
-209
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+208
-209
lines changed

source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _pipeline-builder-settings:
1+
.. _compass-pipeline-builder-settings:
22

33
=====================================
44
Aggregation Pipeline Builder Settings
@@ -49,8 +49,8 @@ the upper right of the pipeline builder to open the :guilabel:`Settings` panel.
4949
Learn More
5050
----------
5151

52-
- :ref:`create-agg-pipeline`
52+
- :ref:`compass-create-agg-pipeline`
5353

54-
- :ref:`pipeline-custom-collation`
54+
- :ref:`compass-pipeline-custom-collation`
5555

56-
- :ref:`set-maxtime-ms-agg`
56+
- :ref:`compass-set-maxtime-ms-agg`

source/agg-pipeline-builder/count-pipeline-results.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _count-pipeline-results:
1+
.. _compass-count-pipeline-results:
22

33
================================
44
Count Pipeline Results Documents
@@ -26,7 +26,7 @@ Before You Begin
2626
----------------
2727

2828
To count result documents, you must first :ref:`create and run
29-
<create-agg-pipeline>` your aggregation pipeline. You can't count result
29+
<compass-create-agg-pipeline>` your aggregation pipeline. You can't count result
3030
documents while editing your pipeline.
3131

3232
Steps

source/agg-pipeline-builder/create-a-view.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _create-a-view:
1+
.. _compass-create-a-view:
22

33
===================================
44
Create a View from Pipeline Results

source/agg-pipeline-builder/export-pipeline-results.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _export-agg-builder-results:
1+
.. _compass-export-agg-builder-results:
22

33
===================================
44
Export Aggregation Pipeline Results

source/agg-pipeline-builder/export-pipeline-to-language.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ Steps
6060
Click the :guilabel:`Include Driver Syntax` checkbox to include
6161
application code for the selected programming language. If you include
6262
driver syntax, the copyable code reflects :ref:`project
63-
<query-bar-project>`, :ref:`sort <query-bar-sort>`, :ref:`maxtimems
64-
<query-bar-max-time-ms>`, :ref:`collation <query-bar-collation>`,
65-
:ref:`skip <query-bar-skip>` and :ref:`limit <query-bar-limit>` options.
63+
<compass-query-bar-project>`, :ref:`sort <compass-query-bar-sort>`, :ref:`maxtimems
64+
<compass-query-bar-max-time-ms>`, :ref:`collation <compass-query-bar-collation>`,
65+
:ref:`skip <compass-query-bar-skip>` and :ref:`limit <compass-query-bar-limit>` options.
6666

6767
.. step:: Click :icon-fa4:`files-o`
6868

source/agg-pipeline-builder/maxtime-ms-pipeline.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _set-maxtime-ms-agg:
1+
.. _compass-set-maxtime-ms-agg:
22

33
=======================================
44
Set Max Time MS for Aggregation Queries
@@ -64,4 +64,4 @@ Learn More
6464

6565
- :ref:`compass-interface-settings`
6666

67-
- :ref:`query-bar-max-time-ms`
67+
- :ref:`compass-query-bar-max-time-ms`

source/agg-pipeline-builder/open-saved-pipeline.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _open-saved-pipeline:
1+
.. _compass-open-saved-pipeline:
22

33
=====================
44
Open a Saved Pipeline
@@ -20,9 +20,9 @@ Before You Begin
2020

2121
If you don't already have a saved pipeline, you must first:
2222

23-
- :ref:`Create an aggregation pipeline <create-agg-pipeline>`.
23+
- :ref:`Create an aggregation pipeline <compass-create-agg-pipeline>`.
2424

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

2727
Steps
2828
-----
@@ -57,11 +57,11 @@ Steps
5757
after you connect to your cluster.
5858

5959
To learn more, see
60-
:ref:`viewing saved aggregations <saved-query-view>` for details.
60+
:ref:`viewing saved aggregations <compass-saved-query-view>` for details.
6161

6262
Learn More
6363
----------
6464

65-
- :ref:`save-agg-pipeline`
65+
- :ref:`compass-save-agg-pipeline`
6666

67-
- :ref:`saved-query-view`
67+
- :ref:`compass-saved-query-view`

source/agg-pipeline-builder/pipeline-custom-collation.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _pipeline-custom-collation:
1+
.. _compass-pipeline-custom-collation:
22

33
==========================================
44
Specify Custom Collation For Your Pipeline

source/agg-pipeline-builder/save-agg-pipeline.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _save-agg-pipeline:
1+
.. _compass-save-agg-pipeline:
22

33
===============
44
Save a Pipeline
@@ -15,7 +15,7 @@ Save a Pipeline
1515
You can save your aggregation pipelines to find and use them again later. If
1616
you load a saved pipeline, you can make edits to the pipeline stages without
1717
changing the original saved pipeline. You can also create a :ref:`view
18-
<view-details>` from your pipeline results.
18+
<compass-view-details>` from your pipeline results.
1919

2020
Steps
2121
-----
@@ -25,8 +25,8 @@ Steps
2525
Learn More
2626
----------
2727

28-
- :ref:`open-saved-pipeline`
28+
- :ref:`compass-open-saved-pipeline`
2929

30-
- :ref:`create-a-view`
30+
- :ref:`compass-create-a-view`
3131

32-
- :ref:`saved-queries-agg`
32+
- :ref:`compass-saved-queries-agg`

source/agg-pipeline-builder/view-pipeline-explain-plan.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _view-pipeline-explain-plans:
1+
.. _compass-view-pipeline-explain-plans:
22

33
=================================
44
View Explain Plans for a Pipeline

source/collections.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _collection-tab:
1+
.. _compass-collection-tab:
22

33
=============================
44
Manage Collections in Compass
@@ -23,7 +23,7 @@ A collection is a grouping of MongoDB
2323
:ref:`documents <compass-documents>`. Documents within a collection can
2424
have different fields. A collection is the equivalent of a
2525
table in a relational database system. A collection exists within a
26-
single :ref:`database <database-tab>`
26+
single :ref:`database <compass-database-tab>`.
2727

2828
Collections Screen
2929
------------------
@@ -61,7 +61,7 @@ information for each collection in the selected database:
6161
collection. Hover over a :guilabel:`Collation` banner to view
6262
the properties for that collection.
6363

64-
.. _create-collection:
64+
.. _compass-create-collection:
6565

6666
Create a Collection
6767
-------------------
@@ -70,7 +70,7 @@ You can create new collections in an existing database.
7070

7171
.. include:: /includes/steps/create-collection.rst
7272

73-
.. _drop-collection:
73+
.. _compass-drop-collection:
7474

7575
Drop a Collection
7676
-----------------
@@ -89,7 +89,7 @@ collection details, either:
8989

9090
- Click a collection in the left navigation.
9191

92-
- Open the collection in a :ref:`new tab <tabbed-view>`.
92+
- Open the collection in a :ref:`new tab <compass-tabbed-view>`.
9393

9494
After you select a collection, |compass-short| shows you that
9595
collection's :ref:`Documents tab <compass-documents>`. |compass-short| provides
@@ -102,13 +102,13 @@ view:
102102

103103
- :ref:`compass-agg-builder`
104104

105-
- :ref:`Schema Analysis <schema-tab>`
105+
- :ref:`Schema Analysis <compass-schema-tab>`
106106

107107
- :ref:`explain-plans`
108108

109109
- :ref:`compass-indexes`
110110

111-
- :ref:`validation`
111+
- :ref:`compass-validation`
112112

113113
.. note:: Data Lake Limitations
114114

@@ -125,7 +125,7 @@ view:
125125

126126
- Set Validation Rules for Your Schema
127127

128-
.. _tabbed-view:
128+
.. _compass-tabbed-view:
129129

130130
Tabbed View
131131
~~~~~~~~~~~

source/collections/capped-collection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _capped-collection:
1+
.. _compass-capped-collection:
22

33
==========================
44
Create a Capped Collection

source/collections/clustered-collection.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _clustered-collection:
1+
.. _compass-clustered-collection:
22

33
=============================
44
Create a Clustered Collection
@@ -71,4 +71,4 @@ Next Steps
7171

7272
- :ref:`Query Your Data<compass-query-bar>`
7373

74-
- :ref:`Analyze Your Data Scheme <schema-tab>`
74+
- :ref:`Analyze Your Data Scheme <compass-schema-tab>`

source/collections/collation-collection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _collation-collection:
1+
.. _compass-collation-collection:
22

33
==================================
44
Create a Collection with Collation

source/collections/encrypted-collection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _encrypted-collection:
1+
.. _compass-encrypted-collection:
22

33
=============================================
44
Create a Collection with Queryable Encryption

source/collections/time-series-collection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _time-series-collection:
1+
.. _compass-time-series-collection:
22

33
===============================
44
Create a Time Series Collection

source/connect/connections.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ to interact with to open the :guilabel:`Databases` tab. When you open a
6060
database, MongoDB opens a new tab and labels it with the name of the
6161
MongoDB instance that contains that database. For more information about
6262
the :guilabel:`Databases` tab and instructions on viewing a database,
63-
see :ref:`Databases <database-tab>`.
63+
see :ref:`Databases <compass-database-tab>`.
6464

6565
Connection Options
6666
------------------

source/connect/required-access.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,27 +33,27 @@ privileges:
3333
- :authrole:`clusterMonitor`
3434

3535
* - :guilabel:`Database`
36-
- :ref:`create-database`
36+
- :ref:`compass-create-database`
3737
- :authaction:`createCollection`
3838
- :authrole:`readWrite`
3939

4040
* - :guilabel:`Database`
41-
- :ref:`drop-database`
41+
- :ref:`compass-drop-database`
4242
- :authaction:`dropDatabase`
4343
- :authrole:`dbAdmin`
4444

4545
* - :guilabel:`Collection`
46-
- :ref:`create-collection`
46+
- :ref:`compass-create-collection`
4747
- :authaction:`createCollection`
4848
- :authrole:`readWrite`
4949

5050
* - :guilabel:`Collection`
51-
- :ref:`drop-collection`
51+
- :ref:`compass-drop-collection`
5252
- :authaction:`dropCollection`
5353
- :authrole:`readWrite`
5454

5555
* - :guilabel:`Schema`
56-
- :ref:`Query/View a Schema <schema-tab>`
56+
- :ref:`Query/View a Schema <compass-schema-tab>`
5757
- :authaction:`find`
5858
- :authrole:`read`
5959

@@ -87,12 +87,12 @@ privileges:
8787
- :authrole:`read`
8888

8989
* - :guilabel:`Validation`
90-
- :ref:`View rules <validation>`
90+
- :ref:`View rules <compass-validation>`
9191
- :authaction:`listCollections`
9292
- :authrole:`read`
9393

9494
* - :guilabel:`Validation`
95-
- :ref:`Update rules <update-validation>`
95+
- :ref:`Update rules <compass-update-validation>`
9696
- :authaction:`collMod`
9797
- :authrole:`dbAdmin`
9898

source/create-agg-pipeline.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. _compass-agg-builder:
2-
.. _create-agg-pipeline:
2+
.. _compass-create-agg-pipeline:
33

44
==============================
55
Create an Aggregation Pipeline
@@ -369,7 +369,7 @@ Learn More
369369

370370
- :manual:`Aggregation Pipeline Stages </reference/operator/aggregation-pipeline/>`
371371

372-
- :ref:`pipeline-builder-settings`
372+
- :ref:`compass-pipeline-builder-settings`
373373

374374
- :ref:`compass-export-pipeline`
375375

source/databases.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _database-tab:
1+
.. _compass-database-tab:
22

33
===========================
44
Manage Databases in Compass
@@ -12,7 +12,7 @@ Manage Databases in Compass
1212
:depth: 1
1313
:class: singlecol
1414

15-
A database is a container for :ref:`collections <collection-tab>`.
15+
A database is a container for :ref:`collections <compass-collection-tab>`.
1616
Each database gets its own set of files on the host file system.
1717
A single MongoDB server typically has multiple databases.
1818

@@ -28,20 +28,20 @@ deployment name in the :guilabel:`Connections Sidebar`.
2828
:alt: Databases View
2929

3030
From this view, you can click a database name in the sidebar to view its
31-
:ref:`collections <collection-tab>`. Alternatively, you can view
32-
database collections by clicking the desired database in the left-hand navigation.
31+
collections. Alternatively, you can view database collections by clicking the
32+
desired database in the left-hand navigation.
3333

34-
You can also :ref:`create <create-database>` or
35-
:ref:`drop databases <drop-database>` from this view.
34+
You can also :ref:`create <compass-create-database>` or
35+
:ref:`drop databases <compass-drop-database>` from this view.
3636

37-
.. _create-database:
37+
.. _compass-create-database:
3838

3939
Create a Database
4040
-----------------
4141

4242
.. include:: /includes/steps/create-database.rst
4343

44-
.. _drop-database:
44+
.. _compass-drop-database:
4545

4646
Drop a Database
4747
---------------

0 commit comments

Comments
 (0)