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-32272): Atlas Top 250: Add Atlas to intro, provide Atlas-focused connection string #806

Merged
merged 3 commits into from
Sep 20, 2023

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Sep 19, 2023

Pull Request Info

Note for reviewer: the rST has several build errors related to the facet directive, similar to:

ERROR(usage-examples.txt:8ish): Error in "facet" directive: unknown option: "type".

Those errors are outside the scope of this PR. This PR's changes are free of warnings or errors in the rST.

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-32272
Staging - Connection Guide

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?

@dacharyc dacharyc changed the title (DOCSP-32272): Add Atlas to intro, provide Atlas-focused connection string (DOCSP-32272): Atlas Top 250: Add Atlas to intro, provide Atlas-focused connection string Sep 19, 2023
Copy link
Contributor

@sarahsimpers sarahsimpers left a comment

Choose a reason for hiding this comment

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

A couple of small suggestions, thank you!

source/fundamentals/connection/connect.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/connect.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/connect.txt Outdated Show resolved Hide resolved
Copy link
Contributor

@ccho-mongodb ccho-mongodb left a comment

Choose a reason for hiding this comment

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

LGTM! I left a few suggestions that I think could help the consistency of the page.

@@ -17,8 +17,8 @@ Connection Guide
:depth: 2
:class: singlecol

This guide shows you how to connect to a MongoDB instance or replica set
using the Node.js driver.
This guide shows you how to connect to a MongoDB Atlas instance,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion:

I think the terminology Atlas uses is "cluster" (see https://www.mongodb.com/docs/atlas/manage-clusters/)

Suggested change
This guide shows you how to connect to a MongoDB Atlas instance,
This guide shows you how to connect to a MongoDB Atlas cluster,

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion:

I think the terminology Atlas uses is "cluster" (see https://www.mongodb.com/docs/atlas/manage-clusters/)

The term "cluster" actually doesn't include serverless instances, which can also connect via Node driver. If we want to use a term other than "instance," we could use "database deployment" or "deployment" as those are usually used in the Atlas docs to encompass both clusters and serverless

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll go with "deployment" here to encompass both cases. Thank you both for the suggestions/info!

source/fundamentals/connection/connect.txt Outdated Show resolved Hide resolved
the :manual:`Standard Connection String Format </reference/connection-string/#std-label-connections-standard-connection-string-format>`.

If your instance or deployment has a DNS SRV record, you can use the
In this example, we connect to an Atlas MongoDB deployment that has a
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion:
I think "Atlas cluster" would be most recognizable given the prior suggestions.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Given the info that Sarah provided above, I think "deployment" covers both clusters and serverless, so I'll stick with that here unless there's a strong preference for something else.

source/fundamentals/connection/connect.txt Outdated Show resolved Hide resolved
Copy link
Contributor

@sarahsimpers sarahsimpers left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

@dacharyc dacharyc merged commit 00e5cce into mongodb:master Sep 20, 2023
2 checks passed
@dacharyc dacharyc deleted the DOCSP-32272 branch September 20, 2023 21:28
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
ccho-mongodb pushed a commit that referenced this pull request Sep 20, 2023
…ed connection string (#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage

(cherry picked from commit 00e5cce)
(cherry picked from commit c013393)
(cherry picked from commit fc7be53)
(cherry picked from commit 2714809)
mongoKart pushed a commit to mongoKart/docs-node that referenced this pull request Nov 3, 2023
…ed connection string (mongodb#806)

* Add Atlas to intro, provide Atlas-focused connection string

* Incorporate review feedback

* Correct errors in facet usage
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.

4 participants