From d88fb3a0e04c9d36648761d3589b68c86e29951f Mon Sep 17 00:00:00 2001 From: Grace Miller Date: Fri, 13 Sep 2024 11:42:36 -0400 Subject: [PATCH 1/5] DOCSP-42971-vscode-nested-components --- source/commands.txt | 6 ++---- .../admonitions/warn-configure-path.rst | 2 -- ...ect-with-advanced-connection-settings.yaml | 21 +++++++++---------- 3 files changed, 12 insertions(+), 17 deletions(-) diff --git a/source/commands.txt b/source/commands.txt index 7cb0e755..041fcc56 100644 --- a/source/commands.txt +++ b/source/commands.txt @@ -76,10 +76,8 @@ To learn more about connecting to a deployment, see :ref:`vsce-connect`. - Select and remove a connection from your list of connections in |vsce|. - .. note:: - - Removing your current active connection also closes that - connection. + Removing your current active connection also closes that + connection. Shell Commands -------------- diff --git a/source/includes/admonitions/warn-configure-path.rst b/source/includes/admonitions/warn-configure-path.rst index 017d9ab2..e2fa3f51 100644 --- a/source/includes/admonitions/warn-configure-path.rst +++ b/source/includes/admonitions/warn-configure-path.rst @@ -1,4 +1,3 @@ -.. important:: To launch your selected MongoDB shell, you must: @@ -10,7 +9,6 @@ If you install a new version of your MongoDB shell, you will need to update your ``PATH`` variable to reference the new version. -.. seealso:: - To install the legacy :binary:`mongo ` shell, see :manual:`The mongo Shell `. diff --git a/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml b/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml index 1e6e1e3c..0d607236 100644 --- a/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml +++ b/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml @@ -157,17 +157,17 @@ content: | specify the :guilabel:`Hostname`. You do not need to specify a port. - .. note:: + - You can only use SRV connection strings to connect to - deployments running MongoDB 3.6 and later. + You can only use SRV connection strings to connect to + deployments running MongoDB 3.6 and later. SRV connection strings have a prefix of ``mongodb+srv:``. If you are using an SRV connection string, you do not need to include ``mongodb+srv`` in your :guilabel:`Hostname`. - .. example:: + For example: If the following is your SRV connection string for your MongoDB deployment: @@ -258,14 +258,13 @@ content: | provide the :guilabel:`Username` to authenticate the user. - .. note:: - If you are using - :atlas:`Atlas-managed certificates ` - , your username must be prefaced by "CN=" - per `RFC 2253 `__. - For example, the username "X509User" must be - provided as "CN=X509User". + If you are using + :atlas:`Atlas-managed certificates ` + , your username must be prefaced by "CN=" + per `RFC 2253 `__. + For example, the username "X509User" must be + provided as "CN=X509User". - id: ldap name: LDAP From 20574d89e422c0b3cf0d38d7d9080e55da865364 Mon Sep 17 00:00:00 2001 From: Grace Miller Date: Fri, 13 Sep 2024 16:26:27 -0400 Subject: [PATCH 2/5] took out extranous line --- ...tarting-vsce-connect-with-advanced-connection-settings.yaml | 3 --- 1 file changed, 3 deletions(-) diff --git a/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml b/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml index 0d607236..59da979c 100644 --- a/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml +++ b/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml @@ -159,9 +159,6 @@ content: | - You can only use SRV connection strings to connect to - deployments running MongoDB 3.6 and later. - SRV connection strings have a prefix of ``mongodb+srv:``. If you are using an SRV connection string, you do not need to include ``mongodb+srv`` in From 43dc9627b23a8cf0a51932989403a89b94beecb5 Mon Sep 17 00:00:00 2001 From: Grace Miller Date: Mon, 16 Sep 2024 11:34:14 -0400 Subject: [PATCH 3/5] build errors --- source/commands.txt | 2 +- .../admonitions/warn-configure-path.rst | 20 +++++++++---------- ...ect-with-advanced-connection-settings.yaml | 10 +++++----- source/settings.txt | 2 +- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/source/commands.txt b/source/commands.txt index 041fcc56..fcbec25f 100644 --- a/source/commands.txt +++ b/source/commands.txt @@ -1,7 +1,7 @@ .. _vsce-commands: ===================== -|vsce-short| Commands +|vscode-short| Commands ===================== .. default-domain:: mongodb diff --git a/source/includes/admonitions/warn-configure-path.rst b/source/includes/admonitions/warn-configure-path.rst index e2fa3f51..e26791dd 100644 --- a/source/includes/admonitions/warn-configure-path.rst +++ b/source/includes/admonitions/warn-configure-path.rst @@ -1,17 +1,17 @@ - To launch your selected MongoDB shell, you must: + To launch your selected MongoDB shell, you must: - - Install the shell you want to use, and + - Install the shell you want to use, and - - Configure your machine's ``PATH`` environment variable to include - the filepath to your shell binary. + - Configure your machine's ``PATH`` environment variable to include + the filepath to your shell binary. - If you install a new version of your MongoDB shell, you will need to - update your ``PATH`` variable to reference the new version. + If you install a new version of your MongoDB shell, you will need to + update your ``PATH`` variable to reference the new version. - - To install the legacy :binary:`mongo ` - shell, see :manual:`The mongo Shell `. + - To install the legacy :binary:`mongo ` + shell, see :manual:`The mongo Shell `. - - To install the ``mongosh`` shell and for instructions on - configuring your ``PATH`` variable, see :mongosh:`Install the MongoDB Shell `. + - To install the ``mongosh`` shell and for instructions on + configuring your ``PATH`` variable, see :mongosh:`Install the MongoDB Shell `. diff --git a/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml b/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml index 59da979c..27234066 100644 --- a/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml +++ b/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml @@ -164,23 +164,23 @@ content: | string, you do not need to include ``mongodb+srv`` in your :guilabel:`Hostname`. - For example: + For example: If the following is your SRV connection string for your MongoDB deployment: .. code-block:: shell - :copyable: false + :copyable: false - mongodb+srv://:@gettingstarted-7q2cs.mongodb.net/test + mongodb+srv://:@gettingstarted-7q2cs.mongodb.net/test Then, in |vsce|, you would specify your :guilabel:`Hostname` as: .. code-block:: shell - :copyable: false + :copyable: false - gettingstarted-7q2cs.mongodb.net + gettingstarted-7q2cs.mongodb.net * - :guilabel:`Authentication` - Authentication to use if the deployment requires diff --git a/source/settings.txt b/source/settings.txt index 85f49590..e08d4300 100644 --- a/source/settings.txt +++ b/source/settings.txt @@ -1,7 +1,7 @@ .. _vsce-settings: ===================== -|vsce-short| Settings +|vscode-short| Settings ===================== .. default-domain:: mongodb From 6fa8932d7db25096a2435f4e096392be00145634 Mon Sep 17 00:00:00 2001 From: Grace Miller Date: Mon, 16 Sep 2024 16:48:17 -0400 Subject: [PATCH 4/5] more build errors --- source/commands.txt | 4 ++-- .../admonitions/warn-configure-path.rst | 22 +++++++++---------- ...ect-with-advanced-connection-settings.yaml | 20 ++++++++--------- source/settings.txt | 4 ++-- 4 files changed, 24 insertions(+), 26 deletions(-) diff --git a/source/commands.txt b/source/commands.txt index fcbec25f..da6cfb36 100644 --- a/source/commands.txt +++ b/source/commands.txt @@ -1,8 +1,8 @@ .. _vsce-commands: -===================== +======================= |vscode-short| Commands -===================== +======================= .. default-domain:: mongodb diff --git a/source/includes/admonitions/warn-configure-path.rst b/source/includes/admonitions/warn-configure-path.rst index e26791dd..f0c010a1 100644 --- a/source/includes/admonitions/warn-configure-path.rst +++ b/source/includes/admonitions/warn-configure-path.rst @@ -1,17 +1,15 @@ +To launch your selected MongoDB shell, you must: - To launch your selected MongoDB shell, you must: +- Install the shell you want to use, and - - Install the shell you want to use, and +- Configure your machine's ``PATH`` environment variable to include + the filepath to your shell binary. - - Configure your machine's ``PATH`` environment variable to include - the filepath to your shell binary. +If you install a new version of your MongoDB shell, you will need to +update your ``PATH`` variable to reference the new version. - If you install a new version of your MongoDB shell, you will need to - update your ``PATH`` variable to reference the new version. +- To install the legacy :binary:`mongo ` + shell, see :manual:`The mongo Shell `. - - - To install the legacy :binary:`mongo ` - shell, see :manual:`The mongo Shell `. - - - To install the ``mongosh`` shell and for instructions on - configuring your ``PATH`` variable, see :mongosh:`Install the MongoDB Shell `. +- To install the ``mongosh`` shell and for instructions on + configuring your ``PATH`` variable, see :mongosh:`Install the MongoDB Shell `. diff --git a/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml b/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml index 27234066..f1694022 100644 --- a/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml +++ b/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml @@ -166,21 +166,21 @@ content: | For example: - If the following is your SRV connection string for - your MongoDB deployment: + If the following is your SRV connection string for + your MongoDB deployment: - .. code-block:: shell - :copyable: false + .. code-block:: shell + :copyable: false - mongodb+srv://:@gettingstarted-7q2cs.mongodb.net/test + mongodb+srv://:@gettingstarted-7q2cs.mongodb.net/test - Then, in |vsce|, you would specify your - :guilabel:`Hostname` as: + Then, in |vsce|, you would specify your + :guilabel:`Hostname` as: - .. code-block:: shell - :copyable: false + .. code-block:: shell + :copyable: false - gettingstarted-7q2cs.mongodb.net + gettingstarted-7q2cs.mongodb.net * - :guilabel:`Authentication` - Authentication to use if the deployment requires diff --git a/source/settings.txt b/source/settings.txt index e08d4300..83841eb6 100644 --- a/source/settings.txt +++ b/source/settings.txt @@ -1,8 +1,8 @@ .. _vsce-settings: -===================== +======================= |vscode-short| Settings -===================== +======================= .. default-domain:: mongodb From 0a2ccd2b817af738a1bb44ee0dbb98898cbd5854 Mon Sep 17 00:00:00 2001 From: Grace Miller Date: Mon, 16 Sep 2024 16:55:05 -0400 Subject: [PATCH 5/5] be --- ...ect-with-advanced-connection-settings.yaml | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml b/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml index f1694022..eecd2268 100644 --- a/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml +++ b/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml @@ -164,23 +164,23 @@ content: | string, you do not need to include ``mongodb+srv`` in your :guilabel:`Hostname`. - For example: + For example: - If the following is your SRV connection string for - your MongoDB deployment: + If the following is your SRV connection string for + your MongoDB deployment: - .. code-block:: shell - :copyable: false + .. code-block:: shell + :copyable: false - mongodb+srv://:@gettingstarted-7q2cs.mongodb.net/test + mongodb+srv://:@gettingstarted-7q2cs.mongodb.net/test - Then, in |vsce|, you would specify your - :guilabel:`Hostname` as: + Then, in |vsce|, you would specify your + :guilabel:`Hostname` as: - .. code-block:: shell - :copyable: false + .. code-block:: shell + :copyable: false - gettingstarted-7q2cs.mongodb.net + gettingstarted-7q2cs.mongodb.net * - :guilabel:`Authentication` - Authentication to use if the deployment requires