DOCSP-44743-audit-compass-includes

mongodb · Dec 6, 2024 · ea3f2a6 · ea3f2a6
1 parent b1c8016
commit ea3f2a6
Show file tree

Hide file tree

Showing 35 changed files with 35 additions and 97 deletions.
diff --git a/source/collections.txt b/source/collections.txt
@@ -31,7 +31,7 @@ single :ref:`database <compass-database-tab>`.
 Collections Screen
 ------------------
 
-.. include:: /includes/fact-collections-screen.rst
+.. include:: /includes/shared/fact-collections-screen.rst
 
 Collection Information
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -70,14 +70,14 @@ Create a Collection
 
 You can create new collections in an existing database.
 
-.. include:: /includes/steps/create-collection.rst
+.. include:: /includes/shared/steps/create-collection.rst
 
 .. _compass-drop-collection:
 
 Drop a Collection
 -----------------
 
-.. include:: /includes/steps/delete-collection.rst
+.. include:: /includes/shared/steps/delete-collection.rst
 
 Collection Details
 ------------------

diff --git a/source/create-agg-pipeline.txt b/source/create-agg-pipeline.txt
@@ -99,7 +99,7 @@ your chosen view mode:
 
             .. note::
 
-               .. include:: /includes/fact-agg-pipeline-preview-toggle.rst 
+               .. include:: /includes/shared/fact-agg-pipeline-preview-toggle.rst 
 
                For example, the following pipeline excludes the first 
                :manual:`$match </reference/operator/aggregation/match/>` stage 
@@ -132,7 +132,7 @@ your chosen view mode:
 
             .. warning::
 
-               .. include:: /includes/fact-agg-pipeline-merge-out-confirm.rst
+               .. include:: /includes/shared/fact-agg-pipeline-merge-out-confirm.rst
 
    .. tab:: Stage Wizard 
       :tabid: wizard 
@@ -265,7 +265,7 @@ your chosen view mode:
 
             .. note:: 
 
-               .. include:: /includes/fact-agg-pipeline-preview-toggle.rst
+               .. include:: /includes/shared/fact-agg-pipeline-preview-toggle.rst
 
          .. step:: Add additional pipeline stages
 

diff --git a/source/databases.txt b/source/databases.txt
@@ -41,15 +41,15 @@ You can also :ref:`create <compass-create-database>` or
 Create a Database
 -----------------
 
-.. include:: /includes/steps/create-database.rst
+.. include:: /includes/shared/steps/create-database.rst
 
 .. _compass-drop-database:
 .. _compass-drop-a-db:
 
 Drop a Database
 ---------------
 
-.. include:: /includes/steps/delete-database.rst
+.. include:: /includes/shared/steps/delete-database.rst
 
 .. BEGIN-COMPASS-ONLY
 

diff --git a/source/documents/modify.txt b/source/documents/modify.txt
@@ -99,7 +99,7 @@ documents in List, JSON, or Table view:
 
       .. include:: /includes/fact-modify-findOneAndUpdate.rst
 
-      .. include:: /includes/fact-modify-prevent-overwrites.rst
+      .. include:: /includes/shared/fact-modify-prevent-overwrites.rst
 
       Save Changes
       ~~~~~~~~~~~~
@@ -144,7 +144,7 @@ documents in List, JSON, or Table view:
 
       .. include:: /includes/fact-modify-findOneAndReplace.rst
 
-      .. include:: /includes/fact-modify-prevent-overwrites.rst
+      .. include:: /includes/shared/fact-modify-prevent-overwrites.rst
 
    .. tab:: Table View
       :tabid: table-view
@@ -160,7 +160,7 @@ documents in List, JSON, or Table view:
 
       .. include:: /includes/fact-modify-findOneAndUpdate.rst
 
-      .. include:: /includes/fact-modify-prevent-overwrites.rst
+      .. include:: /includes/shared/fact-modify-prevent-overwrites.rst
 
       Delete Fields
       ~~~~~~~~~~~~~

