Skip to content

Commit b5c549b

Browse files
jocelyn-mendez1Jocelyn Mendez
authored and
jeff-allen-mongo
committed
DOCSP-20684 Connect to MongoDB page updated (#374)
* DOCSP-20684 connect mongodb pages * DOCSP-20684 connect mongodb page * DOCSP-20684 updated schema to connection string scheme * DOCSP-20684 fixed bullet for connection options * DOCSP-20684 fixed bullet for connection options Co-authored-by: Jocelyn Mendez <[email protected]>
1 parent 8cfef19 commit b5c549b

File tree

8 files changed

+128
-42
lines changed

8 files changed

+128
-42
lines changed

‎source/connect.txt

Lines changed: 50 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -49,68 +49,76 @@ Connect
4949

5050
When you open |compass-short|, an initial connection dialog appears:
5151

52-
.. figure:: /images/compass/paste-connection-string.png
52+
.. figure:: /images/compass/new-connection.png
5353
:figwidth: 690px
54-
:alt: Connection dialog for pasting your connection string
54+
:alt: New connection dialog for pasting your connection string
5555

56-
|compass-short| provides two methods to connect to your deployment,
57-
either providing your deployment connection string or filling in your
58-
deployment information in specific fields.
56+
You can connect your deployments by either:
5957

60-
.. tabs::
58+
- Providing your connection string.
6159

62-
.. tab:: Paste Connection String
63-
:tabid: paste-connection-string
60+
- Specifying :guilabel:`Advanced Connection Options`.
61+
Advanced connection options allow you to specify authentication,
62+
TLS/SSL, and SSH connection options. To learn more, see
63+
:ref:`<advanced-connection-options>`.
6464

65-
When you provide a connection string, |compass-short| supports
66-
most :manual:`Connection String Options
67-
</reference/connection-string/#connection-string-options>`
68-
supported by MongoDB.
65+
Paste Connection String
66+
~~~~~~~~~~~~~~~~~~~~~~~
6967

70-
By default, |compass-short|'s default
71-
:manual:`socketTimeoutMS </reference/connection-string/#urioption.socketTimeoutMS>`
72-
value is 60000, or 60 seconds. If you are frequently experiencing
73-
timeouts in |compass-short|, consider setting this option to a
74-
higher value in your connection string.
68+
When you provide a connection string, |compass-short| supports
69+
most :manual:`Connection String Options
70+
</reference/connection-string/#connection-string-options>`
71+
supported by MongoDB.
7572

76-
For a complete list of the connection string options which
77-
|compass-short| supports, see the
78-
`Compass Connection README
79-
<https://github.com/mongodb-js/connection-model/blob/master/README.md#properties>`__
80-
on GitHub.
73+
By default, |compass-short|'s default
74+
:manual:`socketTimeoutMS </reference/connection-string/#urioption.socketTimeoutMS>`
75+
value is 60000, or 60 seconds. If you are frequently experiencing
76+
timeouts in |compass-short|, consider setting this option to a
77+
higher value in your connection string.
8178

82-
.. include:: /includes/steps/starting-compass-paste-string.rst
79+
For a complete list of the connection string options that
80+
|compass-short| supports, see the
81+
`Compass Connection README
82+
<https://github.com/mongodb-js/connection-model/blob/master/README.md#properties>`__
83+
on GitHub.
8384

84-
.. tab:: Fill in Connection Fields Individually
85-
:tabid: individual-fields
85+
.. include:: /includes/steps/starting-compass-paste-string.rst
8686

87-
.. include:: /includes/steps/starting-compass-individual-fields.rst
87+
.. _advanced-connection-options:
8888

89-
.. note::
89+
Advanced Connection Options
90+
---------------------------
9091

91-
|compass| securely stores sensitive information entered in the
92-
connection form using an API that is specific to your operating
93-
system.
92+
The Advanced Connection Options provide additonal forms of connecting
93+
|compass-short| deployments.
9494

95-
For more information on how |compass-short| handles sensitive
96-
data, refer to the
97-
:ref:`FAQ page <compass-faq-confidential-data>`.
95+
:doc:`/connect/general-connection`
96+
Learn how to select a Connection String Scheme for your deployment.
9897

99-
.. _disconnect:
98+
:doc:`/connect/authentication-connection`
99+
Learn how to connect deployments that require authentication.
100100

101-
Disconnect
102-
----------
101+
:doc:`/connect/tls-ssl-connection`
102+
Learn how to connect deployments via TLS/SSL.
103103

104-
.. include:: /includes/steps/disconnect-compass.rst
104+
:doc:`/connect/ssh-connection`
105+
Learn how to connect deployments via an SSH tunnel.
105106

106-
Disconnecting from a MongoDB instance closes the Compass connection to
107-
the active instance and returns the Compass view to the initial
108-
connection dialog.
107+
:doc:`/connect/advanced-connection`
108+
Learn about additional advanced connection options for your deployments.
109109

110-
.. |home| unicode:: U+2302
110+
.. seealso::
111+
112+
To learn how to disconnect your deployment, see :ref:`<disconnect-tab>`
111113

112114
.. toctree::
113115
:titlesonly:
114-
116+
117+
/connect/general-connection
118+
/connect/authentication-connection
119+
/connect/tls-ssl-connection
120+
/connect/ssh-connection
121+
/connect/advanced-connection
115122
/connect/required-access
116123
/connect/favorite-connections
124+
/connect/disconnect

‎source/connect/advanced-connection.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _advanced-connection-tab:
2+
3+
===================
4+
Advanced Connection
5+
===================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol

‎source/connect/authentication-connection.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _authentication-connection-tab:
2+
3+
=========================
4+
Authentication Connection
5+
=========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol

‎source/connect/disconnect.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _disconnect-tab:
2+
3+
=====================
4+
Disconnect Connection
5+
=====================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol

‎source/connect/general-connection.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _general-connection-tab:
2+
3+
==================
4+
General Connection
5+
==================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol

‎source/connect/ssh-connection.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _ssh-connection:
2+
3+
=====================
4+
SSH Tunnel Connection
5+
=====================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _tls-ssl-tab:
2+
3+
==================
4+
TLS/SSL Connection
5+
==================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol

‎source/images/compass/new-connection.png

243 KB
Loading

0 commit comments

Comments
 (0)