diff --git a/source/connect.txt b/source/connect.txt index 2fdd23e..8620313 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -104,6 +104,14 @@ 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-open-mongodb-view.yaml b/source/includes/steps-open-mongodb-view.yaml index d49e883..7e9350a 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-advanced-connection-settings.yaml b/source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml index eecd226..0a26260 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.rst b/source/includes/steps-starting-vsce-connect-with-atlas-cli.rst new file mode 100644 index 0000000..629b51b --- /dev/null +++ b/source/includes/steps-starting-vsce-connect-with-atlas-cli.rst @@ -0,0 +1,37 @@ +.. procedure:: + :style: normal + + .. step:: Connect from the Atlas CLI. + + 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:: Run the connection command. + + Run ``atlas deployment connect`` in your terminal. + + .. code-block:: + + atlas deployment connect + + .. step:: Select your deployment. + + Select the deployment you wish to connect to from your list of deployments. + + .. step:: Select |vsce| as your connection method. + + 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. + + 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 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 dde823c..de094e9 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 ...