diff --git a/source/includes/fact-compass-platforms.rst b/source/includes/fact-compass-platforms.rst
diff --git a/source/includes/fact-create-view-from-pipeline.rst b/source/includes/fact-create-view-from-pipeline.rst
diff --git a/source/includes/query-history-view.png b/source/includes/query-history-view.png
diff --git a/source/includes/clear-query.rst → source/includes/shared/clear-query.rst b/source/includes/clear-query.rst → source/includes/shared/clear-query.rst
diff --git a/source/includes/collection-options.rst → ...ce/includes/shared/collection-options.rst b/source/includes/collection-options.rst → ...ce/includes/shared/collection-options.rst
@@ -6,6 +6,8 @@ If you want to use :manual:`custom collation
 select the :guilabel:`Use Custom Collation` checkbox and select the
 desired collation settings.   
 
+.. BEGIN-COMPASS-ONLY
+
 If your deployment is connected using :guilabel:`In-Use Encryption`, you can 
 use :v6.0:`Queryable Encryption </core/queryable-encryption/>` on the newly 
 created collection. Check the :guilabel:`Queryable Encryption` option
@@ -16,3 +18,5 @@ and indicate the following encryption properties:
 - (Optional) :v6.0:`KMS Provider </core/queryable-encryption/fundamentals/kms-providers/>`.
 
 - (Optional) :v6.0:`Key Encryption Key </core/queryable-encryption/fundamentals/keys-key-vaults/>`. 
+
+.. END-COMPASS-ONLY
diff --git a/source/includes/extracts-query-bar.yaml → ...e/includes/shared/extracts-query-bar.yaml b/source/includes/extracts-query-bar.yaml → ...e/includes/shared/extracts-query-bar.yaml
diff --git a/...s/fact-agg-pipeline-merge-out-confirm.rst → ...d/fact-agg-pipeline-merge-out-confirm.rst b/...s/fact-agg-pipeline-merge-out-confirm.rst → ...d/fact-agg-pipeline-merge-out-confirm.rst
diff --git a/...udes/fact-agg-pipeline-preview-toggle.rst → ...ared/fact-agg-pipeline-preview-toggle.rst b/...udes/fact-agg-pipeline-preview-toggle.rst → ...ared/fact-agg-pipeline-preview-toggle.rst
diff --git a/source/includes/fact-automatic-objectid.rst → ...cludes/shared/fact-automatic-objectid.rst b/source/includes/fact-automatic-objectid.rst → ...cludes/shared/fact-automatic-objectid.rst
diff --git a/source/includes/fact-collections-screen.rst → ...cludes/shared/fact-collections-screen.rst b/source/includes/fact-collections-screen.rst → ...cludes/shared/fact-collections-screen.rst
diff --git a/...ncludes/fact-modify-findOneAndReplace.rst → .../shared/fact-modify-findOneAndReplace.rst b/...ncludes/fact-modify-findOneAndReplace.rst → .../shared/fact-modify-findOneAndReplace.rst
diff --git a/...includes/fact-modify-findOneAndUpdate.rst → ...s/shared/fact-modify-findOneAndUpdate.rst b/...includes/fact-modify-findOneAndUpdate.rst → ...s/shared/fact-modify-findOneAndUpdate.rst
diff --git a/...cludes/fact-modify-prevent-overwrites.rst → ...shared/fact-modify-prevent-overwrites.rst b/...cludes/fact-modify-prevent-overwrites.rst → ...shared/fact-modify-prevent-overwrites.rst
diff --git a/source/includes/run-query.rst → source/includes/shared/run-query.rst b/source/includes/run-query.rst → source/includes/shared/run-query.rst
diff --git a/source/includes/steps-create-collection.yaml → ...ludes/shared/steps-create-collection.yaml b/source/includes/steps-create-collection.yaml → ...ludes/shared/steps-create-collection.yaml
diff --git a/source/includes/steps-create-database.yaml → ...ncludes/shared/steps-create-database.yaml b/source/includes/steps-create-database.yaml → ...ncludes/shared/steps-create-database.yaml
@@ -15,7 +15,7 @@ content: |
    first collection. Both the database name and the collection name are
    required.
 
-   .. include:: /includes/collection-options.rst
+   .. include:: /includes/shared/collection-options.rst
 ---
 title: Click :guilabel:`Create Database` to create the database and its first collection.
 level: 4

diff --git a/source/includes/steps-create-index.yaml → ...e/includes/shared/steps-create-index.yaml b/source/includes/steps-create-index.yaml → ...e/includes/shared/steps-create-index.yaml
diff --git a/...ludes/steps-create-query-via-builder.yaml → ...hared/steps-create-query-via-builder.yaml b/...ludes/steps-create-query-via-builder.yaml → ...hared/steps-create-query-via-builder.yaml
diff --git a/source/includes/steps-delete-collection.yaml → ...ludes/shared/steps-delete-collection.yaml b/source/includes/steps-delete-collection.yaml → ...ludes/shared/steps-delete-collection.yaml
diff --git a/source/includes/steps-delete-database.yaml → ...ncludes/shared/steps-delete-database.yaml b/source/includes/steps-delete-database.yaml → ...ncludes/shared/steps-delete-database.yaml
diff --git a/source/includes/steps-drop-index.yaml → source/includes/shared/steps-drop-index.yaml b/source/includes/steps-drop-index.yaml → source/includes/shared/steps-drop-index.yaml
diff --git a/source/indexes.txt b/source/indexes.txt
@@ -79,7 +79,7 @@ For each index, |compass-short| displays the following information:
 Create an Index
 ---------------
 
-.. include:: /includes/steps/create-index.rst
+.. include:: /includes/shared/steps/create-index.rst
 
 .. BEGIN-COMPASS-ONLY
 
@@ -166,7 +166,7 @@ index.
 Drop an Index
 -------------
 
-.. include:: /includes/steps/drop-index.rst
+.. include:: /includes/shared/steps/drop-index.rst
 
 .. BEGIN-COMPASS-ONLY
 

diff --git a/source/query-with-natural-language/prompt-natural-language-aggregation.txt b/source/query-with-natural-language/prompt-natural-language-aggregation.txt
@@ -69,7 +69,7 @@ Steps
 
          .. warning::
 
-            .. include:: /includes/fact-agg-pipeline-merge-out-confirm.rst
+            .. include:: /includes/shared/fact-agg-pipeline-merge-out-confirm.rst
 
       b. Press enter or click the :guilabel:`Run` button to execute 
          the pipeline.

diff --git a/source/query/collation.txt b/source/query/collation.txt
@@ -31,12 +31,12 @@ Set Collation
    As you type, the :guilabel:`Find` button is disabled and the
    :guilabel:`Collation` label turns red until a valid query is entered.
 
-#. .. include:: /includes/run-query.rst
+#. .. include:: /includes/shared/run-query.rst
 
 Clear the Query
 ---------------
 
-.. include:: /includes/clear-query.rst
+.. include:: /includes/shared/clear-query.rst
 
 To Learn More
 -------------

diff --git a/source/query/filter.txt b/source/query/filter.txt
@@ -57,7 +57,7 @@ Set Query Filter
 
          { "title": "Jurassic Park" }
 
-#. .. include:: /includes/run-query.rst
+#. .. include:: /includes/shared/run-query.rst
 
    .. figure:: /images/querybar/query-filter-success.png
       :figwidth: 600px
@@ -450,7 +450,7 @@ Extended JSON :manual:`BSON data types </reference/mongodb-extended-json#bson-da
 Clear the Query
 ---------------
 
