DOP-1151: prep Compass for publishing on snooty

- adds title, intersphinx, and substitutions to snooty.toml
- cleans up reference and path errors

Author: schmalliso

README.rst

@@ -8,7 +8,7 @@ Manual <http://docs.mongodb.org/manual/>`_.
 
 If you already have `giza <https://pypi.python.org/pypi/giza/>`_
 installed, you can download and build this documentation locally with
-the following command: ::
+the following command::
 
      git clone git://github.com/mongodb/docs-compass
      cd docs-compass/

snooty.toml

@@ -1,6 +1,21 @@
 name = "compass"
+title = "MongoDB Compass"
+
+intersphinx = ["https://docs.mongodb.com/manual/objects.inv"]
+
+toc_landing_pages = ["/install", "/connect", "/instance", "/query/filter", "/query/queries",
+                     "/documents", "/schema", "/aggregation-pipeline-builder"]
 
 [constants]
-version = "1.18"
-current-version = "1.17.0"
 download-page = "`downloads page <https://www.mongodb.com/download-center/compass?tck=docs_compass>`__"
+current-version = "1.21.2"
+
+
+[substitutions]
+compass = "MongoDB Compass"
+compass-short = "Compass"
+sql = ":abbr:`SQL (Structured Query Language)`"
+service = "Atlas"
+json = "abbr:`JSON (Javascript Object Notation)`"
+bson = ":abbr:`BSON (Binary Javascript Object Notation)`"
+checkmark = "√"

source/aggregation-pipeline-builder.txt

@@ -55,15 +55,15 @@ letter case and accent marks.
 
 To specify a custom collation:
 
-1. Click the :guilabel:`Collation` button at the top of the pipeline
+#. Click the :guilabel:`Collation` button at the top of the pipeline
    builder.
 
 #. Enter your collation document.
 
 Limitations
 ~~~~~~~~~~~
 
-The :pipeline:`$out` stage is not available if you are connected to a
+The :pipeline:`$out` WORDS stage is not available if you are connected to a
 `Data Lake <https://www.mongodb.com/atlas/data-lake>`__. 
 
 .. _save-agg-pipeline:

source/includes/fact-compass-platforms.rst

@@ -21,4 +21,3 @@
      - 3.0+
      - 3.0+
      - 3.0+
-     - 3.0+

source/includes/steps-create-index.yaml

@@ -3,17 +3,17 @@ level: 4
 ref: create-collection
 stepnum: 1
 content: |
-    From the :ref:`Indexes <collection-tab>` tab, click
-    :guilabel:`Create Index` to open the
-    :guilabel:`Create Index` dialog.
+  From the :ref:`Indexes <collection-tab>` tab, click the
+  :guilabel:`Create Index` button to bring up the
+  :guilabel:`Create Index` dialog.
 ---
 title: Optional. Enter the index name.
 level: 4
 ref: enter-index-name
 stepnum: 2
 content: |
-   In the dialog, enter the name of the index to create, or leave blank
-   to have MongoDB create a default name for the index.
+  In the dialog, enter the name of the index to create, or leave blank
+  to have MongoDB create a default name for the index.
 ---
 title: Add fields to index.
 level: 4
@@ -48,58 +48,58 @@ ref: index-options
 stepnum: 4
 content: |
 
-   |compass-short| supports the following index options:
+  |compass-short| supports the following index options:
 
-   .. list-table::
-      :header-rows: 1
-      :widths: 40 60 20
+  .. list-table::
+     :header-rows: 1
+     :widths: 40 60 20
 
-      * - Option
-        - Description
-        - More Information
+     * - Option
+       - Description
+       - More Information
 
-      * - Build index in the background
+     * - Build index in the background
 
-        - Ensure that the MongoDB deployment remains available during
+       - Ensure that the MongoDB deployment remains available during
           the index build operation.
 
-        - :manual:`Background Construction </core/index-creation/index.html#background-construction>`
+       - :manual:`Background Construction </core/index-creation/index.html#background-construction>`
 
-      * - Create unique index
+     * - Create unique index
 
-        - Ensure that the indexed fields do not store duplicate values.
+       - Ensure that the indexed fields do not store duplicate values.
 
-        - :manual:`Unique Indexes </core/index-unique>`
+       - :manual:`Unique Indexes </core/index-unique>`
 
-      * - Create a :abbr:`TTL (Time to Live)` index
+     * - Create a :abbr:`TTL (Time to Live)` index
 
-        - Delete documents automatically after a specified number of
-          seconds since the indexed field value.
+       - Delete documents automatically after a specified number of
+         seconds since the indexed field value.
 
-        - :manual:`TTL Indexes </core/index-ttl>`
+       - :manual:`TTL Indexes </core/index-ttl>`
 
-      * - Partial filter expression
+     * - Partial filter expression
       
-        - Index only the documents which match the specified filter
-          expression.
+       - Index only the documents which match the specified filter
+         expression.
 
-          .. example::
+         .. example::
 
-             The following partial filter expression only indexes
-             documents where the ``timezone`` field exists:
+            The following partial filter expression only indexes
+            documents where the ``timezone`` field exists:
 
-             .. code-block:: js
+            .. code-block:: js
 
-                { "timezone": { "$exists": true } } 
-      
-        - :manual:`Partial Indexes </core/index-partial/>`
+               { "timezone": { "$exists": true } } 
+     
+       - :manual:`Partial Indexes </core/index-partial/>`
 
-      * - Use custom collation
+     * - Use custom collation
 
-        - Create a custom collation for the index using the options
-          provided in |compass-short|.
+       - Create a custom collation for the index using the options
+         provided in |compass-short|.
 
-        - :manual:`Collation Document </reference/collation/#collation-document>`
+       - :manual:`Collation Document </reference/collation/#collation-document>`
 
       * - Wildcard projection (*New in MongoDB 4.2*)
         
@@ -130,4 +130,3 @@ level: 4
 ref: create-index-button
 stepnum: 5
 content: ""
-...

source/includes/steps-disconnect-compass.yaml

@@ -6,7 +6,6 @@ title: Select :guilabel:`Disconnect` from the dropdown menu.
 level: 4
 ref: select-disconnect
 content: |
-  .. figure:: images/compass/disconnect.png
+  .. figure:: /images/compass/disconnect.png
      :scale: 80%
      :alt: Disconnect menu item
-...

source/query/queries.txt

@@ -11,7 +11,7 @@ collection.
 
 To view these queries:
 
-#. Click the :icon:`ellipsis-h` in the query bar
+#. Click the ``…`` in the query bar.
 #. Click :guilabel:`Toggle Query History`.
 
    .. figure:: /images/compass/query-history-view.png

worker.sh

@@ -1,2 +1,2 @@
 #!/bin/sh
-build-and-stage-next-gen
+"build-and-stage-next-gen"