Skip to content

(DOCSP-17931): Added Atlas connection string note. #5755

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
jeff-allen-mongo merged 4 commits into from
Aug 30, 2021
Merged

(DOCSP-17931): Added Atlas connection string note. #5755

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
03343f5
(DOCSP-17931): Added Atlas connection string note.
corryroot Aug 26, 2021
99a7567
(DOCSP-17931): Incorporated Jeff's feedback.
corryroot Aug 26, 2021
2b59589
(DOCSP-17931): Incorporated Jeff's feedback.
corryroot Aug 26, 2021
dd9cc86
(DOCSP-17931): Incorporated JD's feedback.
corryroot Aug 26, 2021
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
17 changes: 17 additions & 0 deletions source/reference/connection-string.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,23 @@ Examples

.. include:: /includes/fact-pct-encode-uri.rst

- id: atlas
name: Atlas Deployment
content: |

.. note::
Copy link
Collaborator

@jeff-allen-mongo jeff-allen-mongo Aug 26, 2021

Choose a reason for hiding this comment

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

My suggestion would be to not make this a note and just have it be regular in-line copy. That might help this flow a bit more naturally.


The MongoDB Atlas UI provides the connection strings for
you when you :atlas:`connect to a database deployment
Copy link
Collaborator

@jeff-allen-mongo jeff-allen-mongo Aug 26, 2021

Choose a reason for hiding this comment

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

Saying Atlas provides the connection strings when I connect to a database deployment is a little confusing to me. Don't I need the connection string to connect to the deployment? Maybe we can say something like:

MongoDB Atlas provides connection strings for your deployment when you click the
:atlas:`Connect </connect-to-database-deployment/>` button in the Atlas UI.

Feel free to tweak this.

</connect-to-database-deployment/>`. To register a new
Atlas account, start at the
:mdbacct:`MongoDB Atlas registration page
</register?tck=docs_atlas>`.

.. code-block:: bash
Copy link
Collaborator

@jeff-allen-mongo jeff-allen-mongo Aug 26, 2021

Choose a reason for hiding this comment

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

Suggest providing a little context for this code-block. Maybe we can precede it with something like:

"Your Atlas connection string may resemble the following: "


mongosh "mongodb+srv://cluster0.example.mongodb.net myFirstDatabase" --username JohnDoe

For more examples, see :ref:`connections-connection-examples`.

Components
Expand Down