Skip to content

Commit 495e24c

Browse files
authored
DOCSP-47239 More Compass Cleanup (#721)
* DOCSP-47239 More Compass Cleanup * * * internal feedback
1 parent 51430d6 commit 495e24c

19 files changed

+76
-99
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Steps
3535
.. procedure::
3636
:style: normal
3737

38-
.. step:: Click the count results button
38+
.. step:: Click :guilabel:`count results`
3939

4040
After you run your pipeline, click :guilabel:`count results`, which
4141
appears under the :guilabel:`Run` button. The :guilabel:`count results`
@@ -46,8 +46,8 @@ Steps
4646

4747
.. step:: (Optional) Click the refresh icon
4848

49-
If you edit your pipeline, you must press the :icon-fa4:`refresh` button
50-
to update your document count.
49+
If you edit your pipeline, click refresh :icon-fa4:`refresh` to update
50+
your document count.
5151

5252
Learn More
5353
----------

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Steps
2828
.. procedure::
2929
:style: normal
3030

31-
.. step:: Click the Save drop-down button
31+
.. step:: Click the :guilabel:`Save` drop-down button
3232

3333
In the aggregation pipeline pane, click the :guilabel:`Save` drop-down
3434
button and select :guilabel:`Create view`.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Steps
2727
.. procedure::
2828
:style: normal
2929

30-
.. step:: Click the Export button
30+
.. step:: Click :guilabel:`Export`
3131

3232
In the top right of the aggregation pipeline builder, click the
3333
:guilabel:`Export` button to open the modal.
@@ -49,7 +49,7 @@ Steps
4949

5050
.. include:: /includes/extended-json-table.rst
5151

52-
.. step:: Click Export
52+
.. step:: Click :guilabel:`Export`
5353

5454
.. step:: Specify export destination
5555

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Steps
3030
.. procedure::
3131
:style: normal
3232

33-
.. step:: Click the Export to Language button
33+
.. step:: Click :guilabel:`Export to Language`
3434

3535
In the aggregation pipeline pane, click the :guilabel:`Export to Language`
3636
button to open the pipeline export card.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ Steps
4444
.. procedure::
4545
:style: normal
4646

47-
.. step:: Click Options
47+
.. step:: Click :guilabel:`Options`
4848

4949
On the :guilabel:`Aggregations` tab, click :guilabel:`Options`
5050

5151
.. figure:: /images/compass/agg-builder-click-more-options.png
5252
:alt: More Options dropdown.
5353

54-
.. step:: Specify a Max Time MS value
54+
.. step:: Specify a :guilabel:`Max Time MS` value
5555

5656
Next to the :guilabel:`Max Time MS` field, enter a numeric value to set as
5757
the maximum amount of time in milliseconds that an aggregation

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Steps
3030
.. procedure::
3131
:style: normal
3232

33-
.. step:: Click Options
33+
.. step:: Click :guilabel:`Options`
3434

3535
In the top-right corner of the pipeline builder, click
3636
:guilabel:`Options`.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Steps
4141
.. procedure::
4242
:style: normal
4343

44-
.. step:: Click the Explain button
44+
.. step:: Click :guilabel:`Explain`
4545

4646
In the top right of the aggregation pipeline builder, click the
4747
:guilabel:`Explain` button to open the :guilabel:`Explain Plan` modal.
@@ -62,7 +62,7 @@ Steps
6262
:alt: Detailed Visual Tree view
6363
:width: 696px
6464

65-
.. step:: (Optional) Select the Raw Output view
65+
.. step:: (Optional) Select the :guilabel:`Raw Output` view
6666

6767
To view your full explain plan as raw JSON, select the
6868
:guilabel:`Raw Output` view.

source/collections.txt

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,8 @@ view:
100100

101101
- :ref:`compass-documents`
102102

103-
.. BEGIN-COMPASS-ONLY
104-
105103
- :ref:`compass-import-export` to and from the collection
106104

107-
.. END-COMPASS-ONLY
108-
109105
- :ref:`compass-agg-builder`
110106

111107
- :ref:`Schema Analysis <compass-schema-tab>`
@@ -116,8 +112,6 @@ view:
116112

117113
- :ref:`compass-validation`
118114

119-
.. BEGIN-COMPASS-ONLY
120-
121115
.. note:: Data Lake Limitations
122116

123117
The following functionality is not available if you are connected to
@@ -133,8 +127,6 @@ view:
133127

134128
- Set Validation Rules for Your Schema
135129

136-
.. END-COMPASS-ONLY
137-
138130
.. _compass-tabbed-view:
139131

140132
Tabbed View
@@ -145,8 +137,6 @@ open a new tab to view collection details:
145137

146138
.. include:: /includes/shared/steps/open-new-tab.rst
147139

148-
.. BEGIN-COMPASS-ONLY
149-
150140
Limitations
151141
-----------
152142

@@ -155,8 +145,6 @@ Limitations
155145
- The :guilabel:`Create Collection` button is not available if you are
156146
connected to a :atlas:`Data Lake </data-lake>`.
157147

158-
.. END-COMPASS-ONLY
159-
160148
.. |home| unicode:: U+2302
161149

162150
.. toctree::

source/collections/capped-collection.txt

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,21 @@ Create a Capped Collection
1616
collections that support high-throughput operations that insert and retrieve
1717
documents based on insertion order.
1818

19+
Limitations
20+
-----------
21+
22+
The following restrictions and limitations apply when creating a
23+
capped collection:
24+
25+
- :guilabel:`Custom collation` is the only :guilabel:`Advanced Collection Option`
26+
that you can use alongside your capped collection.
27+
28+
- If you import a data set larger than the maximum size of the capped collection,
29+
|compass-short| only loads the last documents of the data set and drops the oldest
30+
documents.
31+
32+
- Once the collection is created, you can't adjust the maximum number of bytes.
33+
1934
Steps
2035
-----
2136

@@ -38,18 +53,3 @@ Steps
3853
Enter the maximum number of bytes that the collection can hold.
3954

4055
.. step:: Click :guilabel:`Create Collection` to create the collection
41-
42-
Restrictions and Limitations
43-
----------------------------
44-
45-
The following restrictions and limitations apply when creating a
46-
capped collection:
47-
48-
- :guilabel:`Custom collation` is the only :guilabel:`Advanced Collection Option`
49-
that can be used alongside your capped collection.
50-
51-
- If you import a data set larger than the maximum size of the capped collection,
52-
|compass-short| only loads the last documents of the data set and drops the oldest
53-
documents.
54-
55-
- Once the collection is created, you cannot adjust the maximum number of bytes.

source/collections/clustered-collection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ with a clustered index. Clustered collections store documents ordered by :manual
1717
key value. You can use clustered collections when only one clustered index is
1818
necessary.
1919

20-
Restrictions
20+
Limitations
2121
------------
2222

2323
Clustered collection limitations:

0 commit comments

Comments
 (0)