DOCS-6679: Compass documentation

.gitignore

@@ -27,6 +27,7 @@ source/reference/*/*/*.rst
 source/reference/*.rst
 source/images/*.png
 source/images/*.rst
+source/compass/images/*
 giza.log
 pdfs.yaml
 intersphinx.yaml

config/build_conf.yaml

@@ -33,6 +33,9 @@ assets:
   - branch: master
     path: build/docs-tools
     repository: https://github.com/mongodb/docs-tools.git
+  - branch: compass
+    path: source/compass/images
+    repository: https://github.com/mongodb/docs-assets.git
 paths:
   output: 'build'
   source: 'source'

source/contents.txt

@@ -21,4 +21,5 @@ project, this Manual and additional editions of this text.
    /faq
    /reference
    /release-notes
+   /products
    /contributors

source/includes/fact-compass-platforms.rst

@@ -0,0 +1,17 @@
+.. list-table::
+   :header-rows: 1
+   :stub-columns: 1
+   :class: compatibility
+
+   * - Platform
+     - Mac OS X
+     - Windows
+     - Linux
+   * - Supported?
+     - |checkmark|
+     - |checkmark|
+     -
+   * - OS Version
+     - 10.10+
+     - 7+
+     - N/A

source/includes/steps-compass-manual-queries.yaml

@@ -0,0 +1,32 @@
+title: Enter a query in the query bar
+level: 4
+ref: enter-query
+action:
+  pre: |
+    Queries entered in the query bar must be valid MongoDB syntax. Only
+    :dbcommand:`finds <find>` will be executed.
+
+    This example manually selects documents whose ``departureAirportFsCode`` is
+    "JFK".
+
+    .. figure:: /compass/images/manual-query.png
+
+    When a valid query is entered, the bar is colored green and can be
+    executed. Invalid queries are colored red. The UI will automatically update
+    to indicate which fields and values are selected in the query.
+---
+title: Apply the query
+level: 4
+ref: apply
+action:
+  pre: |
+    After entering a query, run it by clicking the Apply button. To clear the
+    query, use the Reset button.
+
+    Continuing with the example, executing the query displays information on the
+    matching documents.
+
+    .. figure:: /compass/images/manual-query-results.png
+
+    To clear a query, use the Reset button.
+...

source/includes/steps-compass-query-builder.yaml

@@ -0,0 +1,44 @@
+title: Select values from charts
+level: 4
+ref: select-values
+action:
+  pre: |
+    Charts in Compass are fully interactive. Clicking on a chart value or bar
+    will automatically build a MongoDB query that matches the documents
+    pertaining to that section of the chart.
+
+    In the example below, clicking on the "JFK" bar builds a query matching all
+    documents whose ``departureAirportFsCode`` field matches "JFK".
+
+    .. figure:: /compass/images/query-builder-jfk.png
+
+    Clicking on other field values adds them to the selection, creating a more
+    complex query.
+
+    Continuing with the example, this selects a particular ``flightId`` in
+    addition to departures from JFK Airport.
+
+    .. figure:: /compass/images/query-builder-jfk-flight-code.png
+
+    To select multiple values within the same field, click and drag the mouse
+    over a selection of values. Alternatively, hold the Shift key while
+    selecting the desired values.
+
+    .. figure:: /compass/images/query-builder-multi-select.png
+
+    To deselect a previously-selected value, hold the Shift key while clicking
+    on the selection.
+
+    .. figure:: /compass/images/query-builder-deselect.png
+---
+title: Apply the query
+level: 4
+ref: apply
+action:
+  pre: |
+    After building a query, run it by clicking the Apply button. To clear the
+    query, use the Reset button.
+
+    Note that composing "OR" queries is **not yet possible** with the automatic
+    query builder.
+...

source/includes/steps-starting-compass.yaml

@@ -0,0 +1,58 @@
+title: Run and connect to MongoDB
+level: 4
+ref: run-connect
+action:
+  pre: |
+    When Compass is run for the first time, it presents the following initial
+    connection dialog:
+
+    .. figure:: /compass/images/new-connection-form.png
+
+    The following information is requested:
+
+    a. Hostname: The hostname of the machine where :program:`mongod` is running.
+    b. Port: The port of the machine where :program:`mongod` is running.
+    c. Authentication: The authentication mechanism to connect to the target
+       host. Supported authentication mechanisms include:
+
+       - MongoDB-CR
+       - SCRAM-SHA-1
+       - Kerberos
+       - LDAP
+
+    d. SSL: Whether or not Compass should connect to the target host with SSL.
+       Several SSL options are available:
+
+       - Unvalidated: If this option is used, the server cerficiate is not
+         validated and no client certificate will be provided. The server must be
+         set up to allow connections without valid certificates.
+       - Server Validation: The server certificate will be validated, but no
+         client certificate will be provided. The server must be set up to allow
+         connections without valid certificates.
+       - Server and Client Validation: The server certificate will be validated
+         and a client certificate must be provided.
+
+    e. Favorite Name (Optional): A nickname for the connection. Previous
+       connections are saved in Compass; a descriptive name simplifies
+       re-establishing the connection on future runs.
+
+    .. figure:: /compass/images/favorite-connections.png
+
+    After providing the requested information, click "Connect" to launch the
+    main Compass window.
+---
+title: Select a database and collection
+level: 4
+ref: select-db-coll
+action:
+  pre: |
+    Use the navigation pane to select a database and collection to analyze.
+
+    .. figure:: /compass/images/select-collection.png
+
+    After making a selection, Compass will begin analyzing documents and present
+    a summary screen. Below is an example; results will vary based on the
+    contents of the collection.
+
+    .. figure:: /compass/images/analysis-page.png
+...

source/products.txt

@@ -0,0 +1,34 @@
+===================
+Additional Products
+===================
+
+.. default-domain:: mongodb
+
+MongoDB provides several products that make it easy to manage and
+analyze data in a MongoDB deployment.
+
+.. class:: toc
+
+   `MongoDB Ops Manager <https://www.mongodb.com/products/ops-manager/?jmp=docs>`_
+      The easiest way to run MongoDB: includes Automation, Backup, and
+      Monitoring. For more information, see the `Ops Manager
+      documentation <https://docs.opsmanager.mongodb.com/current/?jmp=docs>`_.
+
+   |mms-home|
+      A cloud-based service for monitoring and backing up MongoDB
+      deployments. Also consider the |mms-docs|.
+
+   :doc:`/products/compass`
+      A sophisticated GUI that simplifies collection analysis with data
+      visualization and an easy-to-use query builder.
+
+.. class:: hidden
+
+   .. toctree::
+      :titlesonly:
+
+      /products/ops-manager
+      /products/cloud-manager
+      /products/compass
+
+.. include:: /includes/replacement-mms.rst

source/products/cloud-manager.txt

@@ -0,0 +1,10 @@
+=====================
+MongoDB Cloud Manager
+=====================
+
+|mms-home| is a cloud-based service for managing MongoDB deployments.
+It provides useful tools including automation, monitoring and backup.
+
+For more information, please consult the |mms-docs|.
+
+.. include:: /includes/replacement-mms.rst