-.. include:: /includes/clear-query.rst
+.. include:: /includes/shared/clear-query.rst
 
 .. BEGIN-COMPASS-ONLY
 

diff --git a/source/query/limit.txt b/source/query/limit.txt
@@ -19,7 +19,7 @@ To specify the limit:
 #. Enter an integer representing the number of documents to return into
    the :guilabel:`Limit` field.
 
-#. .. include:: /includes/run-query.rst
+#. .. include:: /includes/shared/run-query.rst
 
    .. figure:: /images/querybar/query-limit-success.png
       :figwidth: 600px
@@ -29,7 +29,7 @@ To specify the limit:
 Clear the Query
 ---------------
 
-.. include:: /includes/clear-query.rst
+.. include:: /includes/shared/clear-query.rst
 
 How Does the |compass-short| Query Compare to MongoDB and SQL Queries?
 ----------------------------------------------------------------------

diff --git a/source/query/project.txt b/source/query/project.txt
@@ -44,11 +44,11 @@ To set a projection:
    As you type, the :guilabel:`Find` button is disabled and the
    :guilabel:`Project` label turns red until a valid query is entered.
 
-#. .. include:: /includes/run-query.rst
+#. .. include:: /includes/shared/run-query.rst
 
    .. note::
 
-      .. include:: /includes/extracts/query-bar-results.rst
+      .. include:: /includes/shared/extracts/query-bar-results.rst
 
 How Does the |compass-short| Query Compare to MongoDB and SQL Queries?
 ----------------------------------------------------------------------

