DOCSP-23560: quickstart fixes (#347)

* DOCSP-23560: quickstart fixes

Author: Chris Cho

source/fundamentals/crud.txt

@@ -1,3 +1,5 @@
+.. _node-crud-landing:
+
 ===============
 CRUD Operations
 ===============

source/quick-start.txt

@@ -13,31 +13,31 @@ Quick Start
    :class: singlecol
 
 This guide shows you how to create an application that uses the
-**Node.js driver** to connect to a **MongoDB Atlas cluster**. If you
-prefer to connect to MongoDB using a different driver or programming
+{+driver-long+} to connect to a MongoDB cluster hosted on MongoDB Atlas. If
+you prefer to connect to MongoDB using a different driver or programming
 language, see our :driver:`list of official drivers <>`.
 
-The Node.js driver is an interface through which you can connect to and
-communicate with MongoDB instances.
+The {+driver-short+} is a library you can use to connect to and communicate
+with MongoDB.
 
-MongoDB Atlas is a fully-managed cloud database service that hosts your data
-on MongoDB instances. We show you how to get started with your own free (no
-credit card required) instance in this guide.
+MongoDB Atlas is a fully managed cloud database service that hosts your
+MongoDB servers. You can get started with your own free (no credit card
+required) MongoDB instance with this guide.
 
-Follow the steps below to connect your Node.js application with a MongoDB
-instance.
+Follow the steps below to connect a sample Node.js application to a MongoDB
+instance on MongoDB Atlas.
 
 Set up Your Project
 -------------------
 
 Install Node and npm
 ~~~~~~~~~~~~~~~~~~~~
 
-Ensure your system has Node.js version 12 or later and a compatible
-version of npm (Node Package Manager) installed. For information on how
-to check your version of Node and npm, as well as installation
-instructions, see `downloading and installing Node.js and npm
-<https://docs.npmjs.com/downloading-and-installing-node-js-and-npm>`_.
+Ensure you have Node.js v12 or later and npm (Node Package Manager) installed
+in your development environment.
+
+For information on how to install Node.js and npm, see
+`downloading and installing Node.js and npm <https://docs.npmjs.com/downloading-and-installing-node-js-and-npm>`__.
 
 Select the :guilabel:`Clone the Project` tab if you want to build your
 project from a premade dependency file or the :guilabel:`Create the Project`
@@ -48,9 +48,9 @@ tab if you want to create the project dependency file yourself.
    .. tab:: Clone the Project
       :tabid: clone the project
 
-      First, ensure you have Git installed in your development
-      environment or otherwise install it using `Git's Getting Started Guide
-      <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`__.
+      Ensure you have git installed in your development environment.
+
+      For information on how to install git, see `Git - Getting Started Guide <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`__.
 
       Then, from your shell, clone the `js-starter repository
       <https://github.com/mongodb-university/js-starter>`__:
@@ -65,7 +65,7 @@ tab if you want to create the project dependency file yourself.
 
          cd js-starter
 
-      Then, install the Node.js driver:
+      Then, install the {+driver-short+}:
 
       .. code-block:: bash
 
@@ -106,7 +106,7 @@ tab if you want to create the project dependency file yourself.
          default values for your project settings. If you want to
          interactively select your project settings, omit the ``-y`` flag.
 
-      Then, install the Node.js driver:
+      Then, install the {+driver-short+}:
 
       .. code-block:: bash
 
@@ -118,138 +118,128 @@ tab if you want to create the project dependency file yourself.
       - Saves the package in the ``node_modules`` directory
       - Records the dependency information in the ``package.json`` file
 
-At this point, you are ready to use the MongoDB Node.js driver with your
+At this point, you are ready to use the {+driver-short+} with your
 application.
 
-Create a MongoDB Cluster
-------------------------
+.. procedure::
+   :style: connected
 
-Set up a Free Tier Cluster in Atlas
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+   .. step:: Create a Free Tier Cluster in Atlas
 
-After installing the MongoDB Node.js driver, create a MongoDB instance to store
-and manage your data. Complete the
-:atlas:`Get Started with Atlas </getting-started?tck=docs_driver_nodejs>` guide
-to set up a new Atlas account, a free cluster (MongoDB instance), and load
-sample data into your cluster.
+      Create a free tier MongoDB cluster on MongoDB Atlas to store and manage
+      your data. MongoDB Atlas hosts and manages your MongoDB database in the
+      cloud. Complete the :atlas:`Get Started with Atlas </getting-started?tck=docs_driver_nodejs>`
+      guide to set up a new Atlas account, a free tier cluster (a shared
+      MongoDB instance) and load sample data into your cluster.
 
-After completing the steps in the Atlas guide, you should have a new MongoDB
-cluster deployed in Atlas, a database user with access to the cluster, and 
-sample datasets loaded into the cluster.
+   .. step:: Connect to your Cluster
 
-Connect to your Cluster
------------------------
+      You can connect to your MongoDB cluster by providing a
+      **connection string** which instructs the driver on where and how to
+      connect. The connection string includes information on the hostname
+      or IP address and port of your cluster, the authentication mechanism,
+      user credentials when applicable, and other connection options.
 
-In this step, we create and run an application that uses the MongoDB Node.js
-driver to connect to your instance of MongoDB and run a query on the sample
-data.
+      To connect to an instance or cluster not hosted on Atlas, see
+      :ref:`Other Ways to Connect to MongoDB <node-other-ways-to-connect>`.
 
-We pass instructions to the driver on where and how to connect to your
-MongoDB instance in a string called the *connection string*. This string
-includes information on the hostname or IP address and port of your
-instance, authentication mechanism, user credentials when applicable, and
-other connection options.
+      To retrieve your connection string for the cluster you created in
+      the previous step, log into your Atlas account and navigate to the
+      :guilabel:`Database` section and click the :guilabel:`Connect` button
+      for the cluster that you want to connect to as shown below.
 
-If you are connecting to an instance or cluster that is not hosted by Atlas,
-see :ref:`Other Ways to Connect to MongoDB <node-other-ways-to-connect>` for
-instructions on how to format your connection string.
+      .. figure:: /includes/figures/atlas_connection_select_cluster.png
+         :alt: The connect button in the clusters section of the Atlas UI
 
-To retrieve your connection string for the instance and user you created in
-the previous step, log into your Atlas account and navigate to the
-:guilabel:`Database` section and click the :guilabel:`Connect` button for the cluster that you
-want to connect to as shown below.
+      Proceed to the :guilabel:`Connect Your Application` section and select
+      the {+driver-short+}. Select the :guilabel:`Connection String Only` tab
+      and click the :guilabel:`Copy` button to copy the connection string to
+      your clipboard as shown below.
 
-.. figure:: /includes/figures/atlas_connection_select_cluster.png
-   :alt: The connect button in the clusters section of the Atlas UI
+      .. figure:: /includes/figures/atlas_connection_copy_string_node.png
+         :alt: The connection string copy button in the Connection String Only tab of the Atlas UI
 
-Proceed to the :guilabel:`Connect Your Application` step and select the Node.js
-driver. Select the :guilabel:`Connection String Only` tab and click the
-:guilabel:`Copy` button to copy the *connection string* to your clipboard
-as shown below.
+      Save your connection string to a safe location.
 
-.. figure:: /includes/figures/atlas_connection_copy_string_node.png
-   :alt: The connection string copy button in the Connection String Only tab of the Atlas UI
+   .. step:: Create your Node.js Application
 
-Save your connection string to a safe location that you can access in the
-next step.
+      Create a file to contain your application called ``index.js`` in your
+      project directory. Add the following code, assigning the ``uri``
+      variable the value of your connection string.
 
-Next, create a file to contain your application called ``index.js`` in your
-``node_quickstart`` directory. Add the following code, replacing the ``uri``
-variable with your connection string. Make sure to replace the "<password>"
-section of the connection string with the password you created for your user
-that has **atlasAdmin** permissions.
 
-.. tip::
+      .. code-block:: js
 
-   The line of code assigning the ``MongoClient`` variable uses
-   :mdn:`Object destructuring <Web/JavaScript/Reference/Operators/Destructuring_assignment#object_destructuring>`,
-   introduced to Node in v6. If you are using an older version of Node,
-   use the following to declare ``MongoClient``.
+        const { MongoClient } = require("mongodb");
 
-   .. code-block:: js
+        // Replace the uri string with your connection string.
+        const uri =
+          "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&writeConcern=majority";
 
-      const MongoClient = require("mongodb").MongoClient;
+        const client = new MongoClient(uri);
 
-.. code-block:: js
+        async function run() {
+          try {
+            const database = client.db('sample_mflix');
+            const movies = database.collection('movies');
 
-  const { MongoClient } = require("mongodb");
+            // Query for a movie that has the title 'Back to the Future'
+            const query = { title: 'Back to the Future' };
+            const movie = await movies.findOne(query);
 
-  // Replace the uri string with your MongoDB deployment's connection string.
-  const uri =
-    "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&writeConcern=majority";
+            console.log(movie);
+          } finally {
+            // Ensures that the client will close when you finish/error
+            await client.close();
+          }
+        }
+        run().catch(console.dir);
 
-  const client = new MongoClient(uri);
+      .. tip::
 
-  async function run() {
-    try {
-      await client.connect();
+         The preceding code example assigns the ``MongoClient`` variable using
+         :mdn:`object destructuring <Web/JavaScript/Reference/Operators/Destructuring_assignment#object_destructuring>`,
+         introduced in Node.js v6. You can create an instance of a
+         ``MongoClient`` without using object destructuring as shown in the
+         following code:
 
-      const database = client.db('sample_mflix');
-      const movies = database.collection('movies');
+         .. code-block:: js
 
-      // Query for a movie that has the title 'Back to the Future'
-      const query = { title: 'Back to the Future' };
-      const movie = await movies.findOne(query);
+            const MongoClient = require("mongodb").MongoClient;
 
-      console.log(movie);
-    } finally {
-      // Ensures that the client will close when you finish/error
-      await client.close();
-    }
-  }
-  run().catch(console.dir);
+   .. step:: Run your Node.js Application
 
-Run the sample code with the following command from your command line:
+      Run the application you created from the previous step from the
+      command line:
 
-.. code-block:: none
+      .. code-block:: none
 
-   node index.js
+         node index.js
 
-When you run the command, the sample code should output the details of the
-movie which resembles the following:
+      You should see the details of the retrieved movie document in the output:
 
-.. code-block:: none
+      .. code-block:: none
 
-   {
-     _id: ...,
-     plot: 'A young man is accidentally sent 30 years into the past...',
-     genres: [ 'Adventure', 'Comedy', 'Sci-Fi' ],
-     ...
-     title: 'Back to the Future',
-     ...
-   }
+         {
+           _id: ...,
+           plot: 'A young man is accidentally sent 30 years into the past...',
+           genres: [ 'Adventure', 'Comedy', 'Sci-Fi' ],
+           ...
+           title: 'Back to the Future',
+           ...
+         }
 
-If you receive an error, check whether you included the proper connection
-string in the application code, and loaded the sample dataset in your Atlas
-cluster.
+      If you encounter an error or no output, check whether you specified the
+      proper connection string in the application code, and loaded the sample
+      data set in your Atlas cluster.
 
-After completing this step, you should have a working application that uses
-the Node.js driver to connect to your MongoDB instance, run a query on the
-sample data, and prints out the result.
+      At this point, you should have a working application that uses
+      the {+driver-short+} to connect to your MongoDB instance, runs a query
+      on the sample data, and prints out the result.
 
 Next Steps
 ----------
 
-Learn how to read and modify data using the Node.js driver in our
-:doc:`CRUD Operations guide </fundamentals/crud>` or how to perform common
-operations in our :doc:`usage examples </usage-examples>`.
+Learn how to read and modify data using the {+driver-short+} in our
+:ref:`CRUD Operations <node-crud-landing>` guide or how to perform common
+operations in our :ref:`Usage Examples <node-usage-examples>`.

source/usage-examples.txt

@@ -1,3 +1,5 @@
+.. _node-usage-examples:
+
 ==============
 Usage Examples
 ==============