Skip to content

Commit 2a2fec9

Browse files
authored
(DOCSP-7512) Document new UI for Favorite Connections (#204)
* Updates for new favorite ux * WIP * (DOCSP-7512) Document new UI for Favorite Connections * Changes based on review * Fix bullet list, typo * Changes from review
1 parent a6fb2cb commit 2a2fec9

12 files changed

+104
-28
lines changed

source/connect/favorite-connections.txt

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,34 @@ Favorite Connections
1212
:depth: 1
1313
:class: singlecol
1414

15-
|compass| allows you to save MongoDB connection configurations to
15+
|compass-short| allows you to save MongoDB connection configurations to
1616
easily reconnect to the same MongoDB deployment using the same
1717
specifications.
1818

1919
Save a Favorite Connection
2020
--------------------------
2121

22+
You can save a favorite connection from the initial
23+
:ref:`connect screen <connect-run-compass>`, or after you have
24+
successfully connected to a MongoDB deployment.
25+
26+
Save from Connect Screen
27+
~~~~~~~~~~~~~~~~~~~~~~~~
28+
2229
.. include:: /includes/steps/favorite-connection-save.rst
2330

24-
.. figure:: /images/compass/favorite-connection.png
25-
:figwidth: 500px
26-
:alt: Image showing Favorite Connection in Compass
31+
Save after Connecting to a Deployment
32+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33+
34+
.. include:: /includes/steps/favorite-connection-save-deployment.rst
35+
36+
Once you save your favorite connection, |compass-short| displays the
37+
connection in the :guilabel:`Favorites` section of the left navigation
38+
panel.
39+
40+
.. figure:: /images/compass/saved-favorite-connection.png
41+
:figwidth: 600px
42+
:alt: Saved Favorite Connection
2743

2844
Edit a Favorite Connection
2945
--------------------------
Loading
Binary file not shown.
Loading
Loading
Loading
96.8 KB
Loading
Loading
Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
1-
title: Click the desired connection under :guilabel:`Favorites` to
2-
the left of the :guilabel:`Connect to Host` form.
1+
title: Click the desired connection under :guilabel:`Favorites`
2+
in the left navigation panel.
33
level: 4
44
ref: click-connection
5+
---
6+
title: Click the :icon-fa5:`ellipsis-h` button on the connection.
7+
level: 4
8+
ref: click-ellipsis
59
content: |
610
.. figure:: /images/compass/favorite-connection-select.png
7-
:figwidth: 500px
8-
:alt: Image showing selecting Favorite Connection in Compass
11+
:figwidth: 400px
12+
:alt: Image showing selecting Favorite Connection dropdown
13+
14+
|compass-short| displays a dropdown menu with options
15+
:guilabel:`Copy` and :guilabel:`Remove`.
916
---
10-
title: Click :guilabel:`Delete Favorite` at the bottom of the form.
17+
title: Click :guilabel:`Remove` from the dropdown menu.
1118
level: 4
1219
ref: click-delete
1320
content: |
14-
|compass| removes the connection from the :guilabel:`Favorites` list
15-
and returns the :guilabel:`Connect to Host` form to the default
21+
|compass-short| removes the connection from the :guilabel:`Favorites`
22+
list and returns the :guilabel:`New Connection` form to the default
1623
state.
1724
...
Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,32 @@
1-
title: Click the desired connection under :guilabel:`Favorites` to
2-
the left of the :guilabel:`Connect to Host` form.
1+
title: Click the desired connection under :guilabel:`Favorites`
2+
in the left navigation panel.
33
level: 4
4-
ref: click-connection
4+
ref: locate-connection
55
content: |
6-
.. figure:: /images/compass/favorite-connection-select.png
7-
:figwidth: 500px
8-
:alt: Image showing selecting Favorite Connection in Compass
6+
.. figure:: /images/compass/saved-favorite-connection.png
7+
:figwidth: 600px
8+
:alt: Saved Favorite Connection
9+
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
15+
same configuration.
16+
17+
- Removing a connection deletes that Favorite Connection.
18+
919
---
1020
title: Make the desired changes to the connection configuration
11-
within the form.
21+
within the form.
1222
level: 4
1323
ref: make-connection-changes
24+
content: |
25+
When you make any change to a connection, a dialog will appear at the
26+
bottom of the form with options :guilabel:`Discard` and
27+
:guilabel:`Save Changes`.
1428
---
15-
title: Click :guilabel:`Save Favorite` at the bottom of the form.
29+
title: Click :guilabel:`Save Changes`.
1630
level: 4
1731
ref: click-create-favorite
1832
...
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
title: Click :guilabel:`Favorite` on the left navigation panel.
2+
level: 4
3+
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+
10+
---
11+
title: Enter a name for this favorite connection.
12+
level: 4
13+
ref: enter-favorite-name
14+
content: |
15+
.. figure:: /images/compass/name-favorite-connection-menu.png
16+
:figwidth: 600px
17+
:alt: Name Favorite Connection
18+
---
19+
title: (Optional) Select a color for your favorite to more easily
20+
identify the favorite connection.
21+
level: 4
22+
ref: select-favorite-color
23+
---
24+
title: Click :guilabel:`Save`.
25+
level: 4
26+
ref: save-favorite
27+
...
Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,30 @@
1-
title: Configure your :guilabel:`Connect To Host` form with a
2-
connection you would like to save.
1+
title: Configure your connection form with a connection you would like
2+
to save.
33
level: 4
44
ref: configure-host-form
55
---
6-
title: Type a :guilabel:`Favorite Name` into the :guilabel:`Favorite
7-
Name` input.
6+
title: Click :guilabel:`Favorite` at the top of the form.
87
level: 4
98
ref: type-favorite-name
109
content: |
11-
|compass| allows you to reuse the same :guilabel:`Favorite Name` for
12-
multiple connections, but this is not recommended practice as it can
13-
become difficult to maintain connections with the same name.
10+
.. figure:: /images/compass/favorite-button-connect.png
11+
:figwidth: 600px
12+
:alt: Favorite Connection Button
1413
---
15-
title: Click :guilabel:`Create Favorite`.
14+
title: Enter a name for this favorite connection.
1615
level: 4
17-
ref: click-create-favorite
16+
ref: enter-favorite-name
17+
content: |
18+
.. figure:: /images/compass/name-favorite-connection.png
19+
:figwidth: 600px
20+
:alt: Name Favorite Connection
21+
---
22+
title: (Optional) Select a color for your favorite to more easily
23+
identify the favorite connection.
24+
level: 4
25+
ref: select-favorite-color
26+
---
27+
title: Click :guilabel:`Save`.
28+
level: 4
29+
ref: save-favorite
1830
...

0 commit comments

Comments
 (0)