diff --git a/source/query/skip.txt b/source/query/skip.txt
@@ -24,16 +24,16 @@ To specify the number of documents to skip:
       :lightbox:
       :alt: Results of using the Skip option
 
-#. .. include:: /includes/run-query.rst
+#. .. include:: /includes/shared/run-query.rst
 
    .. note::
 
-      .. include:: /includes/extracts/query-bar-results.rst
+      .. include:: /includes/shared/extracts/query-bar-results.rst
 
 Clear the Query
 ---------------
 
-.. include:: /includes/clear-query.rst
+.. include:: /includes/shared/clear-query.rst
 
 How Does the |compass-short| Query Compare to MongoDB and SQL Queries?
 ----------------------------------------------------------------------

diff --git a/source/query/sort.txt b/source/query/sort.txt
@@ -57,12 +57,12 @@ To set the sort order:
    As you type, the :guilabel:`Find` button is disabled and the
    :guilabel:`Sort` label turns red until a valid query is entered.
 
-#. .. include:: /includes/run-query.rst
+#. .. include:: /includes/shared/run-query.rst
 
 Clear the Query
 ---------------
 
-.. include:: /includes/clear-query.rst
+.. include:: /includes/shared/clear-query.rst
 
 How Does the |compass-short| Query Compare to MongoDB and SQL Queries?
 ----------------------------------------------------------------------

diff --git a/source/schema.txt b/source/schema.txt
@@ -72,7 +72,7 @@ particular fields to display and the number of results to return.
 
 .. note::
 
-   .. include:: /includes/extracts/query-bar-results.rst
+   .. include:: /includes/shared/extracts/query-bar-results.rst
 
 .. figure:: /images/compass/query-bar-schema-view.png
    :figwidth: 730px
@@ -264,7 +264,7 @@ elements.
 The following procedure describes the steps involved in
 building a complex query with the query bar.
 
-.. include:: /includes/steps/create-query-via-builder.rst
+.. include:: /includes/shared/steps/create-query-via-builder.rst
 
 .. _compass-analyze-location-data:
 

diff --git a/source/views.txt b/source/views.txt
@@ -26,7 +26,7 @@ as opposed to having access to the underlying collection.
 Collections Screen
 ------------------
 
-.. include:: /includes/fact-collections-screen.rst
+.. include:: /includes/shared/fact-collections-screen.rst
 
 |compass-short| displays views in the :guilabel:`Collections Screen`
 with a special icon, and indicates the collection from which the view