DOCSP-24994 Compass Settings UI (#474)

* DOCSP-24994 Compass Settings UI

* fix refs + move around pages

* toc fixes + add more information to settings concept page

* settings page

* fix ref

* build errors

* settings reference page

* rename ref page

* add ref to reference page

* capitalization

* edit column sizes + add task links

* rename table section

* AB edits

* edits to reference page intro text

* more copy cleanup

* AB edits pt 2

* RH additions

* cleanup copy

* add figure + fix styling

* JA edits

* resize image

Author: ajhuh-mdb

snooty.toml

@@ -10,7 +10,8 @@ intersphinx = [
 toc_landing_pages = [
     "/install", 
     "/connect",
-    "/connect/connect-from-the-command-line",
+    "/settings",
+    "/settings/config-file",
     "/connect/advanced-connection-options",
     "/connect/favorite-connections",
     "/connect/favorite-connections/import-export",

source/connect/connect-from-the-command-line.txt

@@ -133,8 +133,3 @@ configuration file to specify which connection to use:
    mongodb-compass --file=multipleConnectionFile \
                    --passphrase=superSecret \
                    27ba0eda-c27e-46f5-a74a-2c041b1b58c4
-
-.. toctree::
-   :titlesonly:
-
-   /connect/connect-from-the-command-line/command-line-options

source/embedded-shell.txt

@@ -66,6 +66,8 @@ an :ref:`aggregation pipeline <aggregation-pipeline>`:
         { $match: { "last_name": "Smith" } } // press Shift + Enter
       ] )                                    // Press Enter
 
+.. _disable-shell:
+
 Disable the Embedded MongoDB Shell
 ----------------------------------
 

source/images/compass/settings-panel-location.png

@@ -152,9 +152,9 @@ Expand your knowledge of MongoDB by using Compass with other MongoDB products.
    Overview </index>
    /install
    /connect
+   /settings
    /instance
    /manage-data
-   /config-file
    /import-export
    /embedded-shell
    /aggregation-pipeline-builder

source/index.txt

@@ -0,0 +1,65 @@
+.. _compass-settings:
+
+=========================
+Customize |compass-short|
+=========================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+To customize user access and privacy in |compass|, you can configure your 
+|compass-short| settings on the :ref:`Compass interface 
+<compass-settings-reference>`, the :ref:`command line <cli-options>`, or a 
+:ref:`configuration file <config-file>`.
+
+Use Cases 
+---------
+
+You can specify |compass-short| settings and behaviors to customize your 
+|compass-short| experience. For administrators, you can modify the 
+|compass-short| settings to restrict the actions users can take.
+
+For example:
+
+- If you need to hide credentials from users connecting to MongoDB, you can 
+  set the ``protectConnectionStrings`` option.
+
+- If you want to automate the launch of |compass-short| without any input 
+  required from users, you can use the command line to launch |compass-short| 
+  with specified configuration options. 
+
+- If you have multiple team members using |compass-short|, you can use a common 
+  configuration file to ensure a consistent user experience.
+
+Tasks
+-----
+
+- :ref:`compass-configure-network-traffic`
+
+- :ref:`compass-protect-connection-strings`
+
+- :ref:`compass-force-connection-options`
+
+Learn more 
+----------
+
+- :ref:`compass-interface-settings`
+
+- :ref:`cli-options`
+
+- :ref:`config-file`
+
+.. toctree::
+   :titlesonly:
+
+   /settings/settings-reference
+   /settings/command-line-options
+   /settings/config-file
+   /settings/restrict-outgoing-connections
+   /settings/protect-connection-strings
+   /settings/specify-read-preference-tags

source/settings.txt

@@ -1,6 +1,5 @@
-.. _cli-options:
-
 .. program:: compass
+.. _cli-options:
 
 ----------------------------
 Compass Command Line Options
@@ -144,3 +143,5 @@ Learn More
 - :ref:`<comp-command-line-connect>`
 
 - :ref:`<config-file>` 
+
+- :ref:`compass-interface-settings`

source/connect/connect-from-the-command-line/command-line-options.txt renamed to source/settings/command-line-options.txt

@@ -54,23 +54,12 @@ When you configure settings with a configuration file:
 
      <path-to-Compass-executable> --help
 
-Tasks
------
-
-- :ref:`compass-protect-connection-strings`
-
-- :ref:`compass-configure-network-traffic`
-
-- :ref:`specify-read-preference-tags`
-
-.. seealso::
+Learn More
+----------
 
-   :ref:`<config-file-options>`
+:ref:`<config-file-options>`
 
 .. toctree::
    :titlesonly:
 
-   /config-file/config-file-options
-   /config-file/protect-connection-strings
-   /config-file/restrict-outgoing-connections
-   /config-file/specify-read-preference-tags
+   /settings/config-file/config-file-options

source/config-file.txt renamed to source/settings/config-file.txt

@@ -37,7 +37,7 @@ To hide your your connection string credentials, enable the
 
 You can set the ``protectConnectionStrings`` option in either: 
 
-- The |compass-short| :guilabel:`Settings` panel
+- The |compass-short| :ref:`Settings panel <compass-settings-reference>`
 
 - The :ref:`command line <cli-options>`
 

source/config-file/config-file-options.txt renamed to source/settings/config-file/config-file-options.txt

@@ -0,0 +1,123 @@
+.. _compass-interface-settings:
+.. _compass-settings-reference:
+
+--------------------------
+Compass Interface Settings
+--------------------------
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+You can customize |compass| to meet your specific needs on the |compass-short| 
+interface. Some options are only available in the :guilabel:`Settings` panel.
+
+If you have already configured |compass-short| settings on the command line or 
+in a configuration file, you cannot modify those settings in the |compass-short| 
+interface.
+
+Settings Panel Location
+-----------------------
+
+To find the |compass-short| :guilabel:`Settings` panel, open the 
+:guilabel:`MongoDB Compass` system menu and select :guilabel:`Settings`.
+
+.. figure:: /images/compass/settings-panel-location.png
+  :scale: 60%
+  :alt: Settings panel location under the MongoDB Compass system menu
+
+Alternatively, you can use keyboard shortcuts to open the :guilabel:`Settings` 
+panel: 
+
+- Windows / Linux: ``Ctrl`` + ``,``
+
+- Mac: ``⌘`` + ``,``
+
+Settings
+--------
+
+You can configure the following settings on the |compass| interface:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 30 20 50
+
+   * - Setting 
+     - Category
+     - Definition
+
+   * - Set Read-Only Mode
+     - General
+     - Remove all write and delete capabilities on |compass-short|. 
+
+   * - Enable MongoDB Shell
+     - General
+     - Enable or disable the embedded MongoDB Shell on |compass-short|. 
+     
+       If you select :guilabel:`Set Read-Only Mode`, |compass-short| 
+       automatically disables the :guilabel:`Enable MongoDB Shell` setting.
+
+       To learn more, see :ref:`disable-shell`.
+    
+   * - Protect Connection String Secrets
+     - General
+     - .. include:: /includes/fact-protect-connection-strings.rst 
+      
+       To learn more, see :ref:`compass-protect-connection-strings`.
+
+   * - Show Kerberos Password Field 
+     - General
+     - Show or hide the Kerberos password field on the |compass-short| 
+       connection form.
+
+   * - Upper Limit for maxTimeMS for |compass-short| Database Operations 
+     - General
+     - Specify an upper time limit for all |compass-short| database operations.
+
+   * - Enable Devtools
+     - General
+     - Enable the Chromium Developer Tools  that can be used to debug Electron's 
+       process.
+
+   * - Sync with OS
+     - Theme 
+     - Automatically switch between light and dark themes based on your OS 
+       settings. 
+
+   * - Light Mode 
+     - Theme 
+     - Use a light theme.
+
+   * - Dark Mode 
+     - Theme 
+     - Use a dark theme.
+
+   * - Enable Automatic Updates 
+     - Privacy 
+     - Allow |compass-short| to periodically check for new updates.
+
+   * - Enable Geographic Visualizations
+     - Privacy 
+     - Allow |compass-short| to make requests to third-party mapping services.
+
+   * - Enable Usage Statistics
+     - Privacy
+     - Allow |compass-short| to send anonymous usage statistics.
+
+   * - Give Product Feedback 
+     - Privacy
+     - Allow our Product team to occasionally reach out for feedback about 
+       |compass-short|.
+
+Learn More
+----------
+
+- :ref:`compass-settings`
+
+- :ref:`cli-options`
+
+- :ref:`config-file`

source/config-file/protect-connection-strings.txt renamed to source/settings/protect-connection-strings.txt

@@ -39,12 +39,12 @@ versions of Compass to upgrade.
 Enable Automatic Updates
 ------------------------
 
-You can enable automatic updates to the latest version of Compass on the
-:guilabel:`Help > Privacy Settings` dialog.
+You can enable automatic updates to the latest version of Compass in the 
+:guilabel:`Privacy` section of the :guilabel:`Help > Settings` dialog.
 
 .. figure:: /images/compass/privacy-settings.png
    :scale: 80%
-   :alt: Privacy settings
+   :alt: Settings
 
 |compass| does not install any updates without your explicit permission.
 Instead, |compass-short| prompts you to upgrade when a new version is