Skip to content

DOCSP-48590-connect-via-atlas-cli #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
details
  • Loading branch information
amalhotra-mdb committed Apr 3, 2025
commit fac1f1e9bcd95ddd2d806dcb7c0a692e247e3dcd
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down Expand Up @@ -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: |
Expand All @@ -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: |

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -554,5 +554,5 @@ content: |
---
ref: vsce-click-connect
level: 4
title: "Click :guilabel:`Connect`"
title: Click :guilabel:`Connect`.
...
30 changes: 27 additions & 3 deletions source/includes/steps-starting-vsce-connect-with-atlas-cli.yaml
Original file line number Diff line number Diff line change
@@ -1,19 +1,43 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that this is a new content, I recommend using .. procedure:: and .. step:: directives in this procedure.

Spitballing:

.. procedure::
   :style: normal

   .. step:: Connect from the Atlas CLI. 
   
       In your terminal, run ...

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+} </connect-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.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ content: |
:manual:`Connection String URI Format
</reference/connection-string>`.
---
title: "Open the |vscode-short| Command Palette."
title: Open the |vscode-short| Command Palette.
level: 4
ref: vsce-open-overview-page
content: |
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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: |
Expand All @@ -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
...
Loading