-
Notifications
You must be signed in to change notification settings - Fork 1.7k
(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.
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
Conversation
Hey @corryroot , so I think the direction we want to go with this ticket is make this less like an Atlas CTA and instead more naturally integrate Atlas-specific content into the page. My suggestion would be to add a fourth tab in the Examples section of the page for Atlas, where we maybe show a sample connection string and how to find it in Atlas. |
d0ec7fa
to
3b36287
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the updates @corryroot. Just have a couple more thoughts on language / formatting.
name: Atlas Deployment | ||
content: | | ||
|
||
.. note:: |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
:mdbacct:`MongoDB Atlas registration page | ||
</register?tck=docs_atlas>`. | ||
|
||
.. code-block:: bash |
There was a problem hiding this comment.
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: "
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two minor things.
Cheers,
Jon
</connect-to-database-deployment/>` button in the Atlas UI. | ||
To register a new Atlas account, start at the | ||
:mdbacct:`MongoDB Atlas registration page | ||
</register?tck=docs_atlas>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is in the manual, can we use docs_server
?
</register?tck=docs_atlas>`. | |
</register?tck=docs_server>`. |
</connect-to-database-deployment/>` button in the Atlas UI. | ||
To register a new Atlas account, start at the | ||
:mdbacct:`MongoDB Atlas registration page | ||
</register?tck=docs_atlas>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we also add a link to the "Getting Started with Atlas" tutorial? I'm not sure if it makes sense to plug that immediately after the registration link or after this blurb.
Thoughts @jeff-allen-mongo ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think Corry's addition here after the registration blurb works.
* (DOCSP-17931): Added Atlas connection string note. * (DOCSP-17931): Incorporated Jeff's feedback. * (DOCSP-17931): Incorporated Jeff's feedback. * (DOCSP-17931): Incorporated JD's feedback.
* (DOCSP-17931): Added Atlas connection string note. * (DOCSP-17931): Incorporated Jeff's feedback. * (DOCSP-17931): Incorporated Jeff's feedback. * (DOCSP-17931): Incorporated JD's feedback.
@jdestefano-mongo, I added details to the following page about the Atlas UI providing the connection strings.
STAGE
JIRA
BUILD