From 1197375d1ad55421e96f71e0e7321cd9d4df3877 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Tue, 26 Nov 2024 14:29:35 -0500 Subject: [PATCH 1/6] DOCSP-45448-compass-constants --- source/collections.txt | 6 ++-- source/connect.txt | 6 ++-- .../connect/connect-from-the-command-line.txt | 16 +++++------ source/connect/connections.txt | 8 +++--- source/connect/disconnect.txt | 4 +-- .../import-export-cli/export.txt | 4 +-- .../import-export-cli/import.txt | 8 +++--- source/connect/required-access.txt | 2 +- source/databases.txt | 6 ++-- source/documents.txt | 8 +++--- source/documents/delete-multiple.txt | 8 +++--- source/documents/delete.txt | 4 +-- source/documents/modify-multiple.txt | 10 +++---- source/documents/modify.txt | 2 +- source/editions.txt | 6 ++-- source/faq.txt | 24 ++++++++-------- source/import-export.txt | 4 +-- source/in-use-encryption-tutorial.txt | 6 ++-- source/includes/atlas-sample-data-note.rst | 2 +- source/includes/extracts-query-bar.yaml | 4 +-- .../includes/fact-natural-language-query.rst | 2 +- ...ct-natural-language-querying-maxTimems.rst | 2 +- .../fact-viewing-favorite-queries.rst | 2 +- .../intro-advanced-connection-options.rst | 6 ++-- source/includes/multiple-connections.rst | 2 +- source/indexes.txt | 4 +-- source/install/verify-signatures.txt | 6 ++-- .../ai-and-data-usage-information.txt | 10 +++---- .../enable-natural-language-querying.txt | 11 ++++---- .../prompt-natural-language-aggregation.txt | 6 ++-- .../prompt-natural-language-query.txt | 4 +-- .../query-with-natural-language.txt | 12 ++++---- source/query/filter.txt | 12 ++++---- source/query/limit.txt | 6 ++-- source/query/project.txt | 6 ++-- source/query/queries.txt | 4 +-- source/query/skip.txt | 6 ++-- source/query/sort.txt | 6 ++-- source/schema.txt | 18 ++++++------ source/settings/command-line-options.txt | 20 ++++++------- source/settings/settings-reference.txt | 5 ++-- source/troubleshooting/connection-errors.txt | 28 +++++++++---------- source/troubleshooting/logs.txt | 14 +++++----- source/validation.txt | 2 +- source/views.txt | 6 ++-- 45 files changed, 169 insertions(+), 169 deletions(-) diff --git a/source/collections.txt b/source/collections.txt index 04eda077c..a3420f3f5 100644 --- a/source/collections.txt +++ b/source/collections.txt @@ -1,9 +1,9 @@ .. _compass-collection-tab: .. _compass-collections: -============================= -Manage Collections in Compass -============================= +===================================== +Manage Collections in |compass-short| +===================================== .. default-domain:: mongodb diff --git a/source/connect.txt b/source/connect.txt index 4210ddca7..952d74a2d 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -58,7 +58,7 @@ Connect ------- If your connection name is already in the :guilabel:`Connections -Sidebar` of your Compass window, click on the connection name to +Sidebar` of your |compass-short| window, click on the connection name to connect. Otherwise, you can connect your deployments by either: @@ -103,8 +103,8 @@ Use Advanced Connection Options For details, see :ref:`advanced-connection-options`. -Connect to Compass from the Command Line ----------------------------------------- +Connect to |compass-short| from the Command Line +------------------------------------------------ .. include:: /includes/intro-command-line-connection.rst diff --git a/source/connect/connect-from-the-command-line.txt b/source/connect/connect-from-the-command-line.txt index 1f07fc5c0..111a85ba0 100644 --- a/source/connect/connect-from-the-command-line.txt +++ b/source/connect/connect-from-the-command-line.txt @@ -1,8 +1,8 @@ .. _comp-command-line-connect: -=================================== -Start Compass from the Command Line -=================================== +=========================================== +Start |compass-short| from the Command Line +=========================================== .. default-domain:: mongodb @@ -27,8 +27,8 @@ the command line. .. _compass-executable-location: -Compass Executable Location ---------------------------- +|compass-short| Executable Location +----------------------------------- .. include:: /includes/compass-executable.rst @@ -51,7 +51,7 @@ the configuration file. The format is: .. note:: - If the username and password arguments are not provided, Compass uses + If the username and password arguments are not provided, |compass-short| uses the credentials in the connection string. @@ -71,7 +71,7 @@ Username and Password Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This example uses the ``username`` and ``password`` parameters to -authenticate Compass to the MongoDB deployment provided in the +authenticate |compass-short| to the MongoDB deployment provided in the connection string: .. code-block:: shell @@ -106,7 +106,7 @@ The components of the command invocation are: To create the connection configuration file, follow the steps to :ref:`export the connection details ` -from your Compass instance. The export process creates a file that +from your |compass-short| instance. The export process creates a file that includes all of your favorite connections. .. important:: diff --git a/source/connect/connections.txt b/source/connect/connections.txt index 31aec6049..4ccd1cd3c 100644 --- a/source/connect/connections.txt +++ b/source/connect/connections.txt @@ -17,7 +17,7 @@ Connections Sidebar .. include:: /includes/multiple-connections.rst -The :guilabel:`Connections Sidebar` on the left of the Compass window +The :guilabel:`Connections Sidebar` on the left of the |compass-short| window contains the following options: - :icon-lg:`Plus` icon to add new connections @@ -42,15 +42,15 @@ Connect to MongoDB To connect to a saved or favorite deployment, click the name of the connection in the :guilabel:`Connections` list. Once you connect, -Compass shows a success toast and displays a green dot next to the +|compass-short| shows a success toast and displays a green dot next to the connection name. -If a connection error occurs, Compass shows a toast with error +If a connection error occurs, |compass-short| shows a toast with error information and displays a red triangle next to the connection name. To see additional error information, click :guilabel:`Review` in the error toast. -To add a new connection to Compass, click the :icon-lg:`Plus` button at +To add a new connection to |compass-short|, click the :icon-lg:`Plus` button at the top of the :guilabel:`Connections Sidebar` to open the :guilabel:`New Connection` modal. For more information, see :ref:`connect-run-compass`. diff --git a/source/connect/disconnect.txt b/source/connect/disconnect.txt index b1b09ff3b..86f1548d7 100644 --- a/source/connect/disconnect.txt +++ b/source/connect/disconnect.txt @@ -6,8 +6,8 @@ Disconnect from MongoDB .. default-domain:: mongodb -Disconnecting from a MongoDB deployment closes the Compass connection to -the active deployment and returns the Compass view to the initial +Disconnecting from a MongoDB deployment closes the |compass-short| connection to +the active deployment and returns the |compass-short| view to the initial connection dialog. Steps diff --git a/source/connect/favorite-connections/import-export-cli/export.txt b/source/connect/favorite-connections/import-export-cli/export.txt index 552e24c23..e3159f088 100644 --- a/source/connect/favorite-connections/import-export-cli/export.txt +++ b/source/connect/favorite-connections/import-export-cli/export.txt @@ -60,7 +60,7 @@ This example exports saved |compass-short| connections to a file with the path ``/tmp/compass-connections/favorites-encrypted.json``. The exported file is encrypted with the passphrase ``abc123``. -Run the following command in the folder containing your MongoDB Compass +Run the following command in the folder containing your |compass| executable: .. code-block:: sh @@ -167,7 +167,7 @@ Example This example exports saved |compass-short| connections to a file with the path ``/tmp/compass-connections/favorites.json``. -Run the following command in the folder containing your MongoDB Compass +Run the following command in the folder containing your |compass| executable: .. code-block:: sh diff --git a/source/connect/favorite-connections/import-export-cli/import.txt b/source/connect/favorite-connections/import-export-cli/import.txt index 2c527c5e5..42747181e 100644 --- a/source/connect/favorite-connections/import-export-cli/import.txt +++ b/source/connect/favorite-connections/import-export-cli/import.txt @@ -62,7 +62,7 @@ a file with the path ``/tmp/compass-connections/favorites-encrypted.json`` that is encrypted with the passphrase ``abc123``. -Run the following command in the folder containing your MongoDB Compass +Run the following command in the folder containing your |compass| executable: .. code-block:: sh @@ -86,7 +86,7 @@ After you run the import command, you will see this output: Importing connections from "/tmp/compass-connections/favorites-encrypted.json" (with passphrase) -MongoDB Compass starts and you will see the imported connections under +|compass| starts and you will see the imported connections under :guilabel:`Saved Connections` on the Connect screen. Errors @@ -141,7 +141,7 @@ Example The following example imports saved |compass-short| connections from a file with the path ``/tmp/compass-connections/favorites.json``. -Run the following command in the folder containing your MongoDB Compass +Run the following command in the folder containing your |compass| executable: .. code-block:: sh @@ -163,5 +163,5 @@ After you run the import command, you will see this output: Importing connections from "/tmp/compass-connections/favorites.json" (without passphrase) -MongoDB Compass starts and you will see the imported connections under +|compass| starts and you will see the imported connections under :guilabel:`Saved Connections` on the Connect screen. diff --git a/source/connect/required-access.txt b/source/connect/required-access.txt index ef3d7ad98..9106cd5f6 100644 --- a/source/connect/required-access.txt +++ b/source/connect/required-access.txt @@ -18,7 +18,7 @@ privileges: :header-rows: 1 :widths: 25 30 25 20 - * - Compass View + * - |compass-short| View - Capability - Privilege(s) - MongoDB Built-In Role diff --git a/source/databases.txt b/source/databases.txt index 2d3efc852..6f0f8cd06 100644 --- a/source/databases.txt +++ b/source/databases.txt @@ -1,9 +1,9 @@ .. _compass-database-tab: .. _compass-dbs: -=========================== -Manage Databases in Compass -=========================== +=================================== +Manage Databases in |compass-short| +=================================== .. default-domain:: mongodb diff --git a/source/documents.txt b/source/documents.txt index 1bad8228b..16dcecfe0 100644 --- a/source/documents.txt +++ b/source/documents.txt @@ -1,9 +1,9 @@ .. _compass-documents: .. _compass-docs: -=========================== -Manage Documents in Compass -=========================== +=================================== +Manage Documents in |compass-short| +=================================== .. default-domain:: mongodb @@ -25,7 +25,7 @@ documents in your selected collection or view. .. note:: - For query result sets larger than 20 documents, Compass shows + For query result sets larger than 20 documents, |compass-short| shows paginated results. By default, pages display 20 documents at a time. .. END-COMPASS-ONLY diff --git a/source/documents/delete-multiple.txt b/source/documents/delete-multiple.txt index 9b02efa95..918a84f47 100644 --- a/source/documents/delete-multiple.txt +++ b/source/documents/delete-multiple.txt @@ -14,7 +14,7 @@ Delete Multiple Documents :depth: 1 :class: singlecol -You can perform bulk delete operations on multiple documents in Compass +You can perform bulk delete operations on multiple documents in |compass-short| by using the :guilabel:`Delete Documents` modal. This helps you visualize deletes before applying them. @@ -32,8 +32,8 @@ Before you Begin ---------------- The :guilabel:`Delete Documents` modal is available starting -in Compass version ``1.42.0``. For instructions on updating or installing -the latest Compass version, see :ref:`download-install`. +in |compass-short| version ``1.42.0``. For instructions on updating or installing +the latest |compass-short| version, see :ref:`download-install`. .. END-COMPASS-ONLY @@ -108,7 +108,7 @@ Steps #. Click the red :guilabel:`Delete Documents` button to confirm the operation. - Compass deletes the documents that match the filter + |compass-short| deletes the documents that match the filter expression. Example diff --git a/source/documents/delete.txt b/source/documents/delete.txt index fa0e45b7e..20b1c8c87 100644 --- a/source/documents/delete.txt +++ b/source/documents/delete.txt @@ -68,13 +68,13 @@ documents in List, JSON, or Table view: |compass-short| asks for confirmation that you want to remove the document. -Once you confirm, Compass deletes the document from the collection. +Once you confirm, |compass-short| deletes the document from the collection. Delete Multiple Documents ------------------------- You can use the bulk delete operations workflow to delete multiple -documents in Compass. For details, see :ref:`compass-bulk-delete`. +documents in |compass-short|. For details, see :ref:`compass-bulk-delete`. .. BEGIN-COMPASS-ONLY .. note:: diff --git a/source/documents/modify-multiple.txt b/source/documents/modify-multiple.txt index bc0ca781c..b8e84fb49 100644 --- a/source/documents/modify-multiple.txt +++ b/source/documents/modify-multiple.txt @@ -14,7 +14,7 @@ Modify Multiple Documents :depth: 1 :class: singlecol -You can perform bulk update operations on multiple documents in Compass +You can perform bulk update operations on multiple documents in |compass-short| by using the :guilabel:`Update Documents` modal. Performing updates with the :guilabel:`Update Documents` modal helps you visualize updates to your data before you apply them. @@ -38,8 +38,8 @@ Before you Begin ---------------- The :guilabel:`Update Documents` modal is available starting -in Compass version ``1.42.0``. For instructions on updating or installing -the latest Compass version, see :ref:`download-install`. +in |compass-short| version ``1.42.0``. For instructions on updating or installing +the latest |compass-short| version, see :ref:`download-install`. .. END-COMPASS-ONLY @@ -120,7 +120,7 @@ Steps Click :guilabel:`Update Documents`. - Compass applies the :guilabel:`Update` to the documents + |compass-short| applies the :guilabel:`Update` to the documents within the :guilabel:`Filter` expression. Example @@ -130,7 +130,7 @@ The following example uses the :ref:`sample_mflix dataset `. This example updates the ``tomatoes.viewer.numReviews`` and -``tomatoes.viewer.meter`` fields with the Compass +``tomatoes.viewer.meter`` fields with the |compass-short| :guilabel:`Update Documents` modal. Apply a filter in the :guilabel:`Query Bar` to filter movies which diff --git a/source/documents/modify.txt b/source/documents/modify.txt index c8a00bede..b2bb7776e 100644 --- a/source/documents/modify.txt +++ b/source/documents/modify.txt @@ -210,7 +210,7 @@ Modify Multiple Documents ------------------------- You can use the bulk update operations workflow to update multiple -documents in Compass. For details, see :ref:`compass-bulk-update`. +documents in |compass-short|. For details, see :ref:`compass-bulk-update`. .. BEGIN-COMPASS-ONLY diff --git a/source/editions.txt b/source/editions.txt index 2decae2ad..5e5c324b2 100644 --- a/source/editions.txt +++ b/source/editions.txt @@ -12,9 +12,9 @@ suit your needs. :widths: 40 15 15 15 * - - - Compass - - Compass Readonly - - Compass Isolated + - |compass-short| + - |compass-short| Readonly + - |compass-short| Isolated * - Interact with :ref:`documents `, :ref:`collections `, and diff --git a/source/faq.txt b/source/faq.txt index 2be7ef8b8..8f51768cc 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -14,8 +14,8 @@ FAQ .. _compass-faq-isolated: -What is the Compass Isolated Edition? -------------------------------------- +What is the |compass-short| Isolated Edition? +--------------------------------------------- .. include:: /includes/fact-isolated-edition-firewall.rst @@ -31,8 +31,8 @@ database to avoid scanning the entire collection. .. _compass-faq-confidential-data: -How does Compass handle confidential data? ------------------------------------------- +How does |compass-short| handle confidential data? +-------------------------------------------------- |compass| stores and retrieves sensitive data such as passwords using a credentials API specific to the operating system running @@ -55,8 +55,8 @@ how Keytar operates and the specific APIs it accesses, refer to the .. _compass-faq-logs: -Does Compass Maintain Logs? ---------------------------- +Does |compass-short| Maintain Logs? +----------------------------------- As part of normal operation, |compass| maintains a running log of events. |compass-short| logs provide a history of operations and can @@ -73,17 +73,17 @@ Why am I seeing a warning about a non-genuine MongoDB server? What happens to long running queries? ------------------------------------- -As a precaution, Compass aborts long running queries to prevent +As a precaution, |compass-short| aborts long running queries to prevent excessive querying on your database. Slow Sampling ~~~~~~~~~~~~~ -All queries that Compass sends to your MongoDB instance have a timeout +All queries that |compass-short| sends to your MongoDB instance have a timeout flag set which automatically aborts a request if it takes longer than the specified timeout. This timeout is currently set to 10 seconds. If -:ref:`sampling ` on the database takes longer, Compass will -notify you about the timeout and give you the options of (a) retrying +:ref:`sampling ` on the database takes longer, |compass-short| +will notify you about the timeout and give you the options of (a) retrying with a longer timeout (60 seconds) or (b) running a different query. .. note:: @@ -101,7 +101,7 @@ Slow Schema Analysis If the database returns documents faster than the specified timeout (10 or 60 seconds), but the schema analysis of the documents takes longer -than expected (due to complex, large documents), Compass gives you the +than expected (due to complex, large documents), |compass-short| gives you the option to abort the analysis step and show the partial results. Why are some features of |compass| not working? @@ -121,7 +121,7 @@ external services to enable features such as: To fix this issue, configure your system firewall to allow incoming connections for |compass|. Ensure ports ``80`` and ``443`` are open between |compass| and the host for the MongoDB deployment to which -Compass connects. +|compass-short| connects. .. include:: /includes/fact-isolated-edition-firewall.rst diff --git a/source/import-export.txt b/source/import-export.txt index eed164e84..715c664f5 100644 --- a/source/import-export.txt +++ b/source/import-export.txt @@ -33,7 +33,7 @@ clicking the collection in the left-side navigation. .. note:: - Compass is not a tool for backing up data. For information on backup + |compass-short| is not a tool for backing up data. For information on backup solutions, see :ref:`backup-methods`. .. _import-data: @@ -133,7 +133,7 @@ during import, the progress bar turns red and an error message appears in the dialog. To see all errors, click :guilabel:`View Log`. After successful import, the dialog closes and -Compass displays the collection page containing the newly imported +|compass-short| displays the collection page containing the newly imported documents. .. _export-data-collection: diff --git a/source/in-use-encryption-tutorial.txt b/source/in-use-encryption-tutorial.txt index 80f143a84..4dcc9eea3 100644 --- a/source/in-use-encryption-tutorial.txt +++ b/source/in-use-encryption-tutorial.txt @@ -37,9 +37,9 @@ Requirements and Limitations - You need a replica set to use this connection option. Your replica set can be a single node or larger. -- You need to connect to your deployment on Compass using In-Use Encryption. For - more information on how to connect to your deployment, see :ref:`In-Use Encryption - Connection tab `. +- You need to connect to your deployment on |compass-short| using In-Use + Encryption. For more information on how to connect to your deployment, see + :ref:`In-Use Encryption Connection tab `. Create Your Encrypted Collection -------------------------------- diff --git a/source/includes/atlas-sample-data-note.rst b/source/includes/atlas-sample-data-note.rst index 8e92ac9fe..441138bad 100644 --- a/source/includes/atlas-sample-data-note.rst +++ b/source/includes/atlas-sample-data-note.rst @@ -1,4 +1,4 @@ -.. note:: Try Compass with Sample Data +.. note:: Try |compass-short| with Sample Data `MongoDB Atlas `__ is a cloud-hosted database-as-a-service that diff --git a/source/includes/extracts-query-bar.yaml b/source/includes/extracts-query-bar.yaml index 323844a0e..f1f4c5c17 100644 --- a/source/includes/extracts-query-bar.yaml +++ b/source/includes/extracts-query-bar.yaml @@ -1,7 +1,7 @@ ref: query-bar-results content: | - For query result sets larger than 1000 documents, Compass shows a - subset of the results. Otherwise, Compass shows the entire result + For query result sets larger than 1000 documents, |compass-short| shows a + subset of the results. Otherwise, |compass-short| shows the entire result set. For details on sampling, see :ref:`Sampling `. diff --git a/source/includes/fact-natural-language-query.rst b/source/includes/fact-natural-language-query.rst index 6b17a3d09..dd38a0232 100644 --- a/source/includes/fact-natural-language-query.rst +++ b/source/includes/fact-natural-language-query.rst @@ -1,4 +1,4 @@ -When you query your data using natural language in Compass, the text of +When you query your data using natural language in |compass-short|, the text of your prompts and details about your MongoDB schemas are sent to Microsoft and OpenAI for processing. Your data is not stored on any third party storage systems or used to train AI models. diff --git a/source/includes/fact-natural-language-querying-maxTimems.rst b/source/includes/fact-natural-language-querying-maxTimems.rst index 829b618f2..839995088 100644 --- a/source/includes/fact-natural-language-querying-maxTimems.rst +++ b/source/includes/fact-natural-language-querying-maxTimems.rst @@ -1,5 +1,5 @@ It can be difficult to predict the complexity of the query or pipeline -returned by the Compass AI. You may need to adjust the +returned by the |compass-short| AI. You may need to adjust the :guilabel:`MAX TIME MS` query bar option to either allow longer query processing time or prevent long-running queries. For details, see :ref:`compass-query-bar-max-time-ms`. \ No newline at end of file diff --git a/source/includes/fact-viewing-favorite-queries.rst b/source/includes/fact-viewing-favorite-queries.rst index 4b557a4e7..0c438a1f0 100644 --- a/source/includes/fact-viewing-favorite-queries.rst +++ b/source/includes/fact-viewing-favorite-queries.rst @@ -36,5 +36,5 @@ Clicking the :icon-lg:`OpenNewTab` icon opens the bulk update statement and the filter criteria in the :guilabel:`Update Documents` modal. For details on bulk - update statements in Compass, see + update statements in |compass-short|, see :ref:`compass-bulk-update`. diff --git a/source/includes/intro-advanced-connection-options.rst b/source/includes/intro-advanced-connection-options.rst index 2372b0c7b..bfaf1a434 100644 --- a/source/includes/intro-advanced-connection-options.rst +++ b/source/includes/intro-advanced-connection-options.rst @@ -1,3 +1,3 @@ -The advanced connection options provide additional ways to connect Compass -to MongoDB. Advanced connection options allow you to specify authentication, -TLS/SSL, and SSH to securely connect to your deployment. +The advanced connection options provide additional ways to connect +|compass-short| to MongoDB. Advanced connection options allow you to specify +authentication, TLS/SSL, and SSH to securely connect to your deployment. diff --git a/source/includes/multiple-connections.rst b/source/includes/multiple-connections.rst index 3119a217f..2a604e499 100644 --- a/source/includes/multiple-connections.rst +++ b/source/includes/multiple-connections.rst @@ -1,2 +1,2 @@ Starting in version 1.44.0, you can connect to multiple MongoDB -instances at once through Compass. \ No newline at end of file +instances at once through |compass-short|. \ No newline at end of file diff --git a/source/indexes.txt b/source/indexes.txt index 6926bb8a8..8f1d4a5be 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -52,7 +52,7 @@ collection on the left hand pane and select the :guilabel:`Indexes` tab. :figwidth: 816px :alt: Indexes view -For each index, Compass displays the following information: +For each index, |compass-short| displays the following information: .. list-table:: @@ -178,7 +178,7 @@ Limitations - The :guilabel:`Indexes` tab is not available if you are connected to a :atlas:`Data Lake `. -- You can manage Atlas Search indexes in Compass if your deployment is +- You can manage Atlas Search indexes in |compass-short| if your deployment is local, has an Atlas cluster tier of M10 or larger, and runs MongoDB 7.0 or higher. diff --git a/source/install/verify-signatures.txt b/source/install/verify-signatures.txt index b17ee5076..ae49f15aa 100644 --- a/source/install/verify-signatures.txt +++ b/source/install/verify-signatures.txt @@ -1,8 +1,8 @@ .. _verify-signatures-compass: -==================================== -Verify Integrity of Compass Packages -==================================== +============================================ +Verify Integrity of |compass-short| Packages +============================================ .. contents:: On this page :local: diff --git a/source/query-with-natural-language/ai-and-data-usage-information.txt b/source/query-with-natural-language/ai-and-data-usage-information.txt index be193d80c..b7cac9538 100644 --- a/source/query-with-natural-language/ai-and-data-usage-information.txt +++ b/source/query-with-natural-language/ai-and-data-usage-information.txt @@ -9,7 +9,7 @@ AI and Data Usage Information :backlinks: none :depth: 1 -Querying with natural language in Compass is powered by Generative AI +Querying with natural language in |compass-short| is powered by Generative AI (Gen AI), and may give inaccurate responses. See our `Generative AI FAQ `__ for more information about Gen AI in MongoDB products. @@ -17,14 +17,14 @@ for more information about Gen AI in MongoDB products. Third Party Providers --------------------- -Querying with natural language in Compass currently uses the `Azure OpenAI Service -`__ +Querying with natural language in |compass-short| currently uses the +`Azure OpenAI Service `__ hosted by Microsoft. This is subject to change in the future. How Your Data is Used --------------------- -When you query with natural language in Compass, the following +When you query with natural language in |compass-short|, the following information is sent to MongoDB's backend and/or the third party AI provider: @@ -51,7 +51,7 @@ connection strings, credentials, or rows/documents from your databases. Disable Natural Language Querying --------------------------------- -- Natural language querying in Compass is available if you have +- Natural language querying in |compass-short| is available if you have enabled the :ref:`Generative AI setting ` and logged into Atlas. - If you no longer want to use the feature, uncheck diff --git a/source/query-with-natural-language/enable-natural-language-querying.txt b/source/query-with-natural-language/enable-natural-language-querying.txt index 6e078a004..4f454ea11 100644 --- a/source/query-with-natural-language/enable-natural-language-querying.txt +++ b/source/query-with-natural-language/enable-natural-language-querying.txt @@ -11,7 +11,7 @@ Enable Natural Language Querying :backlinks: none :depth: 1 -You can enable Compass natural language querying by toggling the +You can enable |compass-short| natural language querying by toggling the :guilabel:`Use Generative AI` setting. Natural language queries can be a helpful starting point and assist you in learning to write MongoDB queries. @@ -19,18 +19,18 @@ queries. About this Task --------------- -To enable natural language querying in Compass, follow the steps below. +To enable natural language querying in |compass-short|, follow the steps below. Alternatively, you can enable natural language querying by clicking the :guilabel:`Log in to Atlas to enable` button within the :guilabel:`Use natural language to generate queries and pipelines` modal. -You can display this modal on Compass versions 1.40.0 or later when +You can display this modal on |compass-short| versions 1.40.0 or later when you click the :guilabel:`Generate query` or :guilabel:`Generate aggregation` button on the query bar. Before you Begin ---------------- -To enable the generation of queries and aggregations in Compass, +To enable the generation of queries and aggregations in |compass-short|, you must: - Sign into Atlas. For details on how to get a free Atlas @@ -94,8 +94,7 @@ Steps .. step:: (Optional) Read MongoDB's GenAI FAQs - For more information about generative AI usage with MongoDB - Compass, see: + For more information about generative AI usage with |compass|, see: - :ref:`compass-ai-data-usage` - `FAQ For MongoDB Generative AI Features `__ 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 c4b57da25..84a0ad198 100644 --- a/source/query-with-natural-language/prompt-natural-language-aggregation.txt +++ b/source/query-with-natural-language/prompt-natural-language-aggregation.txt @@ -11,8 +11,8 @@ Prompt a Natural Language Aggregation :backlinks: none :depth: 1 -You can use MongoDB Compass to generate aggregation queries using natural -language. Compass uses AI to generate aggregations based on prompts +You can use |compass| to generate aggregation queries using natural +language. |compass-short| uses AI to generate aggregations based on prompts you provide. Querying with natural language can be a helpful starting point and assist you in learning to write MongoDB queries. @@ -34,7 +34,7 @@ About this Task Before you Begin ---------------- -You must :ref:`enable natural language querying in Compass`. +You must :ref:`enable natural language querying in Compass `. Steps ----- diff --git a/source/query-with-natural-language/prompt-natural-language-query.txt b/source/query-with-natural-language/prompt-natural-language-query.txt index 1631034b6..dbe18d9e0 100644 --- a/source/query-with-natural-language/prompt-natural-language-query.txt +++ b/source/query-with-natural-language/prompt-natural-language-query.txt @@ -11,8 +11,8 @@ Prompt a Natural Language Query :backlinks: none :depth: 1 -You can use MongoDB Compass to generate queries using natural -language. Compass uses AI to generate queries based on prompts +You can use |compass| to generate queries using natural +language. |compass-short| uses AI to generate queries based on prompts you provide. Querying with natural language can be a helpful starting point and assist you in learning to write MongoDB queries. diff --git a/source/query-with-natural-language/query-with-natural-language.txt b/source/query-with-natural-language/query-with-natural-language.txt index 5a3a7d6f8..4fd49a9c8 100644 --- a/source/query-with-natural-language/query-with-natural-language.txt +++ b/source/query-with-natural-language/query-with-natural-language.txt @@ -11,14 +11,14 @@ Query with Natural Language :backlinks: none :depth: 2 -You can use MongoDB Compass to ask natural language questions about your -data. Compass uses AI to generate filter queries and aggregations based +You can use |compass| to ask natural language questions about your +data. |compass-short| uses AI to generate filter queries and aggregations based on the prompts you provide. Use Cases --------- -You may want to use natural language to query in Compass to: +You may want to use natural language to query in |compass-short| to: - Ask plain text questions about your data. - Create an initial query or aggregation pipeline that you can @@ -28,7 +28,7 @@ You may want to use natural language to query in Compass to: Behavior -------- -- Compass natural language querying is available starting in version +- |compass-short| natural language querying is available starting in version ``1.40.x``. - Natural language querying utilizes `Azure Open AI @@ -36,7 +36,7 @@ Behavior as its current provider. This provider may be subject to change in the future. -- The MongoDB Compass natural language querying feature is on a rolling +- The |compass| natural language querying feature is on a rolling release schedule. As a result, some users may temporarily have functionality that other users do not. @@ -50,7 +50,7 @@ Get Started Details ------- -When you query your data using natural language in Compass, the text of +When you query your data using natural language in |compass-short|, the text of your prompts and details about your MongoDB schemas are sent to Microsoft and OpenAI for processing. Your data is not stored on any third party storage systems or used to train AI models. diff --git a/source/query/filter.txt b/source/query/filter.txt index 11bd7dd15..d894f2a24 100644 --- a/source/query/filter.txt +++ b/source/query/filter.txt @@ -422,7 +422,7 @@ in the MongoDB manual. Supported Data Types in the Query Bar ------------------------------------- -The Compass :guilabel:`Filter` supports using the +The |compass-short| :guilabel:`Filter` supports using the :binary:`~bin.mongosh` representation of the MongoDB Extended JSON :manual:`BSON data types `. @@ -437,11 +437,11 @@ Extended JSON :manual:`BSON data types `_, instead of comparing the values chronologically. @@ -461,8 +461,8 @@ Query Collections with Invalid UTF8 Data .. END-COMPASS-ONLY -How Does the Compass Query Compare to MongoDB and SQL Queries? --------------------------------------------------------------- +How Does the |compass-short| Query Compare to MongoDB and SQL Queries? +---------------------------------------------------------------------- :expression:`$filter` corresponds to the ``WHERE`` clause in a |sql| ``SELECT`` statement. @@ -472,7 +472,7 @@ How Does the Compass Query Compare to MongoDB and SQL Queries? You have 3,235 articles. You would like to see all articles that Joe Bloggs wrote. - Compass Filter Option + |compass-short| Filter Option .. code-block:: javascript { author : { $eq : "Joe Bloggs" } } diff --git a/source/query/limit.txt b/source/query/limit.txt index 67f978431..916bc688a 100644 --- a/source/query/limit.txt +++ b/source/query/limit.txt @@ -31,8 +31,8 @@ Clear the Query .. include:: /includes/clear-query.rst -How Does the Compass Query Compare to MongoDB and SQL Queries? --------------------------------------------------------------- +How Does the |compass-short| Query Compare to MongoDB and SQL Queries? +---------------------------------------------------------------------- :pipeline:`$skip` corresponds to the ``LIMIT ...`` clause in a |sql| ``SELECT`` statement. @@ -55,7 +55,7 @@ in a |sql| ``SELECT`` statement. { $limit : 10 } ); - Compass Limit Option + |compass-short| Limit Option .. code-block:: javascript $limit : 10 diff --git a/source/query/project.txt b/source/query/project.txt index 17efbdabe..aaf0305d8 100644 --- a/source/query/project.txt +++ b/source/query/project.txt @@ -50,8 +50,8 @@ To set a projection: .. include:: /includes/extracts/query-bar-results.rst -How Does the Compass Query Compare to MongoDB and SQL Queries? --------------------------------------------------------------- +How Does the |compass-short| Query Compare to MongoDB and SQL Queries? +---------------------------------------------------------------------- :pipeline:`$project` corresponds to choosing specific fields to return in a |sql| ``SELECT`` statement. @@ -73,7 +73,7 @@ in a |sql| ``SELECT`` statement. { $project : { headline : 1, author : 1 } } ); - Compass Project Option + |compass-short| Project Option .. code-block:: javascript { headline : 1, author : 1 } diff --git a/source/query/queries.txt b/source/query/queries.txt index f7b505d49..94adc79c3 100644 --- a/source/query/queries.txt +++ b/source/query/queries.txt @@ -64,10 +64,10 @@ once connected to your cluster. Using the :guilabel:`My Queries` Tab ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -When you click a saved or favorite query tile, Compass opens the +When you click a saved or favorite query tile, |compass-short| opens the :guilabel:`Documents` tab with the filter loaded. -When you click a saved or favorite pipeline tile, Compass opens the +When you click a saved or favorite pipeline tile, |compass-short| opens the :guilabel:`Aggregations` tab with the pipeline loaded. .. _compass-saved-favorite-query-view: diff --git a/source/query/skip.txt b/source/query/skip.txt index 840ee25c4..6a2b37c81 100644 --- a/source/query/skip.txt +++ b/source/query/skip.txt @@ -35,8 +35,8 @@ Clear the Query .. include:: /includes/clear-query.rst -How Does the Compass Query Compare to MongoDB and SQL Queries? --------------------------------------------------------------- +How Does the |compass-short| Query Compare to MongoDB and SQL Queries? +---------------------------------------------------------------------- :pipeline:`$skip` corresponds to the ``LIMIT ... OFFSET ...`` clause in a |sql| ``SELECT`` statement. @@ -60,7 +60,7 @@ in a |sql| ``SELECT`` statement. { $skip : 435 } ); - Compass Skip Option + |compass-short| Skip Option .. code-block:: javascript $skip : 435 diff --git a/source/query/sort.txt b/source/query/sort.txt index 75cc29e15..2c6adfbc5 100644 --- a/source/query/sort.txt +++ b/source/query/sort.txt @@ -64,8 +64,8 @@ Clear the Query .. include:: /includes/clear-query.rst -How Does the Compass Query Compare to MongoDB and SQL Queries? --------------------------------------------------------------- +How Does the |compass-short| Query Compare to MongoDB and SQL Queries? +---------------------------------------------------------------------- :pipeline:`$sort` corresponds to the ``ORDER BY ...`` clause @@ -89,7 +89,7 @@ in a |sql| ``SELECT`` statement. { $sort : { headline : 1 } } ); - Compass Sort Option + |compass-short| Sort Option .. code-block:: javascript $sort : { headline : 1 } diff --git a/source/schema.txt b/source/schema.txt index f60df8ebd..42fb8dfa4 100644 --- a/source/schema.txt +++ b/source/schema.txt @@ -43,7 +43,7 @@ percentage of each data type represented. - The ``_id`` field is an :manual:`ObjectId `. - Each ObjectId contains a timestamp, so Compass displays the range + Each ObjectId contains a timestamp, so |compass-short| displays the range of creation times for the sampled documents. - The ``address`` field contains four nested fields. You @@ -52,7 +52,7 @@ percentage of each data type represented. - The ``borough`` field contains a string indicating the borough in which the restaurant is located. The cardinality is low enough - that Compass can provide a graded bar of the field contents, with + that |compass-short| can provide a graded bar of the field contents, with the most-frequently occurring string on the left. - The ``grades`` field contains arrays of strings. The analysis @@ -86,9 +86,9 @@ particular fields to display and the number of results to return. Field Descriptions ------------------ -For each field, Compass displays summary information about the data +For each field, |compass-short| displays summary information about the data type or types the field contains and the range of values. Depending -on the data type and the level of cardinality, Compass displays +on the data type and the level of cardinality, |compass-short| displays histograms, graded bars, geographical maps, and sample data to provide a sense of the shape and scope of the data contained in each field. @@ -106,7 +106,7 @@ Field with Multiple Data Types ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For fields that contain multiple data types, -Compass displays a percentage breakdown of +|compass-short| displays a percentage breakdown of the various data types across documents. In the example below, the chart shows the contents of a field called ``phone_no`` in which 81% of documents are of type ``string``, and the remaining 19% are of @@ -132,7 +132,7 @@ Strings ~~~~~~~ Strings can appear in three different ways. If there are -entirely unique strings in a field, Compass shows a random +entirely unique strings in a field, |compass-short| shows a random selection of string values from the specified field. Click the circular refresh icon to see a new set of randomly selected values from the field. @@ -142,7 +142,7 @@ a new set of randomly selected values from the field. :alt: Example of string data types If there are only a few different string values, -Compass shows the strings in a single graded bar which +|compass-short| shows the strings in a single graded bar which shows the percentage of the population of the string values. .. figure:: /images/compass/string-sample2.png @@ -150,7 +150,7 @@ shows the percentage of the population of the string values. :alt: Example of few string data types If there are multiple string values with some duplicates, -Compass shows a histogram indicating the frequency of +|compass-short| shows a histogram indicating the frequency of each string found within the field. .. figure:: /images/compass/string-sample3.png @@ -250,7 +250,7 @@ Query Builder ------------- In the :guilabel:`Schema` tab, you can type the filter manually into -the query bar or generate the filter with the Compass query builder. +the query bar or generate the filter with the |compass-short| query builder. The query builder allows you to select data elements from one or more fields in your schema and construct a query matching the selected elements. diff --git a/source/settings/command-line-options.txt b/source/settings/command-line-options.txt index 38e7d6fb7..16a9a5f33 100644 --- a/source/settings/command-line-options.txt +++ b/source/settings/command-line-options.txt @@ -23,8 +23,8 @@ When you use the command line to set configuration options, the options are set at startup. Settings configured using command line options cannot be modified on the |compass-short| interface. -Compass Executable Location ---------------------------- +|compass-short| Executable Location +----------------------------------- .. include:: /includes/compass-executable.rst @@ -74,10 +74,10 @@ configuration file. - Provides an example |compass-short| configuration file. * - .. option:: --trustedConnectionString - - Suppresses warnings about disallowed connection string properties and allows - automatic connection. Compass inspects the connection string passed in the - command line, and verifies whether the connection string contains parameters - that can result in a security risk. + - Suppresses warnings about disallowed connection string properties and + allows automatic connection. |compass-short| inspects the connection + string passed in the command line, and verifies whether the connection + string contains parameters that can result in a security risk. Only set this option if you pass a known trusted connection string to |compass-short|. @@ -158,8 +158,8 @@ value in the :guilabel:`Settings` panel. To learn more, see :ref:`compass-configure-network-traffic`. * - .. option:: --password - - Specifies a password for authentication to Compass and the MongoDB - deployment provided in the connection string. + - Specifies a password for authentication to |compass-short| and the + MongoDB deployment provided in the connection string. Use in conjunction with :option:`--username`. @@ -216,8 +216,8 @@ value in the :guilabel:`Settings` panel. To learn more, see :ref:`compass-telemetry`. * - .. option:: --username - - Specifies a username for authentication to Compass and the MongoDB - deployment provided in the connection string + - Specifies a username for authentication to |compass-short| and the + MongoDB deployment provided in the connection string Optionally, use in conjuction with :option:`--password`. diff --git a/source/settings/settings-reference.txt b/source/settings/settings-reference.txt index d4f3b782c..98982b424 100644 --- a/source/settings/settings-reference.txt +++ b/source/settings/settings-reference.txt @@ -183,8 +183,9 @@ You can configure the following settings on the |compass| interface: * - Enable AI Features - Artificial Intelligence - - Enables :ref:`natural language querying ` and allows - the use of AI features in Compass which make requests to 3rd party services. + - Enables :ref:`natural language querying ` + and allows the use of AI features in |compass-short| which make requests + to 3rd party services. * - Enable sending sample field values - Artificial Intelligence diff --git a/source/troubleshooting/connection-errors.txt b/source/troubleshooting/connection-errors.txt index cbb2f03da..ce0abec74 100644 --- a/source/troubleshooting/connection-errors.txt +++ b/source/troubleshooting/connection-errors.txt @@ -1,8 +1,8 @@ .. _compass-connection-errors: -========================= -Compass Connection Errors -========================= +================================= +|compass-short| Connection Errors +================================= .. default-domain:: mongodb @@ -18,7 +18,7 @@ The sections on this page list common errors seen when connecting to MongoDB Not Running on the Provided Host and Port ------------------------------------------------- -Your connection failed when Compass attempted to connect to your +Your connection failed when |compass-short| attempted to connect to your database on the specified host and port. Likely Causes @@ -181,17 +181,17 @@ replica set name using the following procedure: .. include:: /includes/fact-get-replica-set-name-steps.rst -Check Your Compass Edition -`````````````````````````` +Check Your |compass-short| Edition +`````````````````````````````````` You cannot perform write operations in :guilabel:`Compass Readonly` -edition. You can check your Compass edition by opening the -top-level Compass dropdown menu and selecting +edition. You can check your |compass-short| edition by opening the +top-level |compass-short| dropdown menu and selecting :guilabel:`About MongoDB Compass`. To perform write operations, you must download a different edition -of MongoDB Compass. For more information on the differences between -Compass editions, see +of |compass|. For more information on the differences between +|compass-short| editions, see :ref:`Capabilities of Compass Editions `. Connection to Cluster Shard Closed @@ -271,8 +271,8 @@ replica set name using the following procedure: .. include:: /includes/fact-get-replica-set-name-steps.rst -Allow Compass to Connect to the Secondary -````````````````````````````````````````` +Allow |compass-short| to Connect to the Secondary +````````````````````````````````````````````````` Another approach to resolving this error is to allow |compass-short| to connect to a secondary cluster member. Change your :guilabel:`Read Preference` to either :guilabel:`Primary Preferred` or @@ -339,8 +339,8 @@ Solutions - Verify that your selected authentication mechanism is supported by your MongoDB database. -Check the Compass Logs ----------------------- +Check the |compass-short| Logs +------------------------------ The |compass-short| logs can provide additional information on connection errors. You may find more detailed error messages to help diff --git a/source/troubleshooting/logs.txt b/source/troubleshooting/logs.txt index 22f723cda..36a93b15b 100644 --- a/source/troubleshooting/logs.txt +++ b/source/troubleshooting/logs.txt @@ -1,8 +1,8 @@ .. _compass-logs: -===================== -Retrieve Compass Logs -===================== +============================= +Retrieve |compass-short| Logs +============================= .. default-domain:: mongodb @@ -20,8 +20,8 @@ help diagnose errors. |compass| redacts credentials from the logs. -View Compass Logs ------------------ +View |compass-short| Logs +------------------------- .. procedure:: :style: normal @@ -42,8 +42,8 @@ View Compass Logs - Extract the log file and view it as a text file. -Compass Log Location --------------------- +|compass-short| Log Location +---------------------------- |compass-short| maintains one log file per session, compressed into a gzip archive file. The corresponding session ID is included in the log diff --git a/source/validation.txt b/source/validation.txt index f3c36bee0..e151a54f7 100644 --- a/source/validation.txt +++ b/source/validation.txt @@ -35,7 +35,7 @@ Validation Rules The validation editor supports :manual:`JSON Schema validation `, and validation with query expressions using :manual:`query operators `. -After you click the :guilabel:`Update` button, Compass updates to +After you click the :guilabel:`Update` button, |compass-short| updates to display a document from your collection that passes the validation and a document that fails. diff --git a/source/views.txt b/source/views.txt index e1e4be278..2de0ecfb0 100644 --- a/source/views.txt +++ b/source/views.txt @@ -1,9 +1,9 @@ .. _compass-view-details: .. _compass-views: -======================= -Manage Views in Compass -======================= +=============================== +Manage Views in |compass-short| +=============================== .. default-domain:: mongodb From fabfd22218d1fcf974b47f84ac6945be0223938c Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Tue, 26 Nov 2024 14:32:23 -0500 Subject: [PATCH 2/6] revert connect pages --- source/connect/connect-from-the-command-line.txt | 16 ++++++++-------- source/connect/connections.txt | 8 ++++---- source/connect/disconnect.txt | 4 ++-- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/source/connect/connect-from-the-command-line.txt b/source/connect/connect-from-the-command-line.txt index 111a85ba0..1f07fc5c0 100644 --- a/source/connect/connect-from-the-command-line.txt +++ b/source/connect/connect-from-the-command-line.txt @@ -1,8 +1,8 @@ .. _comp-command-line-connect: -=========================================== -Start |compass-short| from the Command Line -=========================================== +=================================== +Start Compass from the Command Line +=================================== .. default-domain:: mongodb @@ -27,8 +27,8 @@ the command line. .. _compass-executable-location: -|compass-short| Executable Location ------------------------------------ +Compass Executable Location +--------------------------- .. include:: /includes/compass-executable.rst @@ -51,7 +51,7 @@ the configuration file. The format is: .. note:: - If the username and password arguments are not provided, |compass-short| uses + If the username and password arguments are not provided, Compass uses the credentials in the connection string. @@ -71,7 +71,7 @@ Username and Password Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This example uses the ``username`` and ``password`` parameters to -authenticate |compass-short| to the MongoDB deployment provided in the +authenticate Compass to the MongoDB deployment provided in the connection string: .. code-block:: shell @@ -106,7 +106,7 @@ The components of the command invocation are: To create the connection configuration file, follow the steps to :ref:`export the connection details ` -from your |compass-short| instance. The export process creates a file that +from your Compass instance. The export process creates a file that includes all of your favorite connections. .. important:: diff --git a/source/connect/connections.txt b/source/connect/connections.txt index 4ccd1cd3c..31aec6049 100644 --- a/source/connect/connections.txt +++ b/source/connect/connections.txt @@ -17,7 +17,7 @@ Connections Sidebar .. include:: /includes/multiple-connections.rst -The :guilabel:`Connections Sidebar` on the left of the |compass-short| window +The :guilabel:`Connections Sidebar` on the left of the Compass window contains the following options: - :icon-lg:`Plus` icon to add new connections @@ -42,15 +42,15 @@ Connect to MongoDB To connect to a saved or favorite deployment, click the name of the connection in the :guilabel:`Connections` list. Once you connect, -|compass-short| shows a success toast and displays a green dot next to the +Compass shows a success toast and displays a green dot next to the connection name. -If a connection error occurs, |compass-short| shows a toast with error +If a connection error occurs, Compass shows a toast with error information and displays a red triangle next to the connection name. To see additional error information, click :guilabel:`Review` in the error toast. -To add a new connection to |compass-short|, click the :icon-lg:`Plus` button at +To add a new connection to Compass, click the :icon-lg:`Plus` button at the top of the :guilabel:`Connections Sidebar` to open the :guilabel:`New Connection` modal. For more information, see :ref:`connect-run-compass`. diff --git a/source/connect/disconnect.txt b/source/connect/disconnect.txt index 86f1548d7..b1b09ff3b 100644 --- a/source/connect/disconnect.txt +++ b/source/connect/disconnect.txt @@ -6,8 +6,8 @@ Disconnect from MongoDB .. default-domain:: mongodb -Disconnecting from a MongoDB deployment closes the |compass-short| connection to -the active deployment and returns the |compass-short| view to the initial +Disconnecting from a MongoDB deployment closes the Compass connection to +the active deployment and returns the Compass view to the initial connection dialog. Steps From ff403abb662f9f918ae4ea169c9e254253829db3 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Tue, 26 Nov 2024 14:41:27 -0500 Subject: [PATCH 3/6] revert pages from connect - install --- source/connect.txt | 6 ++--- .../import-export-cli/export.txt | 4 ++-- .../import-export-cli/import.txt | 8 +++---- source/connect/required-access.txt | 2 +- source/editions.txt | 6 ++--- source/faq.txt | 22 +++++++++---------- source/import-export.txt | 4 ++-- source/in-use-encryption-tutorial.txt | 6 ++--- source/includes/atlas-sample-data-note.rst | 2 +- .../includes/fact-natural-language-query.rst | 2 +- ...ct-natural-language-querying-maxTimems.rst | 2 +- .../intro-advanced-connection-options.rst | 6 ++--- source/includes/multiple-connections.rst | 2 +- source/install/verify-signatures.txt | 6 ++--- 14 files changed, 39 insertions(+), 39 deletions(-) diff --git a/source/connect.txt b/source/connect.txt index 952d74a2d..4210ddca7 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -58,7 +58,7 @@ Connect ------- If your connection name is already in the :guilabel:`Connections -Sidebar` of your |compass-short| window, click on the connection name to +Sidebar` of your Compass window, click on the connection name to connect. Otherwise, you can connect your deployments by either: @@ -103,8 +103,8 @@ Use Advanced Connection Options For details, see :ref:`advanced-connection-options`. -Connect to |compass-short| from the Command Line ------------------------------------------------- +Connect to Compass from the Command Line +---------------------------------------- .. include:: /includes/intro-command-line-connection.rst diff --git a/source/connect/favorite-connections/import-export-cli/export.txt b/source/connect/favorite-connections/import-export-cli/export.txt index e3159f088..552e24c23 100644 --- a/source/connect/favorite-connections/import-export-cli/export.txt +++ b/source/connect/favorite-connections/import-export-cli/export.txt @@ -60,7 +60,7 @@ This example exports saved |compass-short| connections to a file with the path ``/tmp/compass-connections/favorites-encrypted.json``. The exported file is encrypted with the passphrase ``abc123``. -Run the following command in the folder containing your |compass| +Run the following command in the folder containing your MongoDB Compass executable: .. code-block:: sh @@ -167,7 +167,7 @@ Example This example exports saved |compass-short| connections to a file with the path ``/tmp/compass-connections/favorites.json``. -Run the following command in the folder containing your |compass| +Run the following command in the folder containing your MongoDB Compass executable: .. code-block:: sh diff --git a/source/connect/favorite-connections/import-export-cli/import.txt b/source/connect/favorite-connections/import-export-cli/import.txt index 42747181e..2c527c5e5 100644 --- a/source/connect/favorite-connections/import-export-cli/import.txt +++ b/source/connect/favorite-connections/import-export-cli/import.txt @@ -62,7 +62,7 @@ a file with the path ``/tmp/compass-connections/favorites-encrypted.json`` that is encrypted with the passphrase ``abc123``. -Run the following command in the folder containing your |compass| +Run the following command in the folder containing your MongoDB Compass executable: .. code-block:: sh @@ -86,7 +86,7 @@ After you run the import command, you will see this output: Importing connections from "/tmp/compass-connections/favorites-encrypted.json" (with passphrase) -|compass| starts and you will see the imported connections under +MongoDB Compass starts and you will see the imported connections under :guilabel:`Saved Connections` on the Connect screen. Errors @@ -141,7 +141,7 @@ Example The following example imports saved |compass-short| connections from a file with the path ``/tmp/compass-connections/favorites.json``. -Run the following command in the folder containing your |compass| +Run the following command in the folder containing your MongoDB Compass executable: .. code-block:: sh @@ -163,5 +163,5 @@ After you run the import command, you will see this output: Importing connections from "/tmp/compass-connections/favorites.json" (without passphrase) -|compass| starts and you will see the imported connections under +MongoDB Compass starts and you will see the imported connections under :guilabel:`Saved Connections` on the Connect screen. diff --git a/source/connect/required-access.txt b/source/connect/required-access.txt index 9106cd5f6..ef3d7ad98 100644 --- a/source/connect/required-access.txt +++ b/source/connect/required-access.txt @@ -18,7 +18,7 @@ privileges: :header-rows: 1 :widths: 25 30 25 20 - * - |compass-short| View + * - Compass View - Capability - Privilege(s) - MongoDB Built-In Role diff --git a/source/editions.txt b/source/editions.txt index 5e5c324b2..2decae2ad 100644 --- a/source/editions.txt +++ b/source/editions.txt @@ -12,9 +12,9 @@ suit your needs. :widths: 40 15 15 15 * - - - |compass-short| - - |compass-short| Readonly - - |compass-short| Isolated + - Compass + - Compass Readonly + - Compass Isolated * - Interact with :ref:`documents `, :ref:`collections `, and diff --git a/source/faq.txt b/source/faq.txt index 8f51768cc..600d89271 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -14,8 +14,8 @@ FAQ .. _compass-faq-isolated: -What is the |compass-short| Isolated Edition? ---------------------------------------------- +What is the Compass Isolated Edition? +------------------------------------- .. include:: /includes/fact-isolated-edition-firewall.rst @@ -31,8 +31,8 @@ database to avoid scanning the entire collection. .. _compass-faq-confidential-data: -How does |compass-short| handle confidential data? --------------------------------------------------- +How does Compass handle confidential data? +------------------------------------------ |compass| stores and retrieves sensitive data such as passwords using a credentials API specific to the operating system running @@ -55,8 +55,8 @@ how Keytar operates and the specific APIs it accesses, refer to the .. _compass-faq-logs: -Does |compass-short| Maintain Logs? ------------------------------------ +Does Compass Maintain Logs? +--------------------------- As part of normal operation, |compass| maintains a running log of events. |compass-short| logs provide a history of operations and can @@ -73,16 +73,16 @@ Why am I seeing a warning about a non-genuine MongoDB server? What happens to long running queries? ------------------------------------- -As a precaution, |compass-short| aborts long running queries to prevent +As a precaution, Compass aborts long running queries to prevent excessive querying on your database. Slow Sampling ~~~~~~~~~~~~~ -All queries that |compass-short| sends to your MongoDB instance have a timeout +All queries that Compass sends to your MongoDB instance have a timeout flag set which automatically aborts a request if it takes longer than the specified timeout. This timeout is currently set to 10 seconds. If -:ref:`sampling ` on the database takes longer, |compass-short| +:ref:`sampling ` on the database takes longer, Compass will notify you about the timeout and give you the options of (a) retrying with a longer timeout (60 seconds) or (b) running a different query. @@ -101,7 +101,7 @@ Slow Schema Analysis If the database returns documents faster than the specified timeout (10 or 60 seconds), but the schema analysis of the documents takes longer -than expected (due to complex, large documents), |compass-short| gives you the +than expected (due to complex, large documents), Compass gives you the option to abort the analysis step and show the partial results. Why are some features of |compass| not working? @@ -121,7 +121,7 @@ external services to enable features such as: To fix this issue, configure your system firewall to allow incoming connections for |compass|. Ensure ports ``80`` and ``443`` are open between |compass| and the host for the MongoDB deployment to which -|compass-short| connects. +Compass connects. .. include:: /includes/fact-isolated-edition-firewall.rst diff --git a/source/import-export.txt b/source/import-export.txt index 715c664f5..eed164e84 100644 --- a/source/import-export.txt +++ b/source/import-export.txt @@ -33,7 +33,7 @@ clicking the collection in the left-side navigation. .. note:: - |compass-short| is not a tool for backing up data. For information on backup + Compass is not a tool for backing up data. For information on backup solutions, see :ref:`backup-methods`. .. _import-data: @@ -133,7 +133,7 @@ during import, the progress bar turns red and an error message appears in the dialog. To see all errors, click :guilabel:`View Log`. After successful import, the dialog closes and -|compass-short| displays the collection page containing the newly imported +Compass displays the collection page containing the newly imported documents. .. _export-data-collection: diff --git a/source/in-use-encryption-tutorial.txt b/source/in-use-encryption-tutorial.txt index 4dcc9eea3..80f143a84 100644 --- a/source/in-use-encryption-tutorial.txt +++ b/source/in-use-encryption-tutorial.txt @@ -37,9 +37,9 @@ Requirements and Limitations - You need a replica set to use this connection option. Your replica set can be a single node or larger. -- You need to connect to your deployment on |compass-short| using In-Use - Encryption. For more information on how to connect to your deployment, see - :ref:`In-Use Encryption Connection tab `. +- You need to connect to your deployment on Compass using In-Use Encryption. For + more information on how to connect to your deployment, see :ref:`In-Use Encryption + Connection tab `. Create Your Encrypted Collection -------------------------------- diff --git a/source/includes/atlas-sample-data-note.rst b/source/includes/atlas-sample-data-note.rst index 441138bad..8e92ac9fe 100644 --- a/source/includes/atlas-sample-data-note.rst +++ b/source/includes/atlas-sample-data-note.rst @@ -1,4 +1,4 @@ -.. note:: Try |compass-short| with Sample Data +.. note:: Try Compass with Sample Data `MongoDB Atlas `__ is a cloud-hosted database-as-a-service that diff --git a/source/includes/fact-natural-language-query.rst b/source/includes/fact-natural-language-query.rst index dd38a0232..6b17a3d09 100644 --- a/source/includes/fact-natural-language-query.rst +++ b/source/includes/fact-natural-language-query.rst @@ -1,4 +1,4 @@ -When you query your data using natural language in |compass-short|, the text of +When you query your data using natural language in Compass, the text of your prompts and details about your MongoDB schemas are sent to Microsoft and OpenAI for processing. Your data is not stored on any third party storage systems or used to train AI models. diff --git a/source/includes/fact-natural-language-querying-maxTimems.rst b/source/includes/fact-natural-language-querying-maxTimems.rst index 839995088..829b618f2 100644 --- a/source/includes/fact-natural-language-querying-maxTimems.rst +++ b/source/includes/fact-natural-language-querying-maxTimems.rst @@ -1,5 +1,5 @@ It can be difficult to predict the complexity of the query or pipeline -returned by the |compass-short| AI. You may need to adjust the +returned by the Compass AI. You may need to adjust the :guilabel:`MAX TIME MS` query bar option to either allow longer query processing time or prevent long-running queries. For details, see :ref:`compass-query-bar-max-time-ms`. \ No newline at end of file diff --git a/source/includes/intro-advanced-connection-options.rst b/source/includes/intro-advanced-connection-options.rst index bfaf1a434..2372b0c7b 100644 --- a/source/includes/intro-advanced-connection-options.rst +++ b/source/includes/intro-advanced-connection-options.rst @@ -1,3 +1,3 @@ -The advanced connection options provide additional ways to connect -|compass-short| to MongoDB. Advanced connection options allow you to specify -authentication, TLS/SSL, and SSH to securely connect to your deployment. +The advanced connection options provide additional ways to connect Compass +to MongoDB. Advanced connection options allow you to specify authentication, +TLS/SSL, and SSH to securely connect to your deployment. diff --git a/source/includes/multiple-connections.rst b/source/includes/multiple-connections.rst index 2a604e499..3119a217f 100644 --- a/source/includes/multiple-connections.rst +++ b/source/includes/multiple-connections.rst @@ -1,2 +1,2 @@ Starting in version 1.44.0, you can connect to multiple MongoDB -instances at once through |compass-short|. \ No newline at end of file +instances at once through Compass. \ No newline at end of file diff --git a/source/install/verify-signatures.txt b/source/install/verify-signatures.txt index ae49f15aa..b17ee5076 100644 --- a/source/install/verify-signatures.txt +++ b/source/install/verify-signatures.txt @@ -1,8 +1,8 @@ .. _verify-signatures-compass: -============================================ -Verify Integrity of |compass-short| Packages -============================================ +==================================== +Verify Integrity of Compass Packages +==================================== .. contents:: On this page :local: From 22fca29fe3c42edfc59418b3470b7bda0c35577b Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Tue, 26 Nov 2024 14:58:52 -0500 Subject: [PATCH 4/6] * --- .../fact-viewing-favorite-queries.rst | 2 +- source/settings/command-line-options.txt | 20 ++++++------- source/settings/settings-reference.txt | 2 +- source/troubleshooting/connection-errors.txt | 28 +++++++++---------- source/troubleshooting/logs.txt | 14 +++++----- 5 files changed, 33 insertions(+), 33 deletions(-) diff --git a/source/includes/fact-viewing-favorite-queries.rst b/source/includes/fact-viewing-favorite-queries.rst index 0c438a1f0..4b557a4e7 100644 --- a/source/includes/fact-viewing-favorite-queries.rst +++ b/source/includes/fact-viewing-favorite-queries.rst @@ -36,5 +36,5 @@ Clicking the :icon-lg:`OpenNewTab` icon opens the bulk update statement and the filter criteria in the :guilabel:`Update Documents` modal. For details on bulk - update statements in |compass-short|, see + update statements in Compass, see :ref:`compass-bulk-update`. diff --git a/source/settings/command-line-options.txt b/source/settings/command-line-options.txt index 16a9a5f33..38e7d6fb7 100644 --- a/source/settings/command-line-options.txt +++ b/source/settings/command-line-options.txt @@ -23,8 +23,8 @@ When you use the command line to set configuration options, the options are set at startup. Settings configured using command line options cannot be modified on the |compass-short| interface. -|compass-short| Executable Location ------------------------------------ +Compass Executable Location +--------------------------- .. include:: /includes/compass-executable.rst @@ -74,10 +74,10 @@ configuration file. - Provides an example |compass-short| configuration file. * - .. option:: --trustedConnectionString - - Suppresses warnings about disallowed connection string properties and - allows automatic connection. |compass-short| inspects the connection - string passed in the command line, and verifies whether the connection - string contains parameters that can result in a security risk. + - Suppresses warnings about disallowed connection string properties and allows + automatic connection. Compass inspects the connection string passed in the + command line, and verifies whether the connection string contains parameters + that can result in a security risk. Only set this option if you pass a known trusted connection string to |compass-short|. @@ -158,8 +158,8 @@ value in the :guilabel:`Settings` panel. To learn more, see :ref:`compass-configure-network-traffic`. * - .. option:: --password - - Specifies a password for authentication to |compass-short| and the - MongoDB deployment provided in the connection string. + - Specifies a password for authentication to Compass and the MongoDB + deployment provided in the connection string. Use in conjunction with :option:`--username`. @@ -216,8 +216,8 @@ value in the :guilabel:`Settings` panel. To learn more, see :ref:`compass-telemetry`. * - .. option:: --username - - Specifies a username for authentication to |compass-short| and the - MongoDB deployment provided in the connection string + - Specifies a username for authentication to Compass and the MongoDB + deployment provided in the connection string Optionally, use in conjuction with :option:`--password`. diff --git a/source/settings/settings-reference.txt b/source/settings/settings-reference.txt index 98982b424..9c16b5130 100644 --- a/source/settings/settings-reference.txt +++ b/source/settings/settings-reference.txt @@ -184,7 +184,7 @@ You can configure the following settings on the |compass| interface: * - Enable AI Features - Artificial Intelligence - Enables :ref:`natural language querying ` - and allows the use of AI features in |compass-short| which make requests + and allows the use of AI features in Compass which make requests to 3rd party services. * - Enable sending sample field values diff --git a/source/troubleshooting/connection-errors.txt b/source/troubleshooting/connection-errors.txt index ce0abec74..1ea62fc7b 100644 --- a/source/troubleshooting/connection-errors.txt +++ b/source/troubleshooting/connection-errors.txt @@ -1,8 +1,8 @@ .. _compass-connection-errors: -================================= -|compass-short| Connection Errors -================================= +========================= +Compass Connection Errors +========================= .. default-domain:: mongodb @@ -18,7 +18,7 @@ The sections on this page list common errors seen when connecting to MongoDB Not Running on the Provided Host and Port ------------------------------------------------- -Your connection failed when |compass-short| attempted to connect to your +Your connection failed when Compass attempted to connect to your database on the specified host and port. Likely Causes @@ -181,17 +181,17 @@ replica set name using the following procedure: .. include:: /includes/fact-get-replica-set-name-steps.rst -Check Your |compass-short| Edition -`````````````````````````````````` +Check Your Compass Edition +`````````````````````````` You cannot perform write operations in :guilabel:`Compass Readonly` -edition. You can check your |compass-short| edition by opening the -top-level |compass-short| dropdown menu and selecting +edition. You can check your Compass edition by opening the +top-level Compass dropdown menu and selecting :guilabel:`About MongoDB Compass`. To perform write operations, you must download a different edition -of |compass|. For more information on the differences between -|compass-short| editions, see +of MongoDB. For more information on the differences between +Compass editions, see :ref:`Capabilities of Compass Editions `. Connection to Cluster Shard Closed @@ -271,8 +271,8 @@ replica set name using the following procedure: .. include:: /includes/fact-get-replica-set-name-steps.rst -Allow |compass-short| to Connect to the Secondary -````````````````````````````````````````````````` +Allow Compass to Connect to the Secondary +````````````````````````````````````````` Another approach to resolving this error is to allow |compass-short| to connect to a secondary cluster member. Change your :guilabel:`Read Preference` to either :guilabel:`Primary Preferred` or @@ -339,8 +339,8 @@ Solutions - Verify that your selected authentication mechanism is supported by your MongoDB database. -Check the |compass-short| Logs ------------------------------- +Check the Compass Logs +---------------------- The |compass-short| logs can provide additional information on connection errors. You may find more detailed error messages to help diff --git a/source/troubleshooting/logs.txt b/source/troubleshooting/logs.txt index 36a93b15b..22f723cda 100644 --- a/source/troubleshooting/logs.txt +++ b/source/troubleshooting/logs.txt @@ -1,8 +1,8 @@ .. _compass-logs: -============================= -Retrieve |compass-short| Logs -============================= +===================== +Retrieve Compass Logs +===================== .. default-domain:: mongodb @@ -20,8 +20,8 @@ help diagnose errors. |compass| redacts credentials from the logs. -View |compass-short| Logs -------------------------- +View Compass Logs +----------------- .. procedure:: :style: normal @@ -42,8 +42,8 @@ View |compass-short| Logs - Extract the log file and view it as a text file. -|compass-short| Log Location ----------------------------- +Compass Log Location +-------------------- |compass-short| maintains one log file per session, compressed into a gzip archive file. The corresponding session ID is included in the log From 1908c59b7592ef523bb2076e7ac671b8ca546c04 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Tue, 26 Nov 2024 15:00:47 -0500 Subject: [PATCH 5/6] * --- source/troubleshooting/connection-errors.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/troubleshooting/connection-errors.txt b/source/troubleshooting/connection-errors.txt index 1ea62fc7b..cbb2f03da 100644 --- a/source/troubleshooting/connection-errors.txt +++ b/source/troubleshooting/connection-errors.txt @@ -190,7 +190,7 @@ top-level Compass dropdown menu and selecting :guilabel:`About MongoDB Compass`. To perform write operations, you must download a different edition -of MongoDB. For more information on the differences between +of MongoDB Compass. For more information on the differences between Compass editions, see :ref:`Capabilities of Compass Editions `. From 05fb9b4c50351362d1349f20e32c4d211153096e Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Tue, 26 Nov 2024 15:10:47 -0500 Subject: [PATCH 6/6] * --- source/faq.txt | 4 ++-- source/settings/settings-reference.txt | 5 ++--- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index 600d89271..2be7ef8b8 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -82,8 +82,8 @@ Slow Sampling All queries that Compass sends to your MongoDB instance have a timeout flag set which automatically aborts a request if it takes longer than the specified timeout. This timeout is currently set to 10 seconds. If -:ref:`sampling ` on the database takes longer, Compass -will notify you about the timeout and give you the options of (a) retrying +:ref:`sampling ` on the database takes longer, Compass will +notify you about the timeout and give you the options of (a) retrying with a longer timeout (60 seconds) or (b) running a different query. .. note:: diff --git a/source/settings/settings-reference.txt b/source/settings/settings-reference.txt index 9c16b5130..d4f3b782c 100644 --- a/source/settings/settings-reference.txt +++ b/source/settings/settings-reference.txt @@ -183,9 +183,8 @@ You can configure the following settings on the |compass| interface: * - Enable AI Features - Artificial Intelligence - - Enables :ref:`natural language querying ` - and allows the use of AI features in Compass which make requests - to 3rd party services. + - Enables :ref:`natural language querying ` and allows + the use of AI features in Compass which make requests to 3rd party services. * - Enable sending sample field values - Artificial Intelligence