Skip to content

Commit 7736a4a

Browse files
authored
DOCSP-42971-vscode-nested-components (#93)
1 parent 644cef0 commit 7736a4a

File tree

4 files changed

+36
-46
lines changed

4 files changed

+36
-46
lines changed

source/commands.txt

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _vsce-commands:
22

3-
=====================
4-
|vsce-short| Commands
5-
=====================
3+
=======================
4+
|vscode-short| Commands
5+
=======================
66

77
.. default-domain:: mongodb
88

@@ -76,10 +76,8 @@ To learn more about connecting to a deployment, see :ref:`vsce-connect`.
7676
- Select and remove a connection from your list of connections
7777
in |vsce|.
7878

79-
.. note::
80-
81-
Removing your current active connection also closes that
82-
connection.
79+
Removing your current active connection also closes that
80+
connection.
8381

8482
Shell Commands
8583
--------------
Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
1-
.. important::
1+
To launch your selected MongoDB shell, you must:
22

3-
To launch your selected MongoDB shell, you must:
3+
- Install the shell you want to use, and
44

5-
- Install the shell you want to use, and
5+
- Configure your machine's ``PATH`` environment variable to include
6+
the filepath to your shell binary.
67

7-
- Configure your machine's ``PATH`` environment variable to include
8-
the filepath to your shell binary.
8+
If you install a new version of your MongoDB shell, you will need to
9+
update your ``PATH`` variable to reference the new version.
910

10-
If you install a new version of your MongoDB shell, you will need to
11-
update your ``PATH`` variable to reference the new version.
11+
- To install the legacy :binary:`mongo <mongo>`
12+
shell, see :manual:`The mongo Shell </mongo>`.
1213

13-
.. seealso::
14-
15-
- To install the legacy :binary:`mongo <mongo>`
16-
shell, see :manual:`The mongo Shell </mongo>`.
17-
18-
- To install the ``mongosh`` shell and for instructions on
19-
configuring your ``PATH`` variable, see :mongosh:`Install the MongoDB Shell </install>`.
14+
- To install the ``mongosh`` shell and for instructions on
15+
configuring your ``PATH`` variable, see :mongosh:`Install the MongoDB Shell </install>`.

source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -157,33 +157,30 @@ content: |
157157
specify the :guilabel:`Hostname`. You do not need to
158158
specify a port.
159159
160-
.. note::
161-
162-
You can only use SRV connection strings to connect to
163-
deployments running MongoDB 3.6 and later.
160+
164161
165162
SRV connection strings have a prefix of
166163
``mongodb+srv:``. If you are using an SRV connection
167164
string, you do not need to include ``mongodb+srv`` in
168165
your :guilabel:`Hostname`.
169166
170-
.. example::
167+
For example:
171168
172-
If the following is your SRV connection string for
173-
your MongoDB deployment:
169+
If the following is your SRV connection string for
170+
your MongoDB deployment:
174171
175-
.. code-block:: shell
176-
:copyable: false
172+
.. code-block:: shell
173+
:copyable: false
177174
178-
mongodb+srv://<username>:<password>@gettingstarted-7q2cs.mongodb.net/test
175+
mongodb+srv://<username>:<password>@gettingstarted-7q2cs.mongodb.net/test
179176
180-
Then, in |vsce|, you would specify your
181-
:guilabel:`Hostname` as:
177+
Then, in |vsce|, you would specify your
178+
:guilabel:`Hostname` as:
182179
183-
.. code-block:: shell
184-
:copyable: false
180+
.. code-block:: shell
181+
:copyable: false
185182
186-
gettingstarted-7q2cs.mongodb.net
183+
gettingstarted-7q2cs.mongodb.net
187184
188185
* - :guilabel:`Authentication`
189186
- Authentication to use if the deployment requires
@@ -258,14 +255,13 @@ content: |
258255
provide the :guilabel:`Username` to authenticate
259256
the user.
260257
261-
.. note::
262258
263-
If you are using
264-
:atlas:`Atlas-managed certificates </security-add-mongodb-users/#select-an-authentication-method>`
265-
, your username must be prefaced by "CN="
266-
per `RFC 2253 <https://tools.ietf.org/html/rfc2253>`__.
267-
For example, the username "X509User" must be
268-
provided as "CN=X509User".
259+
If you are using
260+
:atlas:`Atlas-managed certificates </security-add-mongodb-users/#select-an-authentication-method>`
261+
, your username must be prefaced by "CN="
262+
per `RFC 2253 <https://tools.ietf.org/html/rfc2253>`__.
263+
For example, the username "X509User" must be
264+
provided as "CN=X509User".
269265
270266
- id: ldap
271267
name: LDAP

source/settings.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _vsce-settings:
22

3-
=====================
4-
|vsce-short| Settings
5-
=====================
3+
=======================
4+
|vscode-short| Settings
5+
=======================
66

77
.. default-domain:: mongodb
88

0 commit comments

Comments
 (0)