Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 17 commits into from
Feb 6, 2025
Merged

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

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
b4816c8
DOCSP-46861-update-compass-for-new-version
amalhotra-mdb Feb 3, 2025
822dff0
image fix
amalhotra-mdb Feb 3, 2025
a93f688
fix image render
amalhotra-mdb Feb 3, 2025
2b98d4b
update all compass pages that reference finding the compass settings
amalhotra-mdb Feb 3, 2025
a3bb611
fix directional lang + add include
amalhotra-mdb Feb 4, 2025
794f364
fix include
amalhotra-mdb Feb 4, 2025
49b74ba
fix all includes
amalhotra-mdb Feb 4, 2025
231c569
add missing sentence
amalhotra-mdb Feb 4, 2025
f70517d
reviewer changes
amalhotra-mdb Feb 4, 2025
72a2b37
fix include
amalhotra-mdb Feb 4, 2025
b863174
fix width
amalhotra-mdb Feb 4, 2025
70b65f7
.
amalhotra-mdb Feb 4, 2025
07ca8bd
include formatting?
amalhotra-mdb Feb 5, 2025
0bc5df4
change pic width
amalhotra-mdb Feb 5, 2025
5f993b7
add step in include
amalhotra-mdb Feb 5, 2025
2afcb11
fix indentation and width
amalhotra-mdb Feb 5, 2025
749971a
remove include from non procedural filegst
amalhotra-mdb Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added source/images/compass/settings-gear-icon.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed source/images/compass/settings-panel-location.png
View file
Open in desktop
Binary file not shown.
15 changes: 15 additions & 0 deletions source/includes/fact-navigate-to-settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
To open the |compass| Settings Panel, click the gear icon on the left
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a heads up, the font for the text on this include is different from the other steps on each page. To mitigate that, we might want to include the .. step:: directive in here and format the include accordingly within the procedure directive. For example like:

Compass Settings Panel 
~~~~~~~~~~~~~~~~~~

.. procedure:: 
   :style: normal 

   .. include:: <include file path> 

   .. step:: Toggle `Enable Devtools`

^ That should render like normal.

column of the |compass-short| home screen.

.. figure:: /images/compass/settings-gear-icon.png
:alt: Settings gear icon location on MongoDB Compass UI
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small nit, but do you think we can resize this image to be smaller? I don't think it needs to take up as much visual real estate as it currently does. You can adjust this with the :width: flag


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.
20 changes: 3 additions & 17 deletions source/settings/enable-dev-tools.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -51,23 +51,9 @@ You can set the ``enableDevTools`` option in either:
.. procedure::
:style: normal

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: I didn't add the recommended "Login to compass interface" step from the original ticket for concision purposes + to avoid redundancy.

.. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`.
.. step::

.. 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`.

Expand Down
20 changes: 3 additions & 17 deletions source/settings/protect-connection-strings.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,23 +49,9 @@ 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.
.. step::

.. include:: includes/fact-navigate-to-settings.rst

.. step:: Toggle :guilabel:`Protect Connection String Secrets`.

Expand Down
20 changes: 3 additions & 17 deletions source/settings/read-only.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,9 @@ 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.
.. step::

.. include:: includes/fact-navigate-to-settings.rst

.. step:: Toggle :guilabel:`Set Read-Only Mode`.

Expand Down
14 changes: 1 addition & 13 deletions source/settings/settings-reference.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,14 @@ 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: 40%
:alt: Settings panel location under the MongoDB Compass system menu
.. include:: includes/fact-navigate-to-settings.rst

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
--------

Expand Down
20 changes: 3 additions & 17 deletions source/settings/show-kerberos-password.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,23 +45,9 @@ 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.
.. step::

.. include:: /includes/fact-navigate-to-settings.rst

.. step:: Toggle :guilabel:`Show Kerberos Password Field`.

Expand Down
21 changes: 3 additions & 18 deletions source/settings/telemetry.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,24 +75,9 @@ 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: ``⌘`` + ``,``
.. step::

.. include:: includes/fact-navigate-to-settings.rst

.. step:: In the left pane of the :guilabel:`Settings` window, click :guilabel:`Privacy`.

Expand Down
Loading