-
Notifications
You must be signed in to change notification settings - Fork 301
(DOCSP-32292) Adds mention of Atlas to drivers landing page #909
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
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 this contribution! I think it meets your goal of being unobtrusive. There are a few style guide issues that I think could make this more aligned with how we want to present info to our readers.
source/index.txt
Outdated
@@ -9,8 +9,10 @@ Start Developing with MongoDB | |||
.. meta:: | |||
:keywords: r, elixir, prisma, mongoose | |||
|
|||
Connect your application to your database with one of the official MongoDB | |||
libraries. | |||
Connect your application to your `MongoDB Atlas database |
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.
Suggestion:
Similar to your comment in a recent Node.js driver PR, I think "deployment" would be a more suitable term to use than "database".
source/index.txt
Outdated
Connect your application to your `MongoDB Atlas database | ||
<https://www.mongodb.com/docs/atlas>`__ or `self-hosted MongoDB | ||
database <https://www.mongodb.com/docs/manual/installation>`__ with |
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.
Issue:
From Links and Cross-References in the style guide:
Strive to be clear about where exactly a link will take a reader.
and
To minimize reader disruption, aim to keep users on the page they're currently reading as much as possible.
From Terminology:
using ... Use by using, or recast the sentence. Don't use using (alone) or with.
Suggestion:
I think something like the following could address all the aforementioned issues:
"You can connect your application to your MongoDB Atlas deployment or a self-hosted MongoDB cluster by using one of the official MongoDB libraries. To learn more about Atlas, see :atlas:What is MongoDB Atlas? </>
. To learn how to download and install MongoDB, see :manual:Install MongoDB </installation>
."
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.
Thank you! I made this change with one small difference (specify that the install page is for self-hosted)
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! Thanks for contributing!
Pull Request Info
Adds mention of Atlas to the top of the drivers landing page as part of the Atlas-centric Top 250 initiative.
Build: https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=650af8c2492df295cf198d7a
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-32292?filter=46607
Staging - https://preview-mongodbsarahsimpers.gatsbyjs.io/drivers/DOCSP-32292/
Self-Review Checklist