DOCSP-46861-update-compass-for-new-version #719
Conversation
✅ Deploy Preview for docs-compass ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
source/settings/enable-dev-tools.txt
Outdated
| @@ -64,8 +63,6 @@ You can set the ``enableDevTools`` option in either: | |||
|
|
|||
| - Mac: ``⌘`` + ``,`` | |||
|
|
|||
| .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`. | |||
|
|
|||
| |compass-short| opens a dialog box where you can configure your |compass| | |||
| settings. | |||
There was a problem hiding this comment.
I didn't end up adding a screenshot showing the settings dialog box here, as our style guide recommends skipping screenshots for "dialog boxes that are easy to understand." (style guide)
| @@ -51,11 +51,10 @@ You can set the ``enableDevTools`` option in either: | |||
| .. procedure:: | |||
| :style: normal | |||
|
|
|||
There was a problem hiding this comment.
Note: I didn't add the recommended "Login to compass interface" step from the original ticket for concision purposes + to avoid redundancy.
There was a problem hiding this comment.
Thanks for these updates @amalhotra-mdb. I added a couple suggestions that apply to each page! LMK if you have any follow-up questions!
source/settings/enable-dev-tools.txt
Outdated
| @@ -51,11 +51,10 @@ You can set the ``enableDevTools`` option in either: | |||
| .. procedure:: | |||
| :style: normal | |||
|
|
|||
| .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`. | |||
| .. step:: To open the |compass| Settings Panel, click the gear icon at the upper left of the |compass-short| home screen. | |||
There was a problem hiding this comment.
[suggestion] It might be a bit confusing for a user to read "upper left" and see that the gear icon is not exactly in the upper-left corner of the screenshot. Do you think we can maybe instead direct them to the "left column of the Compass home screen" ?
| @@ -49,20 +49,17 @@ You can set the ``protectConnectionStrings`` option in either: | |||
| .. procedure:: | |||
| :style: normal | |||
|
|
|||
| .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`. | |||
| .. step:: To open the |compass| Settings Panel, click the gear icon at the upper left of the |compass-short| home screen. | |||
There was a problem hiding this comment.
[suggestion] ditto the comment above regarding directional language
source/settings/enable-dev-tools.txt
Outdated
| @@ -51,11 +51,10 @@ You can set the ``enableDevTools`` option in either: | |||
| .. procedure:: | |||
| :style: normal | |||
|
|
|||
| .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`. | |||
| .. step:: To open the |compass| Settings Panel, click the gear icon at the upper left of the |compass-short| home screen. | |||
There was a problem hiding this comment.
[very optional suggestion] Also, I recently learned that you can make procedure steps includes. You can maybe consider making the first step of these procedures steps into an include since they're all the same.
There was a problem hiding this comment.
Thanks for the suggestions @ajhuh-mdb ! I was wondering if we could do includes in procedure steps, that makes things a lot easier. Changes made, lmk if any other changes stand out to you. Thank you!
There was a problem hiding this comment.
Have a couple more small comments before this should be ready to go! Thanks for your patience with this one @amalhotra-mdb
| column of the |compass-short| home screen. | ||
|
|
||
| .. figure:: /images/compass/settings-gear-icon.png | ||
| :alt: Settings gear icon location on MongoDB Compass UI |
There was a problem hiding this comment.
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
| @@ -0,0 +1,15 @@ | |||
| To open the |compass| Settings Panel, click the gear icon on the left | |||
There was a problem hiding this comment.
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.
Thanks for all your help on this @ajhuh-mdb, changes made back to you! |
|
LGTM |
DESCRIPTION
Update all the settings pages that instruct how to access the settings dialog box on Compass to reflect new Compass UI.
Note: the original ticket for this PR only mentions updating the Enable DevTools page in compass to reflect the new UI, however, there are many instances of procedures that navigate to the settings dialog box. So, this PR updates all instances of navigation to the Compass settings.
STAGING
JIRA
https://jira.mongodb.org/browse/DOCSP-46861
BUILD LOG
Self-Review Checklist
External Review Requirements
What's expected of an external reviewer?