DOCSP-46861-update-compass-for-new-version (#719)

amalhotra-mdb · web-flow · commit ee753195f663 · 2025-02-06T16:37:47.000-05:00
* DOCSP-46861-update-compass-for-new-version

* image fix

* fix image render

* update all compass pages that reference finding the compass settings

* fix directional lang + add include

* fix include

* fix all includes

* add missing sentence

* reviewer changes

* fix include

* fix width

* .

* include formatting?

* change pic width

* add step in include

* fix indentation and width

* remove include from non procedural filegst
diff --git a/source/images/compass/settings-gear-icon.png b/source/images/compass/settings-gear-icon.png
diff --git a/source/images/compass/settings-panel-location.png b/source/images/compass/settings-panel-location.png
diff --git a/source/includes/fact-navigate-to-settings.rst b/source/includes/fact-navigate-to-settings.rst
@@ -0,0 +1,15 @@
+.. step:: To open the |compass| Settings Panel, click the gear icon on the left column of the |compass-short| home screen.
+
+   .. figure:: /images/compass/settings-gear-icon.png
+      :width: 450px
+      :alt: Settings gear icon location on MongoDB Compass UI
+ 
+   Alternatively, you can use keyboard shortcuts to open the :guilabel:`Settings` 
+   panel: 
+ 
+   - Windows / Linux: ``Ctrl`` + ``,``
+ 
+   - Mac: ``⌘`` + ``,``
+ 
+   |compass-short| opens a dialog box where you can configure your |compass| 
+   settings.
diff --git a/source/settings/enable-dev-tools.txt b/source/settings/enable-dev-tools.txt
@@ -31,7 +31,7 @@ If you enable any of the following options, you cannot enable the
 :guilabel:`Enable DevTools` setting: 
 
 - :guilabel:`Set Read-Only Mode`
-- :guilabel:`maxTimeMS`
+- :guilabel:`Upper Limit for maxTimeMS for Compass Database Operations`
 - :guilabel:`Protect Connection String Secrets`
 
 Steps
@@ -51,23 +51,7 @@ You can set the ``enableDevTools`` option in either:
 .. procedure:: 
    :style: normal
 
-   .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`. 
-
-      .. figure:: /images/compass/settings-panel-location.png
-         :scale: 40% 
-         :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: ``⌘`` + ``,``
-
-   .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`.
-
-      |compass-short| opens a dialog box where you can configure your |compass| 
-      settings.
+   .. include:: /includes/fact-navigate-to-settings.rst
 
    .. step:: Toggle :guilabel:`Enable DevTools`.
 
diff --git a/source/settings/protect-connection-strings.txt b/source/settings/protect-connection-strings.txt
@@ -49,23 +49,7 @@ You can set the ``protectConnectionStrings`` option in either:
 .. procedure:: 
    :style: normal
    
-   .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`. 
-
-      .. figure:: /images/compass/settings-panel-location.png
-         :scale: 40% 
-         :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: ``⌘`` + ``,``
-
-   .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`.
-
-      |compass-short| opens a dialog box where you can configure your |compass| 
-      settings.
+   .. include:: includes/fact-navigate-to-settings.rst
 
    .. step:: Toggle :guilabel:`Protect Connection String Secrets`.
 
diff --git a/source/settings/read-only.txt b/source/settings/read-only.txt
@@ -44,23 +44,7 @@ You can enable the ``readOnly`` option in either:
 .. procedure:: 
    :style: normal
    
-   .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`. 
-
-      .. figure:: /images/compass/settings-panel-location.png
-         :scale: 40% 
-         :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: ``⌘`` + ``,``
-
-   .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`.
-
-      |compass-short| opens a dialog box where you can configure your |compass| 
-      settings.
+   .. include:: includes/fact-navigate-to-settings.rst
 
    .. step:: Toggle :guilabel:`Set Read-Only Mode`.
 
diff --git a/source/settings/settings-reference.txt b/source/settings/settings-reference.txt
@@ -23,26 +23,28 @@ interface.
 Settings Panel Location
 -----------------------
 
-To find the |compass-short| :guilabel:`Settings` panel, open the 
-:guilabel:`MongoDB Compass` system menu and select :guilabel:`Settings`.
+To open the |compass| Settings Panel, click the gear icon on the left column of the |compass-short| home screen.
 
-.. figure:: /images/compass/settings-panel-location.png
-  :scale: 40%
-  :alt: Settings panel location under the MongoDB Compass system menu
+.. figure:: /images/compass/settings-gear-icon.png
+   :width: 450px
+   :alt: Settings gear icon location on MongoDB Compass UI
+ 
+Alternatively, you can use keyboard shortcuts to open the :guilabel:`Settings` 
+panel: 
+ 
+- Windows / Linux: ``Ctrl`` + ``,``
+ 
+- Mac: ``⌘`` + ``,``
+ 
+|compass-short| opens a dialog box where you can configure your |compass| 
+settings.
 
 You can also open the the |compass-short| :guilabel:`Settings` panel
 when connected to your cluster by doing the following: 
 
 1. Click the :icon-fa5:`ellipsis-h` next to your cluster name.
 2. Select :guilabel:`Compass Settings` from the dropdown.
 
-Alternatively, you can use keyboard shortcuts to open the :guilabel:`Settings` 
-panel: 
-
-- Windows / Linux: ``Ctrl`` + ``,``
-
-- Mac: ``⌘`` + ``,``
-
 Settings
 --------
 
diff --git a/source/settings/show-kerberos-password.txt b/source/settings/show-kerberos-password.txt
@@ -45,23 +45,7 @@ You can enable the ``showKerberosPasswordField`` option in either:
 .. procedure:: 
    :style: normal
    
-   .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`. 
-
-      .. figure:: /images/compass/settings-panel-location.png
-         :scale: 40% 
-         :alt: Settings panel location under the MongoDB Compass system menu
-      
-      Alternatively, you can use keyboard shortcuts to open the 
-      :guilabel:`Settings` panel: 
-      
-      - Windows or Linux: ``Ctrl`` + ``,``
-      
-      - MacOS: ``⌘`` + ``,``
-
-   .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`.
-
-      |compass-short| opens a dialog box where you can configure your |compass| 
-      settings.
+   .. include:: /includes/fact-navigate-to-settings.rst
 
    .. step:: Toggle :guilabel:`Show Kerberos Password Field`.
 
diff --git a/source/settings/telemetry.txt b/source/settings/telemetry.txt
@@ -75,24 +75,7 @@ To toggle telemetry from the |compass-short| settings:
 .. procedure:: 
    :style: normal
    
-   .. step:: Open the Settings window.
-      
-      a. In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`
-      
-      b. Click :guilabel:`Settings`
-      
-         .. figure:: /images/compass/settings-panel-location.png
-            :scale: 40% 
-            :alt: Settings window location under the MongoDB Compass system menu
-
-      .. tip::
-
-         Alternatively, you can use keyboard shortcuts to open the
-         :guilabel:`Settings` window: 
-         
-         - Windows / Linux: ``Ctrl`` + ``,``
-         
-         - Mac: ``⌘`` + ``,``
+   .. include:: includes/fact-navigate-to-settings.rst
 
    .. step:: In the left pane of the :guilabel:`Settings` window, click :guilabel:`Privacy`.
    
