Skip to content

Commit 0876f56

Browse files
ltran-mdb2ltran-mdb2
authored
DOCSP 38430 merging Compass Multiple Connections Branch (#660)
* DOCSP 37462 Updating Connect to MonogDB Compass page for multiple connections (#617) * DOCSP-37462 updating connect to MongoDB Compass page * DOCSP-37462 updating connect to MongoDB Compass page * DOCSP-37462 updating connect to MongoDB Compass page * DOCSP-37462 removing extra space * DOCSP 37458 - multiple connections on Compass Home (#616) * DOCSP-37458 multiple connections home screen update * DOCSP-37458 multiple connections home screen update * DOCSP-37458 copy edits * DOCSP-37458 typo * DOCSP-37458 adding database title * DOCSP-37458 adding database title * DOCSP 37463 Updating connection window flow (#647) * DOCSP-37463 general connection tab * DOCSP-37463 general connection tab * DOCSP-37463 general connection tab * DOCSP-37463 general connection tab * DOCSP-37463 general connection tab * DOCSP-37463 general connection tab * DOCSP-37463 general connection tab * DOCSP-37463 general connection tab * DOCSP-37463 general connection tab * DOCSP-37463 general connection tab * DOCSP-37463 general connection tab * DOCSP-37463 copy edits * DOCSP-37463 copy edits * DOCSP-37463 tech edits * DOCSP-37463 tech edits * DOCSP-37461 Connections Sidebar Page (#646) * DOCSP-37461 creating interact with your connections page * DOCSP-37461 creating interact with your connections page * DOCSP-37461 creating interact with your connections page * DOCSP-37461 creating interact with your connections page * DOCSP-37461 creating interact with your connections page * DOCSP-37461 creating interact with your connections page * DOCSP-37461 Ali comments * DOCSP-37461 Ali comments * DOCSP-37461 Ali comments * Revert "DOCSP-37461 Ali comments" This reverts commit b992c3ad4412ac7e920e43eb44d67743aaaaf8e9. * Revert "DOCSP-37461 Ali comments" This reverts commit 11bb3c62020290f5dde719e14af40970583b17e6. * DOCSP-37461 deleting extra page * DOCSP-37461 copy edits * DOCSP-37461 copy edits * DOCSP-37461 typo * DOCSP-37461 sidebar restructure * DOCSP-37461 sidebar restructure * DOCSP-37461 sidebar restructure * DOCSP-37461 sidebar restructure * DOCSP-37461 sidebar restructure * DOCSP-37461 tech edits * DOCSP-37461 tech edits * DOCSP-37461 move shell option * DOCSP 37460 Updating Compass Multiple Connections Screenshots (#658) * DOCSP-37460 updating Compass screenshots * DOCSP-37460 updating Compass screenshots * DOCSP-37460 ian edits * DOCSP-42696 update Favorite Connections and Performance page (#661) * DOCSP-42696 update Favorite Connections page * DOCSP-42696 update Favorite Connections page * DOCSP-42696 update Favorite Connections page * DOCSP-42696 update Favorite Connections page * DOCSP-42696 adding performance * DOCSP-42696 adding performance * DOCSP-42696 restructuring ToC * DOCSP-42696 restructuring ToC * DOCSP-38430 Julia comments * DOCSP-38430 Julia comments * DOCSP-38430 Julia comments
1 parent a570698 commit 0876f56

26 files changed

+223
-150
lines changed

‎snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ toc_landing_pages = [
2525
"/query/queries",
2626
"/documents",
2727
"/schema",
28+
"/performance",
2829
"/create-agg-pipeline",
2930
"/collections"
3031
]

‎source/connect.txt

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,11 @@ Considerations
5757
Connect
5858
-------
5959

60-
You can connect your deployments by either:
60+
If your connection name is already in the :guilabel:`Connections
61+
Sidebar` of your Compass window, click on the connection name to
62+
connect.
63+
64+
Otherwise, you can connect your deployments by either:
6165

6266
- Providing your connection string.
6367

@@ -66,8 +70,12 @@ You can connect your deployments by either:
6670
TLS/SSL, and SSH connection options. To learn more, see
6771
:ref:`<advanced-connection-options>`.
6872

69-
Paste Connection String
70-
~~~~~~~~~~~~~~~~~~~~~~~
73+
.. note::
74+
75+
.. include:: /includes/multiple-connections.rst
76+
77+
Provide your Connection String
78+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7179

7280
When you provide a connection string, |compass-short| supports
7381
most :manual:`Connection String Options
@@ -88,27 +96,28 @@ on GitHub.
8896

8997
.. include:: /includes/starting-compass-paste-string.rst
9098

99+
Use Advanced Connection Options
100+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101+
102+
.. include:: /includes/intro-advanced-connection-options.rst
103+
104+
For details, see :ref:`advanced-connection-options`.
105+
91106
Connect to Compass from the Command Line
92107
----------------------------------------
93108

94109
.. include:: /includes/intro-command-line-connection.rst
95110

96111
For details, see :ref:`comp-command-line-connect`.
97112

98-
Advanced Connection Options
99-
---------------------------
100-
101-
.. include:: /includes/intro-advanced-connection-options.rst
102-
103-
For details, see :ref:`advanced-connection-options`.
104-
105113
.. seealso::
106114

107115
To learn how to disconnect your deployment, see :ref:`<disconnect-tab>`
108116

109117
.. toctree::
110118
:titlesonly:
111119

120+
/connect/connections
112121
/connect/connect-from-the-command-line
113122
/connect/advanced-connection-options
114123
/connect/favorite-connections

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ Procedure
2525
.. procedure::
2626
:style: normal
2727

28+
.. step:: Open the :guilabel:`New Connection` modal.
29+
30+
.. include:: /includes/open-new-connection.rst
31+
2832
.. step:: Click :guilabel:`Advanced Connection Options`.
2933

3034
.. figure:: /images/compass/advanced-connection-options.png

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ Procedure
2323
.. procedure::
2424
:style: normal
2525

26+
.. step:: Open the :guilabel:`New Connection` modal.
27+
28+
.. include:: /includes/open-new-connection.rst
29+
2630
.. step:: Click :guilabel:`Advanced Connection Options`.
2731

2832
.. figure:: /images/compass/advanced-connection-options.png

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,20 @@ The :guilabel:`General` connection tab allows you to select a
1616
:guilabel:`Connection String Scheme` and configure the hostname or hosts
1717
used to connect to your MongoDB deployment.
1818

19+
.. note::
20+
21+
.. include:: /includes/multiple-connections.rst
22+
1923
Procedure
2024
---------
2125

2226
.. procedure::
2327
:style: normal
2428

29+
.. step:: Open the :guilabel:`New Connection` modal.
30+
31+
.. include:: /includes/open-new-connection.rst
32+
2533
.. step:: Click :guilabel:`Advanced Connection Options`.
2634

2735
.. figure:: /images/compass/advanced-connection-options.png

‎source/connect/advanced-connection-options/in-use-encryption.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ Procedure
2525
.. procedure::
2626
:style: normal
2727

28+
.. step:: Open the :guilabel:`New Connection` modal.
29+
30+
.. include:: /includes/open-new-connection.rst
31+
2832
.. step:: Click :guilabel:`Advanced Connection Options`.
2933

3034
.. figure:: /images/compass/advanced-connection-options.png

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ Procedure
2121
.. procedure::
2222
:style: normal
2323

24+
.. step:: Open the :guilabel:`New Connection` modal.
25+
26+
.. include:: /includes/open-new-connection.rst
27+
2428
.. step:: Click :guilabel:`Advanced Connection Options`.
2529

2630
.. figure:: /images/compass/advanced-connection-options.png

‎source/connect/advanced-connection-options/tls-ssl-connection.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ Procedure
2222
.. procedure::
2323
:style: normal
2424

25+
.. step:: Open the :guilabel:`New Connection` modal.
26+
27+
.. include:: /includes/open-new-connection.rst
28+
2529
.. step:: Click :guilabel:`Advanced Connection Options`.
2630

2731
.. figure:: /images/compass/advanced-connection-options.png

‎source/connect/connections.txt

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
.. _connections-sidebar:
2+
3+
===================
4+
Connections Sidebar
5+
===================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
.. note::
16+
17+
.. include:: /includes/multiple-connections.rst
18+
19+
20+
The :guilabel:`Connections Sidebar` on the left of the Compass window
21+
contains the following options:
22+
23+
- :icon-lg:`Plus` icon to add new connections
24+
- :icon-fa5:`ellipsis-h` icon to import and export connections
25+
- Search bar to search active connections
26+
- :guilabel:`Connections` list
27+
28+
.. figure:: /images/compass/connections-sidebar.png
29+
:figwidth: 750px
30+
:alt: Connections Sidebar
31+
32+
Connections List
33+
----------------
34+
35+
The :guilabel:`Connections` list in the sidebar contains your
36+
:ref:`favorite <favorite-connections>` and saved connections. Favorite
37+
connections have a :icon-fa5:`star` next to the connection name and
38+
always appear at the top of the connections list.
39+
40+
Connect to MongoDB
41+
------------------
42+
43+
To connect to a saved or favorite deployment, click the name of the
44+
connection in the :guilabel:`Connections` list. Once you connect,
45+
Compass shows a success toast and displays a green dot next to the
46+
connection name.
47+
48+
If a connection error occurs, Compass shows a toast with error
49+
information and displays a red triangle next to the connection name. To
50+
see additional error information, click :guilabel:`Review` in the error
51+
toast.
52+
53+
To add a new connection to Compass, click the :icon-lg:`Plus` button at
54+
the top of the :guilabel:`Connections Sidebar` to open the
55+
:guilabel:`New Connection` modal. For more information, see
56+
:ref:`connect-run-compass`.
57+
58+
To switch between connections, click the name of the connection you want
59+
to interact with to open the :guilabel:`Databases` tab. When you open a
60+
database, MongoDB opens a new tab and labels it with the name of the
61+
MongoDB instance that contains that database. For more information about
62+
the :guilabel:`Databases` tab and instructions on viewing a database,
63+
see :doc:`Databases </databases>`.
64+
65+
Connection Options
66+
------------------
67+
68+
To see connection options, hover over the name of the connection in the
69+
:guilabel:`Connections` list. Then, click on the :icon-fa5:`ellipsis-h`
70+
icon to open a menu with the following items:
71+
72+
- View :ref:`performance metrics <performance-tab>`
73+
- Show connection information
74+
- Refresh databases
75+
- Disconnect
76+
- Copy connection string
77+
- Favorite (or Unfavorite)
78+
- Duplicate
79+
- Remove
80+
81+
To open the MongoDB Shell, click the :icon-lg:`Shell` icon on the right
82+
of the connection name.
83+

‎source/connect/favorite-connections.txt

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,11 @@ specifications.
2323
Save a Favorite Connection
2424
--------------------------
2525

26-
You can save a favorite connection from the initial
27-
:ref:`connect screen <connect-run-compass>`, or after you have
28-
successfully connected to a MongoDB deployment.
26+
You can save a favorite connection from the :guilabel:`New Connection
27+
Modal` or after you successfully connect to a MongoDB deployment.
2928

30-
Save from Connect Screen
31-
~~~~~~~~~~~~~~~~~~~~~~~~
29+
Save from New Connection Modal
30+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3231

3332
.. include:: /includes/steps/favorite-connection-save.rst
3433

@@ -37,16 +36,6 @@ Save after Connecting to a Deployment
3736

3837
.. include:: /includes/steps/favorite-connection-save-deployment.rst
3938

40-
Edit a Favorite Connection
41-
--------------------------
42-
43-
.. include:: /includes/steps/favorite-connection-edit.rst
44-
45-
Delete a Favorite Connection
46-
----------------------------
47-
48-
.. include:: /includes/steps/favorite-connection-delete.rst
49-
5039
Considerations
5140
--------------
5241

‎source/databases.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,13 @@ Databases Tab
2121

2222
The :guilabel:`Databases` tab lists the existing databases for your
2323
MongoDB deployment. To access the :guilabel:`Databases` tab, click the
24-
cluster name in the upper left corner and select the
25-
:guilabel:`Databases` tab.
24+
deployment name in the :guilabel:`Connections Sidebar`.
2625

27-
.. figure:: /images/compass/database-tab.png
28-
:figwidth: 700px
29-
:alt: Database Tab
26+
.. figure:: /images/compass/databases-view.png
27+
:figwidth: 690px
28+
:alt: Databases View
3029

31-
From this view, you can click a database name in the list to view its
30+
From this view, you can click a database name in the sidebar to view its
3231
:doc:`collections </collections>`. Alternatively, you can view
3332
database collections by clicking the desired database in the left-hand navigation.
3433

‎source/images/compass/advanced-connection-options.png

17.7 KB
Loading

‎source/images/compass/connections-sidebar.png

226 KB
Loading

‎source/images/compass/databases-view.png

457 KB
Loading

‎source/images/compass/select-database.png

226 KB
Loading

‎source/includes/multiple-connections.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Starting in version 1.44.0, you can connect to multiple MongoDB
2+
instances at once through Compass.

‎source/includes/open-new-connection.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
In the bottom panel of the :guilabel:`Connections Sidebar`, click
2+
:guilabel:`Add New Connection` to open the :guilabel:`New Connection`
3+
modal.
4+
5+
If you already have connections listed in the :guilabel:`Connections
6+
Sidebar`, click the :icon-lg:`Plus` icon on the top right of the sidebar
7+
to open the :guilabel:`New Connection` modal.

‎source/includes/starting-compass-paste-string.rst

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
.. procedure::
22
:style: normal
33

4+
.. step:: Open the :guilabel:`New Connection` modal.
5+
6+
.. include:: /includes/open-new-connection.rst
7+
48
.. step:: Paste your connection string.
59

610
If you have the connection string for your deployment available, you can
@@ -23,16 +27,30 @@
2327
.. include:: /includes/fact-hide-connection-string-password.rst
2428

2529
To learn how to format the connection string for a deployment that is not
26-
hosted on |service|, see :manual:`Connection String URI Format </reference/connection-string>`.
30+
hosted on |service|, see :manual:`Connection String URI Format
31+
</reference/connection-string>`.
32+
33+
.. step:: (Optional). Name your connection.
34+
35+
Use the name field to enter a name for your connection. If you do
36+
not specify a name, Compass uses the cluster's hostname as the
37+
connection name.
38+
39+
.. step:: (Optional). Choose a color for your connection.
40+
41+
Use the color drop-down menu to select a label color for your
42+
connection. When you connect to a connection, the label color is
43+
the background color of tabs that reference your connection.
44+
45+
.. step:: (Optional). Favorite your connection.
46+
47+
If you want to save the connection as a favorite, check the
48+
:guilabel:`Favorite this connection` option in the modal.
2749

2850
.. step:: Connect to your cluster.
2951

30-
Click :guilabel:`Connect` or :guilabel:`Save & Connect` to navigate to the
52+
Click :guilabel:`Save` or :guilabel:`Save & Connect` to navigate to the
3153
|compass-short| :doc:`Home Page </instance>`.
32-
33-
The :guilabel:`Save & Connect` button prompts you to save your connection
34-
string as a :ref:`Favorite Connection <favorite-connections>` and then
35-
navigates to the home page.
3654

3755
.. important:: Required Access
3856

‎source/includes/steps-create-database.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
title: Click the :guilabel:`Create Database` button.
1+
title: Open the :guilabel:`Create Database` dialog.
22
level: 4
33
ref: create-database
44
content: |
5-
From the :ref:`Databases <database-tab>` tab, click the
6-
:guilabel:`Create Database` button to bring up the
5+
In the :guilabel:`Connections Sidebar`, click the
6+
:icon-lg:`Plus` icon to the right of the connection name to bring up the
77
:guilabel:`Create Database` dialog.
88
99
---

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

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)