Skip to content

(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

Merged
merged 3 commits into from
Sep 15, 2023

Conversation

sarahsimpers
Copy link
Contributor

@sarahsimpers sarahsimpers commented Sep 15, 2023

@sarahsimpers sarahsimpers force-pushed the DOCSP-32271 branch 2 times, most recently from dfc878a to 9240101 Compare September 15, 2023 13:06
Copy link
Collaborator

@mongoKart mongoKart left a 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
Copy link
Collaborator

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

Suggested change
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
Comment on lines 35 to 36
You can connect using the Node.js driver for
deployments hosted in the following environments:
Copy link
Collaborator

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:

Suggested change
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
Copy link
Collaborator

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'

Suggested change
You can connect using the Node.js driver for
You can connect using the {+driver-short+} for

-------------

.. |page-topic| replace:: use the following driver syntax
.. |link-topic-ing| replace:: using common CRUD operations in the Atlas UI
Copy link
Collaborator

Choose a reason for hiding this comment

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

S:

Suggested change
.. |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
Copy link
Collaborator

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:

Suggested change
You can connect using the Node.js driver and |page-topic| for
You can use the {+driver-short+} to connect and |page-topic| for

-------------

.. |page-topic| replace:: use CRUD operations
.. |link-topic-ing| replace:: using CRUD operations in the Atlas UI
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
.. |link-topic-ing| replace:: using CRUD operations in the Atlas UI
.. |link-topic-ing| replace:: performing CRUD operations in the Atlas UI

Compatibility
-------------

.. |page-topic| replace:: use the Node.js driver
Copy link
Collaborator

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"

Suggested change
.. |page-topic| replace:: use the Node.js driver
.. |page-topic| replace:: use the {+driver-short+}

-------------

.. |page-topic| replace:: use the Node.js driver
.. |link-topic-ing| replace:: connecting using drivers
Copy link
Collaborator

Choose a reason for hiding this comment

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

I: standalone "using"

S:

Suggested change
.. |link-topic-ing| replace:: connecting using drivers
.. |link-topic-ing| replace:: using drivers to connect

(still standalone, but unambiguous here imo)

Compatibility
-------------

.. |page-topic| replace:: use the following driver syntax
Copy link
Collaborator

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:

Suggested change
.. |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>`
Copy link
Collaborator

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?

Copy link
Collaborator

@mongoKart mongoKart left a comment

Choose a reason for hiding this comment

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

LGTM!

@mongoKart mongoKart merged commit 6b2f49f into mongodb:master Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
sarahsimpers added a commit to sarahsimpers/docs-node that referenced this pull request Sep 15, 2023
mongoKart pushed a commit to mongoKart/docs-node that referenced this pull request Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants