(DOCSP-4339): Refactor Compass Install page.

Anthony Sansone · atsansone · commit 88030580d91f · 2019-04-02T14:33:01.000-05:00
diff --git a/source/install.txt b/source/install.txt
@@ -10,168 +10,242 @@ Install Compass
    :depth: 1
    :class: singlecol
 
-Compatibility
+Prerequisites
 -------------
 
+Software Requirements
+~~~~~~~~~~~~~~~~~~~~~
+
 |compass| works with MongoDB Server version 3.0 and higher, both
 Enterprise and Community editions. It runs on 64-bit versions
-of Mac OS X, Windows, Ubuntu 14.04+ and RHEL 7+.
+of Mac macOS, Windows, Ubuntu 14.04+ and RHEL 7+.
 
 Software requirements to run |compass-short| are listed below:
 
 .. include:: /includes/fact-compass-platforms.rst
 
-Installation
-------------
-
 .. note::
 
-   As of MongoDB Server version 3.6, MongoDB packages a
-   platform-specific |compass-short| installation script with
-   `MongoDB Server downloads
-   <https://www.mongodb.com/download-center/enterprise>`_. For details,
-   see the :manual:`install_compass script
-   </reference/program/install_compass/>` documentation.
+   The Windows installation of |compass| requires
+   **Microsoft .NET Framework version 4.5 or later.** The
+   |compass-short| installer prompts you to install the
+   minimum required version of the .NET framework if it is
+   not already installed on your system.
+
+Network Requirements
+~~~~~~~~~~~~~~~~~~~~
+
+Certain features of |compass|, such as third-party mapping services and
+Intercom, require inbound connections from external sources to
+function. In some instances, users have reported issues with their
+system firewall blocking these network requests and thereby limiting
+|compass| functionalities. To fix this issue, configure your system
+firewall to allow incoming connections for |compass|.
+
+.. important::
+
+   Ensure ports ``80`` and ``443`` are open between |compass| and the
+   host for the MongoDB Instance to which Compass connects.
+
+.. include:: /includes/fact-isolated-edition-firewall.rst
 
 .. tabs::
 
    tabs:
      - id: osx
-       name: OS X
+       name: macOS
        content: |
 
-         Open the {+download-page+} and download the latest version of
-         |compass| for OS X. The package downloads as a ``.dmg`` disk
-         image. Once you have downloaded |compass-short|, click on the
-         ``.dmg`` file to open the disk image within the OS X Finder.
-         Drag the |compass| application to your
-         :guilabel:`Applications` folder and unmount the disk image.
+     - id: windows
+       name: Windows
+       content: |
+
+     - id: ubuntu
+       name: Ubuntu
+       content: |
 
-         .. figure:: /images/compass/osx-install-dialog.png
-            :figwidth: 600px
 
-         Launch |compass-short| by clicking on it from within the
-         :guilabel:`Applications` folder. Upon launch you will see the
-         following dialog:
+     - id: rhel
+       name: RHEL
+       content: |
 
-         .. figure:: /images/compass/application-downloaded-internet.png
-            :figwidth: 480px
 
-         Click Open to continue and launch |compass-short|.
+Download Compass
+----------------
 
-         .. note::
+.. tabs::
 
-            Depending on your system's security settings, you may have
-            to modify your system settings to grant |compass-short|
-            permissions to run. You may be prompted to enter your
-            system password before launching |compass-short|.
+   hidden: true
 
-     - id: windows
-       name: Windows
+   tabs:
+     - id: osx
+       name: macOS
        content: |
 
-         .. note::
+         To download |compass| to an macOS host using a web browser:
 
-            The Windows installation of |compass| requires
-            **Microsoft .NET Framework version 4.5 or later.** The
-            |compass-short| installer prompts you to install the
-            minimum required version of the .NET framework if it is
-            not already installed on your system.
+         1. Open the {+download-page+}. 
 
-         The |compass| setup application is available as an
-         ``.exe`` executable file. Open the {+download-page+} and
-         download the latest version of |compass| for Windows.
+         #. Download the latest version of |compass| for macOS. The
+            |compass| installer is a ``.dmg`` disk image.
 
-         Once you have downloaded the executable, run the file to begin
-         the setup process, which installs |compass-short|. The
-         executable file always installs |compass-short| to the
-         following path:
+     - id: windows
+       name: Windows
+       content: |
 
-         .. code-block:: none
+         To download |compass| to an Windows host using a web browser:
 
-            C:\Users\<user>\AppData\Local\<MongoDB Compass Edition>\
+         1. Open the {+download-page+}.
 
-         Once installed, |compass-short| launches automatically and prompts you to
-         configure privacy settings and specify update preferences.
+         #. Download the latest version of |compass| for Windows. The
+            |compass| installer is an ``.exe`` executable file.
 
      - id: ubuntu
        name: Ubuntu
        content: |
 
-         Download and Install from the MongoDB Downloads Page
-         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+         Download from the MongoDB Downloads Page
+         ````````````````````````````````````````
 
-         To install |compass| on Ubuntu, download the latest
-         |compass-short| package for Ubuntu from the {+download-page+}.
-         Double click on the ``.deb`` package to open the package using
-         Ubuntu Software. Click :guilabel:`Install`.
+         To download |compass| to an Ubuntu host using a web browser:
 
