Skip to content

Commit 4965bc2

Browse files
DOCSP-27356 update screenshot/ procedure for LeafyGreen pt1 (#455)
* DOCSP-27356 change screenshots * DOCSP-27356 commit to see PR * DOCSP-27356 corrections * DOCSP-27356 internal feedback * DOCSP-27356 final screenshot updates * DOCSP-27356 delete picture * DOCSP-27356 update size * Revert "DOCSP-27356 delete picture" This reverts commit 28ba08f7fc1e33a1f55c58dbd3f602ae65f4625c. * Revert "DOCSP-27356 final screenshot updates" This reverts commit c8da2b7cf635877fe3625f4dfe0a82d913824cf3. * DOCSP-27356 fixed file to be same as master * DOCSP-27356 update file
1 parent d9e98b8 commit 4965bc2

38 files changed

+134
-107
lines changed

source/connect.txt

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,6 @@ Considerations
4747
Connect
4848
-------
4949

50-
When you open |compass-short|, an initial connection dialog appears:
51-
52-
.. figure:: /images/compass/new-connection.png
53-
:figwidth: 690px
54-
:alt: New connection dialog for pasting your connection string
55-
5650
You can connect your deployments by either:
5751

5852
- Providing your connection string.

source/connect/advanced-connection-options/advanced-connection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,4 +108,4 @@ Procedure
108108

109109
.. seealso::
110110

111-
To disconnect from your deployment, see :ref:`<disconnect-tab>`.
111+
To disconnect from your deployment, see :ref:`<disconnect-tab>`.

source/connect/disconnect.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ Disconnecting from a MongoDB deployment closes the Compass connection to
1010
the active deployment and returns the Compass view to the initial
1111
connection dialog.
1212

13-
To disconnect from a MongoDB deployment:
13+
Steps
14+
-----
1415

1516
.. include:: /includes/steps/disconnect-compass.rst
1617

17-
.. seealso::
18+
Learn more
19+
----------
1820

19-
To create a new connection, see :ref:`connect-run-compass`.
21+
To create a new connection, see :ref:`connect-run-compass`.
Loading
-41.7 KB
Loading

source/images/compass/disconnect.png

129 KB
Loading
Loading
-13.4 KB
Loading
Loading
52 KB
Loading
158 KB
Loading
Loading
88.9 KB
Loading
107 KB
Loading
89.5 KB
Loading
-29.5 KB
Loading
Loading
Loading
86.3 KB
Loading
Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
11
.. procedure::
22
:style: normal
33

4-
.. step:: Open query history.
4+
.. step:: Open query history
55

66
Click the :guilabel:`History` button on the query bar.
77

8-
.. step:: Select :guilabel:`Favorites`.
8+
.. figure:: /images/compass/query-history-view.png
9+
:figwidth: 720 px
10+
:alt: Click history button
11+
12+
.. step:: Select favorites
913

1014
Click the :guilabel:`Star` button.
1115

12-
.. step:: Name your query.
16+
.. figure:: /images/compass/query-add-favorite.png
17+
:figwidth: 316 px
18+
:alt: Click star button
19+
20+
.. step:: Name your query
21+
22+
Enter a name for your query.
23+
24+
.. figure:: /images/compass/query-add-favorite-name.png
25+
:figwidth: 316 px
26+
:alt: Save favorite query
1327

1428
..step:: Click :guilabel:`Save`.

source/includes/fact-save-pipeline.rst

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,17 @@ To save your pipeline:
88
.. procedure::
99
:style: normal
1010

11-
.. step:: Click the :guilabel:`Save` dropdown button.
11+
.. step:: Click the save dropdown button
1212

13-
Click on ``Save pipeline as...``.
13+
Click the :guilabel:`Save` dropdown button at the top of the pipeline
14+
builder. Click on ``Save pipeline as...``
1415

15-
.. step:: Enter a name for your pipeline.
16+
.. figure:: /images/compass/query-save-pipeline-as.png
17+
:alt: Save pipeline as
1618

17-
.. step:: Click :guilabel:`Save`.
19+
.. step:: Enter a name for your pipeline
20+
21+
.. figure:: /images/compass/query-save-pipeline-as-name.png
22+
:alt: Name your pipeline
23+
24+
.. step:: Click :guilabel:`Save`
Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. procedure::
22
:style: normal
33

4-
.. step:: Open your query history.
4+
.. step:: Open query history
55

66
Click the :guilabel:`History` button at the top of the
77
:guilabel:`Documents` tab.
@@ -10,6 +10,10 @@
1010
:figwidth: 600 px
1111
:alt: Query history view
1212

13-
.. step:: Click the :guilabel:`Favorites` button in the past queries pane.
13+
.. step:: Select favorites
1414

15-
Select favorite queries.
15+
Click the :guilabel:`Favorites` button in the past queries pane.
16+
17+
.. figure:: /images/compass/query-history-favorite.png
18+
:figwidth: 316px
19+
:alt: Favorites

source/includes/steps-create-query-via-builder.yaml

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,50 @@ ref: click-chart-value
44
content: |
55
66
In the :guilabel:`Schema` view, you can click on a chart value to
7-
build a query.
7+
build a query. For example, the following image shows the query
8+
filter built by clicking the ``EWR`` value for the
9+
``departureAirportFsCode`` field.
10+
11+
.. figure:: /images/compass/query-builder.png
12+
:figwidth: 815px
13+
:alt: Example of a created filter
814
---
9-
title: (Optional) Select multiple values.
15+
title: Optional. Select multiple values.
1016
level: 4
1117
ref: click-chart-value-multiple
1218
content: |
1319
To select multiple values for a field, click and drag the cursor
1420
over a selection of values, or press shift+click on the desired
1521
values.
22+
23+
.. figure:: /images/compass/query-builder3.png
24+
:figwidth: 817px
25+
:alt: Exmaple of selecting multimple values for a field
26+
1627
---
17-
title: (Optional) Click on other field values to create a compound query.
28+
title: Optional. Click on other field values to create a compound query.
1829
level: 4
19-
ref: create-compound-query.
30+
ref: create-compound-query
31+
content: |
32+
For example, the following image shows shows the compound query
33+
built by selecting a value in the ``flightId`` field.
34+
35+
.. figure:: /images/compass/query-builder2.png
36+
:figwidth: 817px
37+
:alt: Example of a compound query
2038
---
21-
title: (Optional) Deselect a value.
39+
title: Optional. Deselect a value.
2240
level: 4
2341
ref: remove-from-query
2442
content: |
2543
To deselect a previously selected value, shift+click on
26-
the selected value.
44+
the selected value:
45+
46+
.. figure:: /images/compass/query-builder4.png
47+
:figwidth: 740px
48+
:alt: Example of removing a value from a filter
2749
---
28-
title: Run the query.
50+
title: Run the query
2951
level: 4
3052
ref: run-query
3153
content: |

source/includes/steps-disconnect-compass.yaml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,4 @@ ref: connect-menu-bar
55
title: Select :guilabel:`Disconnect` from the dropdown menu.
66
level: 4
77
ref: select-disconnect
8-
content: |
9-
.. figure:: /images/compass/disconnect.png
10-
:figwidth: 500px
11-
:alt: Disconnect menu item
8+
...

source/includes/steps-export-pipeline-to-language.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,13 @@ content: |
1515
|compass|, see :ref:`Aggregation Pipeline Builder
1616
<compass-agg-builder>`.
1717
---
18-
title: Click :guilabel:`Export to Language`.
18+
title: Click the :guilabel:`Export` button.
1919
level: 4
2020
ref: select-export
21+
content: |
22+
.. figure:: /images/compass/agg-builder-export-dropdown.png
23+
:figwidth: 720px
24+
:alt: Aggregation Builder export dropdown
2125
---
2226
title: Select your desired export language.
2327
level: 4

source/includes/steps-favorite-connection-delete.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ title: Click the :icon-fa5:`ellipsis-h` button on the connection.
77
level: 4
88
ref: click-ellipsis
99
content: |
10-
.. figure:: /images/compass/favorite-connection-select.png
11-
:figwidth: 400px
12-
:alt: Image showing selecting Favorite Connection dropdown
13-
1410
|compass-short| displays a dropdown menu with options
1511
:guilabel:`Copy` and :guilabel:`Remove`.
1612
---

source/includes/steps-favorite-connection-edit.yaml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,13 @@ title: Click the desired connection under :guilabel:`Favorites`
33
level: 4
44
ref: locate-connection
55
content: |
6-
.. figure:: /images/compass/saved-favorite-connection.png
7-
:figwidth: 600px
8-
:alt: Saved Favorite Connection
6+
To :guilabel:`Copy connection string`, :guilabel:`Duplicate`, or
7+
:guilabel:`Remove` a Favorite Connection, hover over the target connection and
8+
click the :icon-fa5:`ellipsis-h` button.
99
10-
To :guilabel:`Copy` or :guilabel:`Remove` a Favorite Connection,
11-
hover over the target connection and click the :icon-fa5:`ellipsis-h`
12-
button.
13-
14-
- Copying a connection creates another Favorite Connection with the
10+
- Copying a connection string saves the connection string to your clipboard.
11+
12+
- Duplicating a connection creates another Favorite Connection with the
1513
same configuration.
1614
1715
- Removing a connection deletes that Favorite Connection.

source/includes/steps-favorite-connection-save-deployment.yaml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,11 @@
11
title: Click :guilabel:`Favorite` on the left navigation panel.
22
level: 4
33
ref: save-connection
4-
content: |
5-
6-
.. figure:: /images/compass/save-favorite-menu.png
7-
:figwidth: 600px
8-
:alt: Save connection to favorites from menu
9-
104
---
115
title: Enter a name for this favorite connection.
126
level: 4
137
ref: enter-favorite-name
148
content: |
15-
.. figure:: /images/compass/name-favorite-connection-menu.png
16-
:figwidth: 600px
17-
:alt: Name Favorite Connection
189
---
1910
title: (Optional) Select a color for your favorite to more easily
2011
identify the favorite connection.

source/includes/steps-favorite-connection-save.yaml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,11 @@ title: Click :guilabel:`Favorite` at the top of the form.
77
level: 4
88
ref: type-favorite-name
99
content: |
10-
.. figure:: /images/compass/favorite-button-connect.png
11-
:figwidth: 600px
12-
:alt: Favorite Connection Button
1310
---
1411
title: Enter a name for this favorite connection.
1512
level: 4
1613
ref: enter-favorite-name
1714
content: |
18-
.. figure:: /images/compass/name-favorite-connection.png
19-
:figwidth: 600px
20-
:alt: Name Favorite Connection
2115
---
2216
title: (Optional) Select a color for your favorite to more easily
2317
identify the favorite connection.

source/includes/steps-starting-compass-paste-string.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,13 @@ title: Connect.
2929
level: 4
3030
ref: compass-connect
3131
content: |
32-
Click the :guilabel:`Connect` button to navigate to the
32+
Click :guilabel:`Connect` or :guilabel:`Save & Connect` to navigate to the
3333
|compass-short| :doc:`Home Page </instance>`.
3434
35+
The :guilabel:`Save & Connect` button prompts you to save your connection
36+
string as a :ref:`Favorite Connection <favorite-connections>` and then
37+
navigates to the home page.
38+
3539
.. important:: Required Access
3640
3741
Once you are connected to your MongoDB deployment, you may

source/install.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -214,10 +214,6 @@ Select your operating system:
214214
#. Drag the |compass| application to your
215215
:guilabel:`Applications` folder.
216216

217-
.. figure:: /images/compass/osx-install-dialog.png
218-
:figwidth: 600px
219-
:alt: OSX installation dialog
220-
221217
#. Eject the disk image.
222218

223219
#. From the :guilabel:`Applications` folder, double-click on

source/instance.txt

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,13 @@ MongoDB instance to which Compass is connected, including:
1616
- The connection name if the connection is a favorite connection,
1717
or "My Cluster" otherwise.
1818

19-
- The deployment type (standalone, replica set, sharded cluster). If
20-
the deployment is a replica set and the replica set name is specified
21-
in the connection window, the number of replica set members will also
22-
be displayed.
23-
24-
- The hostname and port, as well as the version of MongoDB.
19+
- Your :ref:`saved queries and aggregation pipelines <view-favorite-queries>`.
2520

2621
- A list of the instance's :doc:`databases </databases>`.
2722

2823
- :doc:`Performance statistics </performance>`, including memory
2924
usage, operation counts, and slowest operations.
3025

31-
.. figure:: /images/compass/instance-view.png
32-
:alt: Compass Home View
33-
3426
Once connected to a MongoDB instance, you can reach the Compass
3527
Home screen by clicking the cluster name in the upper left
3628
corner.

source/performance.txt

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Server Stats
2828

2929
The :guilabel:`Performance` tab displays various stats:
3030

31-
.. figure:: /images/compass/performance-view-full.svg
31+
.. figure:: /images/compass/performance-view-full.png
3232
:figwidth: 720px
3333
:alt: Performance statistics example
3434

@@ -100,27 +100,12 @@ Kill Slow Operations
100100

101101
You can kill slow operations from the :guilabel:`Performance Tab`.
102102

103-
1. Click the query you would like to kill in the
104-
:guilabel:`Slowest Operations` section.
103+
.. procedure::
104+
:style: normal
105105

106-
|
106+
.. step:: Click the query you would like to kill in the :guilabel:`Slowest Operations` section.
107107

108-
.. figure:: /images/compass/slow-ops.png
109-
:scale: 50%
110-
:alt: Slow Operations section
111-
112-
|
113-
114-
2. In the :guilabel:`Operation Details` view, click
115-
:guilabel:`Kill Op`.
116-
117-
|
118-
119-
.. figure:: /images/compass/kill-op.png
120-
:scale: 50%
121-
:alt: Kill Op button
122-
123-
|
108+
.. step:: In the :guilabel:`Operation Details` view, click :guilabel:`Kill Op`.
124109

125110
Pause the Display
126111
-----------------

source/query/queries.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ To add a query to your favorites:
3333

3434
.. include:: /includes/fact-favorite-query.rst
3535

36+
.. _view-favorite-queries:
37+
3638
Viewing Saved Queries
3739
---------------------
3840

@@ -52,7 +54,7 @@ When you click a saved or favorite pipeline tile, Compass opens the
5254
:guilabel:`Aggregations` tab with the pipeline loaded.
5355

5456
.. figure:: /images/compass/query-my-queries-splash.png
55-
:figwidth: 650 px
57+
:figwidth: 720 px
5658
:alt: My queries view
5759

5860
Using the :guilabel:`Favorites` Tab

0 commit comments

Comments
 (0)