DOCSP-17487 Change refs to mongosh (#172)

* DOCSP-17487 Change refs to mongosh

* Apply suggestions from code review

Co-authored-by: John Williams <[email protected]>

* DOCSP-17487 updates for copy review feedback

* DOCSP-17487 updates for review feedback

Co-authored-by: John Williams <[email protected]>

Author: kanchana-mongodb

snooty.toml

@@ -1,7 +1,7 @@
 name = "datalake"
 title = "MongoDB Atlas Data Lake"
 
-intersphinx = ["https://docs.mongodb.com/manual/objects.inv","https://docs.atlas.mongodb.com/objects.inv"]
+intersphinx = ["https://docs.mongodb.com/manual/objects.inv","https://docs.atlas.mongodb.com/objects.inv","https://docs.mongodb.com/database-tools/objects.inv","https://docs.mongodb.com/mongodb-shell/objects.inv"]
 
 toc_landing_pages = ["/config/config-data-lake", "/tutorial/getting-started", "/admin/query-with-sql", "/query/query-data-lake", "/tutorial/connect"]
 
@@ -83,6 +83,7 @@ mms = "Cloud Manager"
 mongo = ":binary:`~bin.mongo`"
 mongod = ":binary:`~bin.mongod`"
 mongos = ":binary:`~bin.mongos`"
+mongosh = ":binary:`~bin.mongosh`"
 nfs = ":abbr:`NFS (Network File System)`"
 nvme = ":abbr:`NVMe (non-volatile memory express)`"
 nvme-clusters = "clusters with local NVMe SSDs"

source/includes/fact-add-shell-to-path.rst

@@ -7,52 +7,47 @@
 
        content: |
 
-         a. Double-click the ``.msi`` file in Windows Explorer
-            and proceed through the installation wizard.
+         1. Extract the files from the downloaded archive.
+         
+         #. Click :icon-fa5-brands:`windows` and select 
+            :guilabel:`Control Panel`.
 
-         #. Add the ``bin`` directory to your command path.
+         #. Click :guilabel:`System and Security`, then 
+            :guilabel:`System`, then :guilabel:`Advanced System 
+            Settings`.
 
-            1. Click :icon-fa5-brands:`windows` and select :guilabel:`Control Panel`.
+         #. Click :guilabel:`Environment Variables`.
 
-            #. Click :guilabel:`System and Security`, then :guilabel:`System`,
-               then :guilabel:`Advanced System Settings`.
+         #. Select :guilabel:`Path` and click :guilabel:`Edit`.
 
-            #. Click :guilabel:`Environment Variables`.
-
-            #. Select :guilabel:`Path` and click :guilabel:`Edit`.
-
-            #. Add the ``bin`` directory where the installer placed your
-               MongoDB executables and click :guilabel:`OK`.
+         #. Click :guilabel:`New`, add the filepath to your |mongosh| 
+            binary, and click :guilabel:`OK`.
 
      - id: macos
        name: macOS
 
        content: |
 
          Copy the Homebrew command from the |service| UI
-         window and run it in your terminal.
+         window and run it in your terminal. If you downloaded the 
+         MongoDB Shell directly, follow the steps to `install 
+         <https://docs.mongodb.com/mongodb-shell/install/>`__ |mongosh|.
 
      - id: linux
        name: Linux
 
        content: |
 
-         a. Run the following command in your terminal to extract
-            the :binary:`~bin.mongo` shell:
-
-            .. code-block:: shell
+         Install the |mongosh| package.
 
-               tar -xzf ./<filename>.tgz
+         - For ``.deb`` package, use ``dpkg`` to install |mongosh|:
 
-         #. Add the ``bin`` directory to your ``PATH``
-            environment variable.
+           .. code-block:: sh
 
-            .. code-block:: none
+              sudo dpkg -i mongodb-mongosh_<mongosh-version-and-platform>.deb
 
-               export PATH=/<extraction-directory>/bin:$PATH
+         - For ``.rpm`` package, use ``rpm`` to install |mongosh|:
 
-            .. note::
+           .. code-block:: sh
 
-               This command applies only to the current shell session. Edit
-               the ``PATH`` environment variable in ``~/.profile``
-               to update the variable across shell sessions and reboots.
+              sudo rpm -i mongodb-mongosh_<mongosh-version-and-platform>.rpm

source/includes/steps-connect-shell.yaml

@@ -4,7 +4,7 @@ level: 4
 content: |
   Click the :guilabel:`Connect` button for your {+dl+}.
 ---
-title: "Click :guilabel:`Connect with the Mongo Shell`."
+title: "Click :guilabel:`Connect with the MongoDB Shell`."
 ref: shell-connect-with-shell-button
 level: 4
 stepnum: 2
@@ -14,10 +14,9 @@ ref: shell-copy-string
 level: 4
 stepnum: 4
 content: |
-  This is a unique connection string specific to your |service|
-  cluster. |service| replaces the ``username`` of the connection
-  string with the username of the database user you created earlier
-  in this procedure.
+  This is a unique connection string specific to your {+dl+}. |service| 
+  replaces the ``username`` of the connection string with the username 
+  of the database user that you :ref:`created <create-mdb-user>`.
 ---
 title: "Paste and run your connection string in your terminal."
 ref: shell-run-connection-string
@@ -32,12 +31,12 @@ content: |
   You will be prompted to enter the password you specified when you
   created your database user in |service|.
 
-  You should now be connected to your |service| cluster within the
-  :binary:`~bin.mongo` shell. 
+  You should now be connected to your {+dl+} within the MongoDB Shell, 
+  |mongosh|. 
 
   .. important:: Connection Troubleshooting
 
-     If you are having trouble connecting to your cluster, double check 
+     If you are having trouble connecting to your {+dl+}, double check 
      that you have added your IP address to your :atlas:`IP Access List 
      </tutorial/whitelist-connection-ip-address/>` and that you are 
      specifying the correct database user credentials. If you have 

source/includes/steps-data-lake-data-mapping.yaml

@@ -1,5 +1,5 @@
 
-title: "Run the following command in your :binary:`~bin.mongo` shell to 
+title: "Run the following command in your MongoDB Shell to 
        display the mapped database."
 ref: data-lake-check-databases-step1
 level: 4
@@ -9,7 +9,7 @@ content: |
 
      show dbs
 
-  The ``mongo`` shell outputs the following:
+  The MongoDB Shell outputs the following:
  
   .. code-block:: sh
      :copyable: false
@@ -36,7 +36,7 @@ content: |
 
      show collections
 
-  The ``mongo`` shell outputs the following:
+  The MongoDB Shell outputs the following:
 
   .. code-block:: none
      :copyable: false

source/includes/steps-data-lake-shell-installed.yaml

@@ -12,21 +12,15 @@ source:
   ref: shell-connect-with-shell-button
   file: steps-connect-shell.yaml 
 ---
-title: "Click :guilabel:`I have the Mongo Shell Installed`."
+title: "Click :guilabel:`I have the MongoDB Shell Installed`."
 ref: shell-installed-step3
 level: 4
 stepnum: 3
 ---
-title: "Select your ``mongo`` shell version from the drop-down."
+title: "Select ``mongosh`` from the dropdown."
 ref: shell-installed-step4
 level: 4
 stepnum: 4
-content: | 
-
-  .. note:: 
-
-     You must use Mongo Shell v3.6 or later to connect to your 
-     Data Lake. 
 ---
 ref: shell-installed-step5
 level: 4

source/includes/steps-data-lake-shell-not-installed.yaml

@@ -12,7 +12,7 @@ source:
   ref: shell-connect-with-shell-button
   file: steps-connect-shell.yaml 
 ---
-title: "Click :guilabel:`I do not have the Mongo Shell Installed`."
+title: "Click :guilabel:`I do not have the MongoDB Shell Installed`."
 ref: shell-not-installed-step3
 level: 4
 stepnum: 3
@@ -23,62 +23,59 @@ ref: shell-not-installed-step4
 level: 4
 stepnum: 4
 ---
-title: "Download the ``mongo`` shell."
+title: "Download the MongoDB shell, |mongosh|."
 ref: shell-download
 level: 4
 stepnum: 5
 content: |
   - If you are using :guilabel:`Windows` or :guilabel:`Linux`, you can
     choose to either download the shell directly, or fetch the shell
-    via URL.
+    via URL. For Linux, the type of file you download depends on the operating system you selected. If you select a version of:
+
+    - **Ubuntu or Debian** you receive a ``.deb`` package.
+    - **RHEL, Amazon Linux, or SUSE** you receive an ``.rpm`` package.
+
+    If your operating system isn't listed, see the :mongosh:`.tgz 
+    installation instructions </install>` in the |mongosh| 
+    documentation. 
 
   - If you are using :guilabel:`macOS`, you can use the provided
-    Homebrew command to download the shell.
+    Homebrew command to download or go to the `MongoDB Shell 
+    page <https://www.mongodb.com/try/download/shell>`__ to download 
+    |mongosh|.
 ---
-title: "Add the ``mongo`` shell to your system path."
+title: "Install and add ``mongosh``, if necessary, to your system path."
 ref: shell-system-path
 level: 4
 stepnum: 6
 content: |
-  To run the :binary:`~bin.mongo` shell from your terminal, you must 
-  add the shell to your system path. Select the appropriate tab based 
-  on your operating system:
+  To run the MongoDB shell from your terminal, you must add the shell 
+  to your system path. Select the appropriate tab based on your 
+  operating system:
   
   .. include:: /includes/fact-add-shell-to-path.rst
 
-  You should now be able to run the ``mongo`` shell using your terminal.
+  You should now be able to run |mongosh| using your terminal.
 ---
-title: "Test your ``mongo`` shell installation."
+title: "Test your |mongosh| installation."
 optional: true
 ref: shell-test-install
 level: 4
 stepnum: 7
 content: |
-  To see if you have correctly added the ``mongo`` shell to 
-  your system path, run the following command in your terminal:
+  To see if you have correctly added |mongosh| to your system path, 
+  run the following command in your terminal:
 
   .. code-block:: none
 
-     mongo --version
+     mongosh --version
 
   You should see an output similar to the following:
 
   .. code-block:: none
      :copyable: false
 
-     MongoDB shell version v4.4.1
-     Build Info: {
-       "version": "4.4.1",
-       "gitVersion": "ad91a93a5a31e175f5cbf8c69561e788bbc55ce1",
-       "modules": [
-         "enterprise"
-       ],
-       "allocator": "system",
-       "environment": {
-         "distarch": "x86_64",
-         "target_arch": "x86_64"
-       }
-     }
+     1.0.0
 ---
 ref: shell-not-installed-step8
 level: 4

source/query/download-query-logs.txt

@@ -34,7 +34,7 @@ To download {+adl+} query logs, you must have the
 :authrole:`Project Data Access Read Only` or higher role.
 
 Procedure 
-~~~~~~~~~
+---------
 
 To download query logs:
 

source/tutorial/connect.txt

@@ -17,7 +17,7 @@ Connect to Your {+data-lake-short+}
 *Estimated completion time: 15 minutes*
 
 This part of the tutorial will walk you through connecting to your
-{+dl+} using the :binary:`~bin.mongo` shell. 
+{+dl+} using the MongoDB Shell, |mongosh|. 
 
 Prerequisites
 -------------
@@ -31,11 +31,11 @@ the following:
 
 .. _data-lake-connect:
 
-Connect to Your {+data-lake-short+} Using the ``mongo`` Shell
--------------------------------------------------------------
+Connect to Your {+dl+} Using the MongoDB Shell
+-------------------------------------------------
 
-Connecting to your {+data-lake-short+} depends on whether
-you have the :binary:`~bin.mongo` shell installed:
+Connecting to your {+dl+} depends on whether you have the MongoDB 
+shell, |mongosh|, installed:
 
 .. tabs::
 

source/tutorial/run-queries.txt

@@ -35,7 +35,7 @@ To complete this part of the tutorial, you will need to have completed:
 - **Part 3:** :doc:`/tutorial/configure-database-collections`
 
 You must be :ref:`connected <data-lake-connect>` to your {+dl+} with the
-:binary:`~bin.mongo` shell before running the following queries. 
+MongoDB Shell before running the following queries. 
 
 Queries
 -------