-         .. figure:: /images/compass/install-ubuntu.png
-            :figwidth: 654px
+         1. Open the {+download-page+}.
 
-         Once installed, launch Compass from your
-         :guilabel:`Applications` folder.
+         #. Download the latest version of |compass| for Ubuntu. The
+            |compass| installer is a ``.deb`` package.
 
-         Download and Install Using the Terminal
-         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+         Download using the Terminal
+         ```````````````````````````
 
-         You can also download and install |compass| via the terminal:
+         To download |compass| to an Ubuntu host using a shell:
 
-         #. Download the package:
+         1. Download the package using ``wget``:
 
             .. code-block:: sh
 
-               wget https://downloads.mongodb.com/compass/mongodb-compass_1.15.1_amd64.deb;
+               wget https://downloads.mongodb.com/compass/mongodb-compass_1.15.1_amd64.deb
 
-         #. Install Compass:
+            The |compass| installer is a ``.deb`` package.
 
-            .. code-block:: sh
+     - id: rhel
+       name: RHEL
+       content: |
 
-               sudo dpkg -i mongodb-compass_1.15.1_amd64.deb;
+         To download |compass| to a Red Hat Enterprise Linux host using
+         a shell:
 
-         #. Start Compass:
+         1. Download the package using ``wget``:
 
             .. code-block:: sh
 
-               mongodb-compass;
+               wget https://downloads.mongodb.com/compass/mongodb-compass-1.15.1.x86_64.rpm
 
-     - id: rhel
-       name: RHEL
+            The |compass| installer is an ``.rpm`` package.
+
+
+Install Compass
+---------------
+
+.. note::
+
+   As of MongoDB Server version 3.6, MongoDB packages a
+   platform-specific |compass-short| installation script with
+   `MongoDB Server downloads
+   <https://www.mongodb.com/download-center/enterprise>`_. For details,
+   see the :manual:`install_compass script
+   </reference/program/install_compass/>` documentation.
+
+
+
+.. tabs::
+
+   hidden: true
+
+   tabs:
+     - id: osx
+       name: macOS
        content: |
 
-         To download and install |compass| on Red Hat Enterprise Linux:
+         1. Once you have downloaded |compass-short|, double-click on the
+         ``.dmg`` file to open the disk image within the macOS Finder.
 
-         #. Download the package:
+         #. Drag the |compass| application to your
+            :guilabel:`Applications` folder.
 
-            .. code-block:: sh
+            .. figure:: /images/compass/osx-install-dialog.png
+               :figwidth: 600px
 
-               wget https://downloads.mongodb.com/compass/mongodb-compass-1.15.1.x86_64.rpm;
+         #. Eject the disk image.
 
-         #. Install Compass:
+         #. From the :guilabel:`Applications` folder, double-click on
+            the |compass-short| icon to start the application.
 
-            .. code-block:: sh
+         #. After you start the application, you see the following
+            dialog:
+
+            .. figure:: /images/compass/application-downloaded-internet.png
+               :figwidth: 480px
+
+         #. Click :guilabel:`Open` to continue and launch
+            |compass-short|.
+
+         .. note::
+
+            Depending on your system's security settings, you may have
+            to modify your system settings to grant |compass-short|
+            permissions to run. You may be prompted to enter your
+            system password before launching |compass-short|.
+
+     - id: windows
+       name: Windows
+       content: |
+
+         1. Double-click the installer file to install |compass-short|.
+            By default, the installer extracts |compass-short| to the
+            following path:
+
+            .. code-block:: ini
 
-               sudo yum install mongodb-compass-1.15.1.x86_64.rpm;
+               C:\Users\<user>\AppData\Local\<MongoDB Compass Edition>\
+
+         #. Once installed, |compass-short| launches and prompts you to
+            configure privacy settings and specify update preferences.
+
+     - id: ubuntu
+       name: Ubuntu
+       content: |
+
+         1. Double-click on the ``.deb`` package icon to start
+            installation.
+
+         #. Click :guilabel:`Install`.
+
+            .. figure:: /images/compass/install-ubuntu.png
+               :figwidth: 654px
+
+         #. Once installed, launch Compass from your
+            :guilabel:`Applications` folder.
 
          #. Start Compass:
 
             .. code-block:: sh
 
-               mongodb-compass;
+               mongodb-compass
 
-Compass Firewall Requirements
------------------------------
+     - id: rhel
+       name: RHEL
+       content: |
 
-Certain features of |compass|, such as third-party mapping services and
-Intercom, require inbound connections from external sources to
-function. In some instances, users have reported issues with their
-system firewall blocking these network requests and thereby limiting
-|compass| functionalities. To fix this issue, configure your system
-firewall to allow incoming connections for |compass|.
+         #. Install Compass:
 
-.. important::
+            .. code-block:: sh
+
+               sudo yum install mongodb-compass-1.15.1.x86_64.rpm
+
+         #. Start Compass:
+
+            .. code-block:: sh
+
+               mongodb-compass
 
-   Ensure ports ``80`` and ``443`` are open between |compass| and the
-   host for the MongoDB Instance to which Compass connects.
 
-.. include:: /includes/fact-isolated-edition-firewall.rst
