Skip to content

Commit 5217ad4

Browse files
skerschbkay-kim
authored andcommitted
DOCSP-2477:add language to clarify URIWriter
1 parent 9b984a0 commit 5217ad4

File tree

6 files changed

+46
-25
lines changed

6 files changed

+46
-25
lines changed

source/includes/drivers_connect.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,18 +44,18 @@
4444
- id: compass
4545
content: |
4646

47-
MongoDB Compass can detect whether you have a MongoDB URI
48-
connection string in your system clipboard and auto-populate
49-
the connection dialog from the URI.
50-
51-
First, copy the URI string below.
52-
53-
.. code-block:: sh
54-
55-
<URISTRING>
56-
57-
Now start Compass. Compass will be able to access the URI and
58-
use it for the connection.
47+
If you wish to manually configure your Compass connection, load
48+
Compass and select the ``New Connection`` link. You will see a
49+
form where you can enter connection information for MongoDB.
50+
51+
Atlas users can copy a URI string from the Atlas
52+
console into Compass. MongoDB Compass can detect whether you have a MongoDB
53+
URI connection string in your system clipboard and auto-
54+
populate the connection dialog from the URI.
55+
56+
See :doc:`/guides/cloud/connectionstring` for information on
57+
how to get the Atlas connection string URI into your copy
58+
buffer.
5959

6060
If Compass was already running when you copied the URI string,
6161
click the :guilabel:`NEW CONNECTION` button.

source/includes/steps-drivers_install_gs.yaml

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content: |
77
.. include:: /includes/drivers_install.rst
88
99
---
10-
title: Create the MongoDB Connection URI String
10+
title: Get the MongoDB Connection URI String
1111
ref: connection_string
1212
level: 4
1313
stepnum: 2
@@ -18,14 +18,37 @@ content: |
1818
supplied as a parameter to the ``mongo`` shell, Compass, and the
1919
MongoDB drivers to connect to a MongoDB
2020
deployment.
21+
22+
Atlas users can retrieve their URI strings from the Atlas web console.
23+
For information on how to do that, please see the
24+
:doc:`/guides/cloud/connectionstring` guide.
25+
26+
.. note::
27+
28+
The URI form below allows you to create a URI string for your
29+
session in MongoDB Guides -- from either the connection string
30+
that Atlas provides, or by filling out the form for on-premises
31+
MongoDB instances. Once you provide the string or fill out the
32+
form, any relevant code examples within the MongoDB Guides will be
33+
populated with a URI string. You can change these at any time by
34+
repopulating the form.
2135
22-
Use the form below to populate the URI string.
36+
Use the fields below to create your URI string in MongoDB Guides and
37+
populate the code examples.
38+
39+
.. tip::
40+
41+
Users of Compass should skip this step and load Compass directly
42+
with the URI String in the copy buffer (for Atlas), or by
43+
populating the ``New Connection`` form in Compass.
2344
24-
.. note:: The $[password] will not be replaced in the string below, so you will
25-
need to replace the string with your password.
26-
Use caution where you store and enter passwords, particularly when
27-
running from a shell or command prompt. Special characters
28-
in passwords must be escaped.
45+
.. warning::
46+
47+
The $[password] will not be replaced in the string below, so you
48+
will need to replace the string with your password. Use caution
49+
where you store and enter passwords, particularly when running from
50+
a shell or command prompt. Special characters in passwords must be
51+
escaped.
2952
3053
.. uriwriter::
3154
---

source/includes/steps-insert_server.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ level: 4
44
stepnum: 1
55
content: |
66
7-
If you haven't already done so, use :doc:`the connection URI form
8-
</guides/server/drivers>` to construct the connection string
9-
required for this guide.
7+
If you haven't already done so, non-Compass users may use :doc:`the connection URI form </guides/server/drivers>` to construct the connection string required.
108
119
.. include:: /includes/drivers_connect.rst
1210
---

source/includes/steps-read_operators.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ level: 4
44
stepnum: 1
55
content: |
66
7-
If you haven't already done so, use `the connection URI form <https://docs-mongodbcom-staging.corp.mongodb.com/docs-tutorials/skersch/Guides/guides/server/drivers.html#craft-a-uri-to-connect-to-mongodb>`__ to construct the connection string required.
7+
If you haven't already done so, non-Compass users may use :doc:`the connection URI form </guides/server/drivers>` to construct the connection string required.
88
99
1010
.. include:: /includes/drivers_connect.rst

source/includes/steps-read_server.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ level: 4
44
stepnum: 1
55
content: |
66
7-
If you haven't already done so, use :doc:`the connection URI form </guides/server/drivers>` to construct the connection string required.
7+
If you haven't already done so, non-Compass users may use :doc:`the connection URI form </guides/server/drivers>` to construct the connection string required.
88
99
1010
.. include:: /includes/drivers_connect.rst

source/includes/steps-read_server_query.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ level: 4
44
stepnum: 1
55
content: |
66
7-
If you haven't already done so, use :doc:`the connection URI form </guides/server/drivers>` to construct the connection string required.
7+
If you haven't already done so, non-Compass users may use :doc:`the connection URI form </guides/server/drivers>` to construct the connection string required.
88
99
.. include:: /includes/drivers_connect.rst
1010
---

0 commit comments

Comments
 (0)