(DOCSP-11197): Wildcard index clarifications (#280)

* (DOCSP-11197): Wildcard index clarifications

* copy review edits

* updates per review

Author: jeff-allen-mongo

source/includes/steps-create-index.yaml

@@ -1,28 +1,51 @@
 title: Click the :guilabel:`Create Index` button.
 level: 4
 ref: create-collection
+stepnum: 1
 content: |
-    From the :ref:`Indexes <collection-tab>` tab, click the
-    :guilabel:`Create Index` button to bring up the
+    From the :ref:`Indexes <collection-tab>` tab, click
+    :guilabel:`Create Index` to open 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.
 ---
 title: Add fields to index.
 level: 4
 ref: index-fields
+stepnum: 3
 content: |
-   To specify a key for the index, select the field and the index type.
-   To index additional fields, click :guilabel:`Add Another Field`.
+
+   a. Specify an index key.
+
+      - To specify an existing document field as an index key, select
+        the field from the dropdown list.
+
+      - To specify a field which does not exist in any document as an
+        index key, enter the field name in the input box.
+
+      - To create a :manual:`compound index </core/index-compound/>`,
+        click :guilabel:`Add Another Field`.
+
+   b. Use the dropdown to the right of each field name to specify the
+      index type (``ascending``, ``descending``, or
+      :manual:`2dsphere </core/2dsphere/>`).
+
+   .. seealso::
+
+      To learn how to specify a wildcard index, see
+      :ref:`compass-wildcard-index`.
+
 ---
 title: Optional. Specify the index options.
 level: 4
 ref: index-options
+stepnum: 4
 content: |
 
    |compass-short| supports the following index options:
@@ -37,29 +60,28 @@ content: |
 
       * - Build index in the background
 
-        - If checked, ensure that the MongoDB deployment remains
-          available during the index build operation.
+        - Ensure that the MongoDB deployment remains available during
+          the index build operation.
 
         - :manual:`Background Construction </core/index-creation/index.html#background-construction>`
 
       * - Create unique index
 
-        - If checked, 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>`
 
-      * - Create :abbr:`TTL (Time to Live)`
+      * - Create a :abbr:`TTL (Time to Live)` index
 
-        - If checked, automatically delete documents 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>`
 
       * - Partial filter expression
       
-        - If checked, only index documents which match the specified
-          filter expression.
+        - Index only the documents which match the specified filter
+          expression.
 
           .. example::
 
@@ -74,20 +96,38 @@ content: |
 
       * - Use custom collation
 
-        - If checked, 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>`
 
       * - Wildcard projection (*New in MongoDB 4.2*)
         
-        - If checked, support unknown or arbitrary fields
-          which match the specified projection in the index.
+        - Support unknown or arbitrary fields which match the specified
+          projection in the index. To use a wildcard projection, set
+          your index field name to  ``$**``. This directs
+          |compass-short| to use all fields in the document (excluding
+          ``_id``).
+
+          .. example::
+
+             Consider the following wildcard projection document:
+
+             .. code-block:: javascript
+
+                {
+                  "product_attributes.elements" : 1,
+                  "product_attributes.resistance" : 1
+                }
+
+             If your index field name is ``$**``, your index only
+             includes the values of the fields in that projection.
 
-        - :manual-next:`Wildcard Indexes </core/index-wildcard/>`
+        - :ref:`compass-wildcard-index`
 ---
-title: Click :guilabel:`Create` to create the index.
+title: Click :guilabel:`Create Index`.
 level: 4
 ref: create-index-button
+stepnum: 5
 content: ""
 ...

source/indexes.txt

@@ -83,6 +83,36 @@ contain documents.
 
 .. include:: /includes/steps/create-index.rst
 
+.. _compass-wildcard-index:
+
+Wildcard Indexes
+~~~~~~~~~~~~~~~~
+
+.. versionadded:: v4.2
+
+You can create :manual:`wildcard indexes </core/index-wildcard/>` to
+support queries against unknown or arbitrary fields.
+
+.. example::
+
+   Consider a collection where documents contain a ``userMetadata``
+   object. The fields within the ``userMetadata`` object may vary
+   between documents.
+
+   You can create a wildcard index on ``userMetadata`` to account for
+   all potential fields within the object. In |compass-short|, enter
+   the following for the index name:
+
+   .. code-block:: javascript
+
+      userMetadata.$**
+
+   Specify a type (``ascending`` or ``descending``) for your wildcard
+   index, then click :guilabel:`Create Index`.
+
+   |compass-short| shows the type of your new index as
+   :guilabel:`Wildcard`.
+
 .. _drop-index:
 
 Drop an Index