Skip to content
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

DOCSP-48592-point-users-to-local-atlas-experience #109

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

amalhotra-mdb
Copy link
Contributor

@amalhotra-mdb amalhotra-mdb commented Apr 2, 2025

DESCRIPTION

Add option for using the Local Atlas Experience when connecting to MongoDB VS Code.

STAGING

https://deploy-preview-109--docs-mongodb-vscode.netlify.app/connect/#connect-to-your-mongodb-deployment

JIRA

https://jira.mongodb.org/browse/DOCSP-48952

BUILD LOG

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Is this free of spelling errors?
  • Is this free of grammatical errors?
  • Is this free of staging / rendering issues?
  • Are all the links working?

External Review Requirements

What's expected of an external reviewer?

Copy link

netlify bot commented Apr 2, 2025

Deploy Preview for docs-mongodb-vscode ready!

Name Link
🔨 Latest commit c293d65
🔍 Latest deploy log https://app.netlify.com/sites/docs-mongodb-vscode/deploys/67f51ebba5eea80008fa4c3e
😎 Deploy Preview https://deploy-preview-109--docs-mongodb-vscode.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 22 (🔴 down 22 from production)
Accessibility: 91 (no change from production)
Best Practices: 75 (no change from production)
SEO: 75 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@ltran-mdb2 ltran-mdb2 left a comment

Choose a reason for hiding this comment

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

Thanks for picking this up @amalhotra-mdb ! I left a couple small suggestions for your consideration!

Comment on lines 34 to 35
If you are a developer, consider using the Local Atlas Experience to build
MongoDB Atlas deployments locally. Use the :atlascli:`Atlas CLI </>`
Copy link
Collaborator

Choose a reason for hiding this comment

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

[suggestion] for minimalism

Suggested change
If you are a developer, consider using the Local Atlas Experience to build
MongoDB Atlas deployments locally. Use the :atlascli:`Atlas CLI </>`
You can also use the Local Atlas Experience to build
MongoDB Atlas deployments locally. Use the :atlascli:`Atlas CLI </>`

@@ -31,6 +31,12 @@ or sharded cluster host.
To create an |service| cluster using a Terraform template included
with |vsce|, see :ref:`vsce-create-cluster-terraform`.

If you are a developer, consider using the Local Atlas Experience to build
MongoDB Atlas deployments locally. Use the :atlascli:`Atlas CLI </>`
to set up and connect to local deployments with MongoDB for VS Code
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just in the off chance that the product name changes, I would recommend using the constant here

Suggested change
to set up and connect to local deployments with MongoDB for VS Code
to set up and connect to local deployments with |vsce|

Comment on lines 37 to 38
directly from your command line. To create a Local Atlas deployment,
see :atlascli:`Manage Local and Cloud Deployments from the Atlas CLI </atlas-cli-local-cloud>`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

[suggestion] for minimalism

Suggested change
directly from your command line. To create a Local Atlas deployment,
see :atlascli:`Manage Local and Cloud Deployments from the Atlas CLI </atlas-cli-local-cloud>`.
directly from your command line. For more information,,
see :atlascli:`Manage Local and Cloud Deployments from the Atlas CLI </atlas-cli-local-cloud>`.

@amalhotra-mdb
Copy link
Contributor Author

Thanks for your help on this @ltran-mdb2 , back to you!

@amalhotra-mdb amalhotra-mdb requested a review from ltran-mdb2 April 3, 2025 18:09
Copy link
Collaborator

@ltran-mdb2 ltran-mdb2 left a comment

Choose a reason for hiding this comment

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

LGTM!

@@ -31,6 +31,12 @@ or sharded cluster host.
To create an |service| cluster using a Terraform template included
with |vsce|, see :ref:`vsce-create-cluster-terraform`.

You can also use the Local Atlas Experience to build
Copy link

Choose a reason for hiding this comment

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

Could we also note that this feature is available for versions 1.13.0+ of MongoDB for VsCode.

This version is in the process of releasing and corresponding version of AtlasCLI release will precede it. Are we able to hold on the publication of this update until then?

@amalhotra-mdb amalhotra-mdb requested a review from cveticm April 4, 2025 19:53
@amalhotra-mdb
Copy link
Contributor Author

Thanks for your review, @cveticm ! Could you take another look at the changes, whenever you get a chance?

Comment on lines 34 to 39
Starting in version 1.13.0 of |vsce|, you can also use the Local Atlas Experience
to build MongoDB Atlas deployments locally. Use the :atlascli:`Atlas CLI </>`
to set up and connect to local deployments with |vsce| directly from your
command line. For more information, see
:atlascli:`Manage Local and Cloud Deployments from the Atlas CLI </atlas-cli-local-cloud>`.

Copy link

Choose a reason for hiding this comment

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

Just a note on versions: users can create Local Atlas deployments and connect using the resulting connection string irregardless of vsce version.
For functionality to connect directly from command line, atlasCLI v1.42.0+ and vsce v1.13.0+ are required.

Suggested change
Starting in version 1.13.0 of |vsce|, you can also use the Local Atlas Experience
to build MongoDB Atlas deployments locally. Use the :atlascli:`Atlas CLI </>`
to set up and connect to local deployments with |vsce| directly from your
command line. For more information, see
:atlascli:`Manage Local and Cloud Deployments from the Atlas CLI </atlas-cli-local-cloud>`.
You can also use the Local Atlas Experience
to build MongoDB Atlas deployments locally. Use the :atlascli:`Atlas CLI </>`
to set up local deployments. For more information, see
:atlascli:`Manage Local and Cloud Deployments from the Atlas CLI </atlas-cli-local-cloud>`.
Starting in version 1.42.0 of the :atlascli:`Atlas CLI </>` and version 1.13.0 of |vsce|, you can connect directly to your local deployments from your
command line.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants