From cb53bc6d9909c230c9df52ca2b592e21c4282f03 Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Thu, 3 Apr 2025 11:39:50 -0400 Subject: [PATCH 01/12] DOCSP-48590-connect-via-atlas-cli --- source/connect.txt | 9 +++++++++ ...-starting-vsce-connect-with-atlas-cli.yaml | 19 +++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml diff --git a/source/connect.txt b/source/connect.txt index 2fdd23ee..4a51bee9 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -104,6 +104,15 @@ Create a Connection .. include:: /includes/steps/starting-vsce-connect-with-advanced-connection-settings.rst + .. tab:: Connect with Atlas CLI + :tabid: Connect with Atlas CLI + + The :atlascli:`Atlas CLI ` allows you to connect to both your + local and Atlas deployments from MongoDB for VsCode. + + Before beginning, :atlascli:`install the Atlas CLI `. + + .. include:: /includes/steps/starting-vsce-connect-with-atlas-cli.rst .. _vsce-connect-task-atlas-streams: diff --git a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml new file mode 100644 index 00000000..e9557f44 --- /dev/null +++ b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml @@ -0,0 +1,19 @@ +--- +title: Run ``atlas deployment connect`` in your terminal. +level: 4 +ref: vsce-enter-connection-info +content: | + + +--- +title: Select your deployment you wish to connect to. +level: 4 +ref: vsce-open-overview-page +content: | + + +--- +title: Select **"vscode - MongoDB for VsCode"** as your connection method to save. +level: 4 +ref: vsce-connect-paste +content: | From fac1f1e9bcd95ddd2d806dcb7c0a692e247e3dcd Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Thu, 3 Apr 2025 14:51:42 -0400 Subject: [PATCH 02/12] details --- ...ect-with-advanced-connection-settings.yaml | 10 +++---- ...-starting-vsce-connect-with-atlas-cli.yaml | 30 +++++++++++++++++-- ...g-vsce-connect-with-connection-string.yaml | 8 ++--- 3 files changed, 36 insertions(+), 12 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 eecd2268..0a262607 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 @@ -4,7 +4,7 @@ source: file: steps-open-mongodb-view.yaml ref: open-mongodb-view --- -title: Open the |vsce| Overview page +title: Open the |vsce| Overview page. level: 4 ref: create-connection content: | @@ -46,7 +46,7 @@ content: | .. include:: /includes/admonitions/tip-mongodb-command-palette.rst --- -title: Open the Advanced Connection Settings Form +title: Open the Advanced Connection Settings Form. level: 4 ref: vsce-advanced-connection-settings content: | @@ -59,7 +59,7 @@ content: | :alt: Image showing connections pane screen --- -title: Enter your connection information +title: Enter your connection information. ref: vsce-enter-connection-info content: | @@ -487,7 +487,7 @@ content: | tunnel. |vsce| cannot establish a connection to multiple servers across the same SSH tunnel. --- -title: "Specify additional options in the :guilabel:`Advanced` tab" +title: Specify additional options in the :guilabel:`Advanced` tab. level: 4 optional: true ref: connect-additional-options @@ -554,5 +554,5 @@ content: | --- ref: vsce-click-connect level: 4 -title: "Click :guilabel:`Connect`" +title: Click :guilabel:`Connect`. ... diff --git a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml index e9557f44..a825d7f2 100644 --- a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml +++ b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml @@ -1,19 +1,43 @@ --- -title: Run ``atlas deployment connect`` in your terminal. +title: Connect from the Atlas CLI. level: 4 ref: vsce-enter-connection-info content: | + In your terminal, run ``atlas auth login`` to authenticate with your + Atlas login credentials. To learn more, + see :atlascli:`Connect from the {+atlas-cli+} `. --- -title: Select your deployment you wish to connect to. +title: Run the connection command. +level: 4 +ref: vsce-enter-connection-info +content: | + + Run ``atlas deployment connect`` in your terminal. + + .. code-block:: + + atlas deployment connect + + +--- +title: Select your deployment. level: 4 ref: vsce-open-overview-page content: | + Select the deployment you wish to connect to from your list of deployments. + --- -title: Select **"vscode - MongoDB for VsCode"** as your connection method to save. +title: Select |vsce| as your connection method. level: 4 ref: vsce-connect-paste content: | + + The Atlas CLI prompts you to select your connection method. Select + "vscode - MongoDB for VsCode". + + An instance of VS Code will open on the MongoDB for VS Code connections panel. + Your saved connection is now visible and connected. diff --git a/source/includes/steps-starting-vsce-connect-with-connection-string.yaml b/source/includes/steps-starting-vsce-connect-with-connection-string.yaml index dde823cf..de094e99 100644 --- a/source/includes/steps-starting-vsce-connect-with-connection-string.yaml +++ b/source/includes/steps-starting-vsce-connect-with-connection-string.yaml @@ -24,7 +24,7 @@ content: | :manual:`Connection String URI Format `. --- -title: "Open the |vscode-short| Command Palette." +title: Open the |vscode-short| Command Palette. level: 4 ref: vsce-open-overview-page content: | @@ -60,7 +60,7 @@ content: | :figwidth: 600px :alt: Select add connection with connection string - .. tab:: Open from Overview Page + .. tab:: Open from Overview Page. :tabid: mdboverview a. Perform the action described in the following table for your @@ -90,7 +90,7 @@ content: | .. include:: /includes/admonitions/tip-mongodb-command-palette.rst --- -title: "Paste your connection string into the Command Palette" +title: Paste your connection string into the Command Palette. level: 4 ref: vsce-connect-paste content: | @@ -103,7 +103,7 @@ content: | but you won't be able to interact with data in your deployment. --- -title: "Press the **Enter** or **Return** key" +title: Press the **Enter** or **Return** key. level: 4 ref: vsce-connect-enter ... From 6989e0afdf66aba7ea85826d695b197cc7298b95 Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Thu, 3 Apr 2025 14:57:11 -0400 Subject: [PATCH 03/12] punctuation style guide --- source/includes/steps-open-mongodb-view.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/steps-open-mongodb-view.yaml b/source/includes/steps-open-mongodb-view.yaml index d49e8834..05bb3644 100644 --- a/source/includes/steps-open-mongodb-view.yaml +++ b/source/includes/steps-open-mongodb-view.yaml @@ -1,5 +1,5 @@ --- -title: "In |vscode-short|, click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`" +title: "In |vscode-short|, click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`". level: 4 ref: open-mongodb-view content: | From f984907828f98c4e11c35980006a15480c68d772 Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Thu, 3 Apr 2025 15:01:08 -0400 Subject: [PATCH 04/12] fixes --- source/connect.txt | 5 ++--- .../steps-starting-vsce-connect-with-atlas-cli.yaml | 8 ++++---- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/source/connect.txt b/source/connect.txt index 4a51bee9..6b9dc45c 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -108,9 +108,8 @@ Create a Connection :tabid: Connect with Atlas CLI The :atlascli:`Atlas CLI ` allows you to connect to both your - local and Atlas deployments from MongoDB for VsCode. - - Before beginning, :atlascli:`install the Atlas CLI `. + local and Atlas deployments from MongoDB for VsCode. Before beginning, + :atlascli:`install the Atlas CLI `. .. include:: /includes/steps/starting-vsce-connect-with-atlas-cli.rst diff --git a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml index a825d7f2..74e7ce95 100644 --- a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml +++ b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml @@ -6,7 +6,7 @@ content: | In your terminal, run ``atlas auth login`` to authenticate with your Atlas login credentials. To learn more, - see :atlascli:`Connect from the {+atlas-cli+} `. + see :atlascli:`Connect from the Atlas CLI `. --- title: Run the connection command. @@ -37,7 +37,7 @@ ref: vsce-connect-paste content: | The Atlas CLI prompts you to select your connection method. Select - "vscode - MongoDB for VsCode". + **"vscode - MongoDB for VsCode"**. - An instance of VS Code will open on the MongoDB for VS Code connections panel. - Your saved connection is now visible and connected. + You can now acces an instance of VS Code opens on the |vcse| + connections panel, and your saved connection is now visible and connected. From 975395246adfc6ac970d4c367464d04bf1285609 Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Thu, 3 Apr 2025 15:02:41 -0400 Subject: [PATCH 05/12] fixes --- .../includes/steps-starting-vsce-connect-with-atlas-cli.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml index 74e7ce95..403b52db 100644 --- a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml +++ b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml @@ -39,5 +39,5 @@ content: | The Atlas CLI prompts you to select your connection method. Select **"vscode - MongoDB for VsCode"**. - You can now acces an instance of VS Code opens on the |vcse| - connections panel, and your saved connection is now visible and connected. + You can then access an instance of VS Code on the |vcse| + connections panel. Your saved connection is visible and connected. From 093ed356386f8c116ee38ad9375e5e2a2f7a1980 Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Thu, 3 Apr 2025 15:08:33 -0400 Subject: [PATCH 06/12] add vscode step and screenshot --- ...steps-starting-vsce-connect-with-atlas-cli.yaml | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml index 403b52db..84bd3bc7 100644 --- a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml +++ b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml @@ -39,5 +39,15 @@ content: | The Atlas CLI prompts you to select your connection method. Select **"vscode - MongoDB for VsCode"**. - You can then access an instance of VS Code on the |vcse| - connections panel. Your saved connection is visible and connected. + +--- +title: Open |vscode-short| and click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`. +level: 4 +ref: vsce-connect-paste +content: | + + .. figure:: /images/vsce-mongodb-extension-sidemenu.png + :figwidth: 600px + :alt: Image VSCode side bar menu. + + You can view your connected deployment under :guilabel:`Connections`. \ No newline at end of file From 09b95af09c0e2511f8a63703c0a1f6f684b8f636 Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Thu, 3 Apr 2025 15:20:23 -0400 Subject: [PATCH 07/12] render fixes and add second screenshot --- source/includes/steps-open-mongodb-view.yaml | 2 +- .../steps-starting-vsce-connect-with-atlas-cli.yaml | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/source/includes/steps-open-mongodb-view.yaml b/source/includes/steps-open-mongodb-view.yaml index 05bb3644..d599e818 100644 --- a/source/includes/steps-open-mongodb-view.yaml +++ b/source/includes/steps-open-mongodb-view.yaml @@ -1,5 +1,5 @@ --- -title: "In |vscode-short|, click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`". +title: "In |vscode-short|, click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`." level: 4 ref: open-mongodb-view content: | diff --git a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml index 84bd3bc7..0a53887e 100644 --- a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml +++ b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml @@ -50,4 +50,8 @@ content: | :figwidth: 600px :alt: Image VSCode side bar menu. - You can view your connected deployment under :guilabel:`Connections`. \ No newline at end of file + You can view your connected deployment under :guilabel:`Connections`. + + .. figure:: /images/vsce-expand-connections.png + :figwidth: 600px + :alt: Image showing connections pane \ No newline at end of file From cab1888206424784d87015d171349bd526f8f273 Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Thu, 3 Apr 2025 15:30:08 -0400 Subject: [PATCH 08/12] add new refs --- .../steps-starting-vsce-connect-with-atlas-cli.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml index 0a53887e..bca64dca 100644 --- a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml +++ b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml @@ -1,7 +1,7 @@ --- title: Connect from the Atlas CLI. level: 4 -ref: vsce-enter-connection-info +ref: vsce-enter-connection-info-cli content: | In your terminal, run ``atlas auth login`` to authenticate with your @@ -11,7 +11,7 @@ content: | --- title: Run the connection command. level: 4 -ref: vsce-enter-connection-info +ref: vsce-run-connect-command content: | Run ``atlas deployment connect`` in your terminal. @@ -24,7 +24,7 @@ content: | --- title: Select your deployment. level: 4 -ref: vsce-open-overview-page +ref: vsce-select-deployment content: | Select the deployment you wish to connect to from your list of deployments. @@ -33,7 +33,7 @@ content: | --- title: Select |vsce| as your connection method. level: 4 -ref: vsce-connect-paste +ref: vsce-select-connection-method content: | The Atlas CLI prompts you to select your connection method. Select @@ -43,7 +43,7 @@ content: | --- title: Open |vscode-short| and click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`. level: 4 -ref: vsce-connect-paste +ref: vsce-open-connections content: | .. figure:: /images/vsce-mongodb-extension-sidemenu.png From d9321a73457e234e85a7c04583934b98ad642b97 Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Fri, 4 Apr 2025 15:25:19 -0400 Subject: [PATCH 09/12] feedback --- source/includes/steps-open-mongodb-view.yaml | 2 +- ...-starting-vsce-connect-with-atlas-cli.yaml | 68 +++++++------------ 2 files changed, 25 insertions(+), 45 deletions(-) diff --git a/source/includes/steps-open-mongodb-view.yaml b/source/includes/steps-open-mongodb-view.yaml index d599e818..7e9350ab 100644 --- a/source/includes/steps-open-mongodb-view.yaml +++ b/source/includes/steps-open-mongodb-view.yaml @@ -1,5 +1,5 @@ --- -title: "In |vscode-short|, click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`." +title: In |vscode-short|, click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`. level: 4 ref: open-mongodb-view content: | diff --git a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml index bca64dca..7d500c33 100644 --- a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml +++ b/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml @@ -1,57 +1,37 @@ ---- -title: Connect from the Atlas CLI. -level: 4 -ref: vsce-enter-connection-info-cli -content: | +.. procedure:: + :style: normal - In your terminal, run ``atlas auth login`` to authenticate with your - Atlas login credentials. To learn more, - see :atlascli:`Connect from the Atlas CLI `. + .. step:: Connect from the Atlas CLI. ---- -title: Run the connection command. -level: 4 -ref: vsce-run-connect-command -content: | + In your terminal, run ``atlas auth login`` to authenticate with your + Atlas login credentials. To learn more, + see :atlascli:`Connect from the Atlas CLI `. - Run ``atlas deployment connect`` in your terminal. + .. step:: Run the connection command. - .. code-block:: + Run ``atlas deployment connect`` in your terminal. - atlas deployment connect + .. code-block:: + atlas deployment connect ---- -title: Select your deployment. -level: 4 -ref: vsce-select-deployment -content: | + .. step:: Select your deployment. - Select the deployment you wish to connect to from your list of deployments. + Select the deployment you wish to connect to from your list of deployments. + + .. step:: Select |vsce| as your connection method. - ---- -title: Select |vsce| as your connection method. -level: 4 -ref: vsce-select-connection-method -content: | + The Atlas CLI prompts you to select your connection method. Select + **"vscode - MongoDB for VsCode"**. - The Atlas CLI prompts you to select your connection method. Select - **"vscode - MongoDB for VsCode"**. + .. step:: Open |vscode-short| and click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`. + .. figure:: /images/vsce-mongodb-extension-sidemenu.png + :figwidth: 600px + :alt: Image VSCode side bar menu. ---- -title: Open |vscode-short| and click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`. -level: 4 -ref: vsce-open-connections -content: | + You can view your connected deployment under :guilabel:`Connections`. - .. figure:: /images/vsce-mongodb-extension-sidemenu.png - :figwidth: 600px - :alt: Image VSCode side bar menu. - - You can view your connected deployment under :guilabel:`Connections`. - - .. figure:: /images/vsce-expand-connections.png - :figwidth: 600px - :alt: Image showing connections pane \ No newline at end of file + .. figure:: /images/vsce-expand-connections.png + :figwidth: 600px + :alt: Image showing connections pane \ No newline at end of file From 22c012ff99496d5a882afa169e0aca623b96a53b Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Fri, 4 Apr 2025 15:30:45 -0400 Subject: [PATCH 10/12] fix render --- ...as-cli.yaml => steps-starting-vsce-connect-with-atlas-cli.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename source/includes/{steps-starting-vsce-connect-with-atlas-cli.yaml => steps-starting-vsce-connect-with-atlas-cli.rst} (100%) diff --git a/source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml b/source/includes/steps-starting-vsce-connect-with-atlas-cli.rst similarity index 100% rename from source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml rename to source/includes/steps-starting-vsce-connect-with-atlas-cli.rst From 144f175546057767c1bc6ad4e98af4c4cec9fa8e Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Fri, 4 Apr 2025 15:42:33 -0400 Subject: [PATCH 11/12] fix render --- source/connect.txt | 2 +- source/includes/steps-starting-vsce-connect-with-atlas-cli.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/connect.txt b/source/connect.txt index 6b9dc45c..95ce0b66 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -111,7 +111,7 @@ Create a Connection local and Atlas deployments from MongoDB for VsCode. Before beginning, :atlascli:`install the Atlas CLI `. - .. include:: /includes/steps/starting-vsce-connect-with-atlas-cli.rst + .. include:: /includes/starting-vsce-connect-with-atlas-cli.rst .. _vsce-connect-task-atlas-streams: diff --git a/source/includes/steps-starting-vsce-connect-with-atlas-cli.rst b/source/includes/steps-starting-vsce-connect-with-atlas-cli.rst index 7d500c33..629b51b0 100644 --- a/source/includes/steps-starting-vsce-connect-with-atlas-cli.rst +++ b/source/includes/steps-starting-vsce-connect-with-atlas-cli.rst @@ -1,4 +1,4 @@ -.. procedure:: +.. procedure:: :style: normal .. step:: Connect from the Atlas CLI. From 676a1edf0d137b9b6cc6dc736d998814e4a34190 Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Fri, 4 Apr 2025 15:50:27 -0400 Subject: [PATCH 12/12] render --- source/connect.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/connect.txt b/source/connect.txt index 95ce0b66..8620313d 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -111,7 +111,7 @@ Create a Connection local and Atlas deployments from MongoDB for VsCode. Before beginning, :atlascli:`install the Atlas CLI `. - .. include:: /includes/starting-vsce-connect-with-atlas-cli.rst + .. include:: /includes/steps-starting-vsce-connect-with-atlas-cli.rst .. _vsce-connect-task-atlas-streams: