-
Notifications
You must be signed in to change notification settings - Fork 52
(DOCSP-32271) Adds Atlas CTA to several Node.js pages #781
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
dfc878a
to
9240101
Compare
9240101
to
98726b9
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.
I = Issue
S = Suggestion
Q = Question
- :ref:`MongoDB Enterprise <install-mdb-enterprise>`: The | ||
subscription-based, self-managed version of MongoDB | ||
- :ref:`MongoDB Community <install-mdb-community-edition>`: The | ||
source available, free-to-use, and self-managed version of MongoDB |
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: "source available" is a compound modifier and should be hyphenated
source available, free-to-use, and self-managed version of MongoDB | |
source-available, free-to-use, and self-managed version of MongoDB |
source/index.txt
Outdated
You can connect using the Node.js driver for | ||
deployments hosted in the following environments: |
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: I don't love that the Style Guide makes this an absolute, but it prohibits standalone "using". I think something like this is clearer, too:
You can connect using the Node.js driver for | |
deployments hosted in the following environments: | |
You can use the Node.js driver to connect to | |
deployments hosted in the following environments: |
source/index.txt
Outdated
@@ -32,6 +32,11 @@ installing the {+driver-short+}, see | |||
:ref:`Download and Install <node-quick-start-download-and-install>` in the | |||
Quick Start guide. | |||
|
|||
You can connect using the Node.js driver for |
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.
S: We have a source constant for "Node.js driver'
You can connect using the Node.js driver for | |
You can connect using the {+driver-short+} for |
source/quick-reference.txt
Outdated
------------- | ||
|
||
.. |page-topic| replace:: use the following driver syntax | ||
.. |link-topic-ing| replace:: using common CRUD operations in the Atlas UI |
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.
S:
.. |link-topic-ing| replace:: using common CRUD operations in the Atlas UI | |
.. |link-topic-ing| replace:: performing common CRUD operations in the Atlas UI |
@@ -0,0 +1,4 @@ | |||
You can connect using the Node.js driver and |page-topic| for |
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: To avoid "using" and also make this a little clearer, I'd go with something like this:
You can connect using the Node.js driver and |page-topic| for | |
You can use the {+driver-short+} to connect and |page-topic| for |
source/fundamentals/crud.txt
Outdated
------------- | ||
|
||
.. |page-topic| replace:: use CRUD operations | ||
.. |link-topic-ing| replace:: using CRUD operations in the Atlas UI |
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.
.. |link-topic-ing| replace:: using CRUD operations in the Atlas UI | |
.. |link-topic-ing| replace:: performing CRUD operations in the Atlas UI |
source/fundamentals/connection.txt
Outdated
Compatibility | ||
------------- | ||
|
||
.. |page-topic| replace:: use the Node.js driver |
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.
S: snooty constant for "Node.js driver"
.. |page-topic| replace:: use the Node.js driver | |
.. |page-topic| replace:: use the {+driver-short+} |
source/fundamentals/connection.txt
Outdated
------------- | ||
|
||
.. |page-topic| replace:: use the Node.js driver | ||
.. |link-topic-ing| replace:: connecting using drivers |
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: standalone "using"
S:
.. |link-topic-ing| replace:: connecting using drivers | |
.. |link-topic-ing| replace:: using drivers to connect |
(still standalone, but unambiguous here imo)
source/quick-reference.txt
Outdated
Compatibility | ||
------------- | ||
|
||
.. |page-topic| replace:: use the following driver syntax |
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: This page-topic makes the final sentence a little awkward, especially if you accept my suggestion in an earlier comment:
"You can use the Node.js driver to connect and [use the following driver syntax] for deployments hosted in the following environments:"
S:
.. |page-topic| replace:: use the following driver syntax | |
.. |page-topic| replace:: execute commands |
^^^ This is how the page intro describes the content of the page
.. |page-topic| replace:: use read operations | ||
.. |link-topic-ing| replace:: using read operations in the Atlas UI | ||
|
||
.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents </atlas-ui/documents/#view--filter--and-sort-documents>` |
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.
Q: Do you think it makes sense to use a different link title since this goes to the middle of the page?
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!
Pull Request Info
PR Reviewing Guidelines
JIRA Tickets
https://jira.mongodb.org/browse/DOCSP-32271
https://jira.mongodb.org/browse/DOCSP-32273
https://jira.mongodb.org/browse/DOCSP-32274
https://jira.mongodb.org/browse/DOCSP-32275
https://jira.mongodb.org/browse/DOCSP-32294
https://jira.mongodb.org/browse/DOCSP-32306
https://jira.mongodb.org/browse/DOCSP-32305
https://jira.mongodb.org/browse/DOCSP-32307
Staging
https://preview-mongodbsarahsimpers.gatsbyjs.io/node/DOCSP-32271/
https://preview-mongodbsarahsimpers.gatsbyjs.io/node/DOCSP-32271/fundamentals/connection/
https://preview-mongodbsarahsimpers.gatsbyjs.io/node/DOCSP-32271/fundamentals/crud/
https://preview-mongodbsarahsimpers.gatsbyjs.io/node/DOCSP-32271/fundamentals/crud/read-operations/retrieve/
https://preview-mongodbsarahsimpers.gatsbyjs.io/node/DOCSP-32271/quick-reference/
https://preview-mongodbsarahsimpers.gatsbyjs.io/node/DOCSP-32271/usage-examples/findOne/
https://preview-mongodbsarahsimpers.gatsbyjs.io/node/DOCSP-32271/usage-examples/find/
https://preview-mongodbsarahsimpers.gatsbyjs.io/node/DOCSP-32271/usage-examples/insertOne/
Build
https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=65046d9724fcc731b473939c
Self-Review Checklist