Skip to content

(DOCSP-32272): Atlas Top 250: Add Atlas to intro, provide Atlas-focused connection string #806

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.

Sign up for GitHub

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 3 commits into from
Sep 20, 2023
Merged

(DOCSP-32272): Atlas Top 250: Add Atlas to intro, provide Atlas-focused connection string #806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d85ae98
Add Atlas to intro, provide Atlas-focused connection string
dacharyc Sep 19, 2023
36643b7
Incorporate review feedback
dacharyc Sep 19, 2023
1a8f0f4
Correct errors in facet usage
dacharyc Sep 20, 2023
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
2 changes: 1 addition & 1 deletion source/compatibility.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Compatibility
=============

.. facet::
:type: genre
:name: genre
:values: reference

.. meta::
Expand Down
2 changes: 1 addition & 1 deletion source/fundamentals/connection.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Connection
.. default-domain:: mongodb

.. facet::
:type: genre
:name: genre
:values: reference

.. meta::
Expand Down
29 changes: 16 additions & 13 deletions source/fundamentals/connection/connect.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Connection Guide
================

.. facet::
:type: genre
:name: genre
:values: reference

.. meta::
Expand All @@ -17,8 +17,9 @@ 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 deployment <https://www.mongodb.com/docs/atlas>`__,
a MongoDB instance, or a replica set using the Node.js driver.

.. _node-connection-uri:

Expand All @@ -30,25 +31,27 @@ connect to a MongoDB deployment. It instructs the driver on how it should
connect to MongoDB and how it should behave while connected. The following
example shows each part of the connection URI:

.. figure:: /includes/figures/connection-string-parts.png
.. figure:: /includes/figures/dns_seedlist_connection_string_parts.png
:alt: Each part of the connection string

In this example, we use ``mongodb`` for the protocol, which specifies
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.

DNS SRV record. For more details, see the
:manual:`DNS Seed List Connection Format
</reference/connection-string/#dns-seed-list-connection-format>` for
your connection string. This format offers more flexibility of
deployment and the ability to change the servers in rotation without
reconfiguring clients.
</reference/connection-string/#dns-seed-list-connection-format>`
documentation. This format offers flexibility in deployment and the
ability to change the servers in rotation without reconfiguring clients.

.. note::

To learn how to retrieve your connection string in Atlas, see the
:atlas:`Atlas driver connection guide </driver-connection>`.

The next part of the connection string contains your credentials
If you are connecting to an instance or replica set that does not have a
DNS SRV address, you must use ``mongodb`` for the protocol, which specifies
the :manual:`Standard Connection String Format
</reference/connection-string/#std-label-connections-standard-connection-string-format>`.

After the protocol, the next part of the connection string contains credentials
if you are using password-based authentication. Replace the value of ``user``
with your username and ``pass`` with your password. If you are using an
authentication mechanism that does not require a username and password, omit
Expand Down
2 changes: 1 addition & 1 deletion source/fundamentals/crud.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ CRUD Operations
.. default-domain:: mongodb

.. facet::
:type: genre
:name: genre
:values: reference

.. meta::
Expand Down
2 changes: 1 addition & 1 deletion source/fundamentals/crud/read-operations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Read Operations
.. default-domain:: mongodb

.. facet::
:type: genre
:name: genre
:values: reference

.. meta::
Expand Down
Binary file removed source/includes/figures/connection-string-parts.png
View file
Open in desktop
Binary file not shown.
Binary file added source/includes/figures/dns_seedlist_connection_string_parts.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion source/quick-reference.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Quick Reference
.. default-domain:: mongodb

.. facet::
:type: genre
:name: genre
:values: reference

.. meta::
Expand Down
2 changes: 1 addition & 1 deletion source/quick-start.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Quick Start
===========

.. facet::
:type: genre
:name: genre
:values: tutorial

.. meta::
Expand Down
2 changes: 1 addition & 1 deletion source/usage-examples.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage Examples
.. default-domain:: mongodb

.. facet::
:type: genre
:name: genre
:values: reference

.. meta::
Expand Down
2 changes: 1 addition & 1 deletion source/usage-examples/find.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Find Multiple Documents
.. default-domain:: mongodb

.. facet::
:type: genre
:name: genre
:values: reference

.. meta::
Expand Down
2 changes: 1 addition & 1 deletion source/usage-examples/findOne.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Find a Document
.. default-domain:: mongodb

.. facet::
:type: genre
:name: genre
:values: tutorial

.. meta::
Expand Down
2 changes: 1 addition & 1 deletion source/usage-examples/insertOne.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Insert a Document
.. default-domain:: mongodb

.. facet::
:type: genre
:name: genre
:values: tutorial

.. meta::
Expand Down