From ea3f2a677311159466c34e3bba368ef68b655487 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Fri, 6 Dec 2024 11:57:14 -0500 Subject: [PATCH] DOCSP-44743-audit-compass-includes --- source/collections.txt | 6 ++-- source/create-agg-pipeline.txt | 6 ++-- source/databases.txt | 4 +-- source/documents/modify.txt | 6 ++-- source/includes/fact-compass-platforms.rst | 23 ------------- .../fact-create-view-from-pipeline.rst | 11 ------- source/includes/query-history-view.png | 32 ------------------- source/includes/{ => shared}/clear-query.rst | 0 .../{ => shared}/collection-options.rst | 4 +++ .../{ => shared}/extracts-query-bar.yaml | 0 .../fact-agg-pipeline-merge-out-confirm.rst | 0 .../fact-agg-pipeline-preview-toggle.rst | 0 .../{ => shared}/fact-automatic-objectid.rst | 0 .../{ => shared}/fact-collections-screen.rst | 0 .../fact-modify-findOneAndReplace.rst | 0 .../fact-modify-findOneAndUpdate.rst | 0 .../fact-modify-prevent-overwrites.rst | 0 source/includes/{ => shared}/run-query.rst | 0 .../{ => shared}/steps-create-collection.yaml | 0 .../{ => shared}/steps-create-database.yaml | 2 +- .../{ => shared}/steps-create-index.yaml | 0 .../steps-create-query-via-builder.yaml | 0 .../{ => shared}/steps-delete-collection.yaml | 0 .../{ => shared}/steps-delete-database.yaml | 0 .../{ => shared}/steps-drop-index.yaml | 0 source/indexes.txt | 4 +-- .../prompt-natural-language-aggregation.txt | 2 +- source/query/collation.txt | 4 +-- source/query/filter.txt | 4 +-- source/query/limit.txt | 4 +-- source/query/project.txt | 4 +-- source/query/skip.txt | 6 ++-- source/query/sort.txt | 4 +-- source/schema.txt | 4 +-- source/views.txt | 2 +- 35 files changed, 35 insertions(+), 97 deletions(-) delete mode 100644 source/includes/fact-compass-platforms.rst delete mode 100644 source/includes/fact-create-view-from-pipeline.rst delete mode 100644 source/includes/query-history-view.png rename source/includes/{ => shared}/clear-query.rst (100%) rename source/includes/{ => shared}/collection-options.rst (95%) rename source/includes/{ => shared}/extracts-query-bar.yaml (100%) rename source/includes/{ => shared}/fact-agg-pipeline-merge-out-confirm.rst (100%) rename source/includes/{ => shared}/fact-agg-pipeline-preview-toggle.rst (100%) rename source/includes/{ => shared}/fact-automatic-objectid.rst (100%) rename source/includes/{ => shared}/fact-collections-screen.rst (100%) rename source/includes/{ => shared}/fact-modify-findOneAndReplace.rst (100%) rename source/includes/{ => shared}/fact-modify-findOneAndUpdate.rst (100%) rename source/includes/{ => shared}/fact-modify-prevent-overwrites.rst (100%) rename source/includes/{ => shared}/run-query.rst (100%) rename source/includes/{ => shared}/steps-create-collection.yaml (100%) rename source/includes/{ => shared}/steps-create-database.yaml (92%) rename source/includes/{ => shared}/steps-create-index.yaml (100%) rename source/includes/{ => shared}/steps-create-query-via-builder.yaml (100%) rename source/includes/{ => shared}/steps-delete-collection.yaml (100%) rename source/includes/{ => shared}/steps-delete-database.yaml (100%) rename source/includes/{ => shared}/steps-drop-index.yaml (100%) diff --git a/source/collections.txt b/source/collections.txt index a3420f3f5..6805758de 100644 --- a/source/collections.txt +++ b/source/collections.txt @@ -31,7 +31,7 @@ single :ref:`database `. 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 index c7127c5ec..845c0fabc 100644 --- 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 ` 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 index 6f0f8cd06..0bd31a855 100644 --- a/source/databases.txt +++ b/source/databases.txt @@ -41,7 +41,7 @@ You can also :ref:`create ` or Create a Database ----------------- -.. include:: /includes/steps/create-database.rst +.. include:: /includes/shared/steps/create-database.rst .. _compass-drop-database: .. _compass-drop-a-db: @@ -49,7 +49,7 @@ Create a Database 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 index b2bb7776e..33ea0fed2 100644 --- 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 deleted file mode 100644 index b50076938..000000000 --- a/source/includes/fact-compass-platforms.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. list-table:: - :header-rows: 1 - :stub-columns: 1 - :class: compatibility - :widths: 10 30 30 30 - - * - Platform - - Mac OS X - - Windows - - Linux - * - Supported? - - |checkmark| - - |checkmark| - - |checkmark| - * - OS Version - - 10.10 and above (64-bit) - - 7 and above (64-bit) - - | Ubuntu 14.04+ - | RHEL 7+ (64-bit) - * - MongoDB Version - - 3.0+ - - 3.0+ - - 3.0+ diff --git a/source/includes/fact-create-view-from-pipeline.rst b/source/includes/fact-create-view-from-pipeline.rst deleted file mode 100644 index 944634f28..000000000 --- a/source/includes/fact-create-view-from-pipeline.rst +++ /dev/null @@ -1,11 +0,0 @@ -1. Click the arrow next to the :guilabel:`Save` button at the top - of the pipeline builder. - -#. Click :guilabel:`Create a View`. - -#. Enter a name for your view. - -#. Click :guilabel:`Create`. - -|compass-short| creates a view from your pipeline results in the same -database where the pipeline was created. \ No newline at end of file diff --git a/source/includes/query-history-view.png b/source/includes/query-history-view.png deleted file mode 100644 index 52da35a3a..000000000 --- a/source/includes/query-history-view.png +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - - - diff --git a/source/includes/clear-query.rst b/source/includes/shared/clear-query.rst similarity index 100% rename from source/includes/clear-query.rst rename to source/includes/shared/clear-query.rst diff --git a/source/includes/collection-options.rst b/source/includes/shared/collection-options.rst similarity index 95% rename from source/includes/collection-options.rst rename to source/includes/shared/collection-options.rst index 1c8af226c..3d6b524fa 100644 --- a/source/includes/collection-options.rst +++ b/source/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 ` 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 `. - (Optional) :v6.0:`Key Encryption Key `. + +.. END-COMPASS-ONLY diff --git a/source/includes/extracts-query-bar.yaml b/source/includes/shared/extracts-query-bar.yaml similarity index 100% rename from source/includes/extracts-query-bar.yaml rename to source/includes/shared/extracts-query-bar.yaml diff --git a/source/includes/fact-agg-pipeline-merge-out-confirm.rst b/source/includes/shared/fact-agg-pipeline-merge-out-confirm.rst similarity index 100% rename from source/includes/fact-agg-pipeline-merge-out-confirm.rst rename to source/includes/shared/fact-agg-pipeline-merge-out-confirm.rst diff --git a/source/includes/fact-agg-pipeline-preview-toggle.rst b/source/includes/shared/fact-agg-pipeline-preview-toggle.rst similarity index 100% rename from source/includes/fact-agg-pipeline-preview-toggle.rst rename to source/includes/shared/fact-agg-pipeline-preview-toggle.rst diff --git a/source/includes/fact-automatic-objectid.rst b/source/includes/shared/fact-automatic-objectid.rst similarity index 100% rename from source/includes/fact-automatic-objectid.rst rename to source/includes/shared/fact-automatic-objectid.rst diff --git a/source/includes/fact-collections-screen.rst b/source/includes/shared/fact-collections-screen.rst similarity index 100% rename from source/includes/fact-collections-screen.rst rename to source/includes/shared/fact-collections-screen.rst diff --git a/source/includes/fact-modify-findOneAndReplace.rst b/source/includes/shared/fact-modify-findOneAndReplace.rst similarity index 100% rename from source/includes/fact-modify-findOneAndReplace.rst rename to source/includes/shared/fact-modify-findOneAndReplace.rst diff --git a/source/includes/fact-modify-findOneAndUpdate.rst b/source/includes/shared/fact-modify-findOneAndUpdate.rst similarity index 100% rename from source/includes/fact-modify-findOneAndUpdate.rst rename to source/includes/shared/fact-modify-findOneAndUpdate.rst diff --git a/source/includes/fact-modify-prevent-overwrites.rst b/source/includes/shared/fact-modify-prevent-overwrites.rst similarity index 100% rename from source/includes/fact-modify-prevent-overwrites.rst rename to source/includes/shared/fact-modify-prevent-overwrites.rst diff --git a/source/includes/run-query.rst b/source/includes/shared/run-query.rst similarity index 100% rename from source/includes/run-query.rst rename to source/includes/shared/run-query.rst diff --git a/source/includes/steps-create-collection.yaml b/source/includes/shared/steps-create-collection.yaml similarity index 100% rename from source/includes/steps-create-collection.yaml rename to source/includes/shared/steps-create-collection.yaml diff --git a/source/includes/steps-create-database.yaml b/source/includes/shared/steps-create-database.yaml similarity index 92% rename from source/includes/steps-create-database.yaml rename to source/includes/shared/steps-create-database.yaml index ed3ea56ca..d88c8d452 100644 --- a/source/includes/steps-create-database.yaml +++ b/source/includes/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 b/source/includes/shared/steps-create-index.yaml similarity index 100% rename from source/includes/steps-create-index.yaml rename to source/includes/shared/steps-create-index.yaml diff --git a/source/includes/steps-create-query-via-builder.yaml b/source/includes/shared/steps-create-query-via-builder.yaml similarity index 100% rename from source/includes/steps-create-query-via-builder.yaml rename to source/includes/shared/steps-create-query-via-builder.yaml diff --git a/source/includes/steps-delete-collection.yaml b/source/includes/shared/steps-delete-collection.yaml similarity index 100% rename from source/includes/steps-delete-collection.yaml rename to source/includes/shared/steps-delete-collection.yaml diff --git a/source/includes/steps-delete-database.yaml b/source/includes/shared/steps-delete-database.yaml similarity index 100% rename from source/includes/steps-delete-database.yaml rename to source/includes/shared/steps-delete-database.yaml diff --git a/source/includes/steps-drop-index.yaml b/source/includes/shared/steps-drop-index.yaml similarity index 100% rename from source/includes/steps-drop-index.yaml rename to source/includes/shared/steps-drop-index.yaml diff --git a/source/indexes.txt b/source/indexes.txt index 8f1d4a5be..179df848e 100644 --- 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 index 84a0ad198..ff43ebc5d 100644 --- 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 index e3587ca87..56ae694f1 100644 --- 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 index d894f2a24..de41a92b9 100644 --- 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