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.

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
merged 3 commits into from
Sep 15, 2023
Merged

(DOCSP-32271) Adds Atlas CTA to several Node.js pages #781

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98726b9
(DOCSP-32271) Adds Atlas CTA to several Node.js pages
Sep 15, 2023
9e6cb16
Removes via from page name
Sep 15, 2023
41cef14
Includes changes from copy review
Sep 15, 2023
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
11 changes: 11 additions & 0 deletions source/fundamentals/connection.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,17 @@ learn:
- :ref:`How to Enable SOCKS5 Proxy Support <node-connect-socks>`
- :atlas:`How to Connect to MongoDB Atlas from AWS Lambda </manage-connections-aws-lambda/>`

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+}

.. |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)


.. |atlas-url| replace:: :atlas:`Connect Your Application </driver-connection>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

For information about authenticating to MongoDB,
see :ref:`node-authentication-mechanisms` and
:ref:`node-enterprise-authentication-mechanisms`.
11 changes: 11 additions & 0 deletions source/fundamentals/crud.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,17 @@ Some operations combine aspects of read and write operations. See our
guide on :doc:`compound operations </fundamentals/crud/compound-operations>`
to learn more about these hybrid methods.

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

.. |page-topic| replace:: use CRUD operations
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: I don't think anyone would really be lost by "use" here, but I think of "use" as being something you do with a specific tool (use a hammer, use a driver, etc.) whereas a CRUD operation is more like a series of actions--something you perform or execute

Suggested change
.. |page-topic| replace:: use CRUD operations
.. |page-topic| replace:: perform 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


.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents </atlas-ui/documents>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

.. note::

If you are looking for additional resources for learning topics related
Expand Down
11 changes: 11 additions & 0 deletions source/fundamentals/crud/read-operations/retrieve.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,17 @@ matching data is inserted.

.. include:: /includes/access-cursor-note.rst

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

.. |page-topic| replace:: use read operations
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
.. |page-topic| replace:: use read operations
.. |page-topic| replace:: perform read operations

.. |link-topic-ing| replace:: using read 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.

I: "performing", plus remove standalone "using"

Suggested change
.. |link-topic-ing| replace:: using read operations in the Atlas UI
.. |link-topic-ing| replace:: performing 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?


.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

Find
----

Expand Down
4 changes: 4 additions & 0 deletions source/includes/fact-atlas-compatible.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

deployments hosted in the following environments:

.. include:: /includes/fact-environments.rst
2 changes: 2 additions & 0 deletions source/includes/fact-atlas-link.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
To learn more about |link-topic-ing| for deployments hosted in MongoDB
Atlas, see |atlas-url|.
7 changes: 7 additions & 0 deletions source/includes/fact-environments.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- `MongoDB Atlas
<https://www.mongodb.com/docs/atlas>`__: The fully
managed service for MongoDB deployments in the cloud
- :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

5 changes: 5 additions & 0 deletions source/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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:


.. include:: /includes/fact-environments.rst

Quick Start
-----------

Expand Down
11 changes: 11 additions & 0 deletions source/quick-reference.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@ Quick Reference
This page shows the driver syntax for several MongoDB commands and links to
their related reference and API documentation.

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

.. |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


.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents </atlas-ui/documents>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

.. list-table::
:header-rows: 1
:widths: 25 75
Expand Down
11 changes: 11 additions & 0 deletions source/usage-examples/find.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ documents using the ``for await...of`` syntax, or one of the following

If no documents match the query, ``find()`` returns an empty cursor.

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

.. |page-topic| replace:: use the ``find()`` method
.. |link-topic-ing| replace:: finding documents in the Atlas UI

.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents </atlas-ui/documents/#view--filter--and-sort-documents>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

Example
-------

Expand Down
11 changes: 11 additions & 0 deletions source/usage-examples/findOne.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,17 @@ in the ``options`` object passed as the second parameter of the
``findOne`` method. For detailed reference documentation, see
`collection.findOne() <{+api+}/classes/Collection.html#findOne>`__.

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

.. |page-topic| replace:: use the ``findOne()`` method
.. |link-topic-ing| replace:: finding documents in the Atlas UI

.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents </atlas-ui/documents/#view--filter--and-sort-documents>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

Example
-------

Expand Down
11 changes: 11 additions & 0 deletions source/usage-examples/insertOne.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,17 @@ If the operation successfully inserts a document, it appends an
``insertedId`` field to the object passed in the method call, and sets the
value of the field to the ``_id`` of the inserted document.

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

.. |page-topic| replace:: use the ``insertOne()`` method
.. |link-topic-ing| replace:: inserting documents in the Atlas UI

.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents </atlas-ui/documents/#insert-documents>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

Example
-------

Expand Down