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.

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-40542 Compass Quit Functionality Update #640

Merged
merged 57 commits into from
Jul 2, 2024

Conversation

ianf-mongodb
Copy link
Contributor

@ianf-mongodb ianf-mongodb commented Jun 28, 2024

DESCRIPTION

  • Add quit setting to the settings page.
  • Updated all keyboard short cuts to use :kbd: role.
  • Updated the close window hotkey to be cmd + shift + w to reflect recent app change.
  • Add ref to the keyboard shortcuts page.

STAGING

https://preview-mongodbianfmongodb.gatsbyjs.io/compass/DOCSP-40542/settings/settings-reference/#settings

https://preview-mongodbianfmongodb.gatsbyjs.io/compass/DOCSP-40542/keyboard-shortcuts/

JIRA

https://jira.mongodb.org/browse/DOCSP-40542

BUILD LOG

https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=6684128efe162e50061300a9

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Is this free of spelling errors?
  • Is this free of grammatical errors?
  • Is this free of staging / rendering issues?
  • Are all the links working?

External Review Requirements

What's expected of an external reviewer?

Copy link
Collaborator

@sarah-olson-mongodb sarah-olson-mongodb left a comment

Choose a reason for hiding this comment

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

Thanks @ianf-mongodb! LGTM with a few items for consideration.

Comment on lines 113 to 114
Checking the ``Do not ask again`` checkbox on the quit dialog
disables this setting.
Copy link
Collaborator

Choose a reason for hiding this comment

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

(structure)
To disable this setting, check "Do not ask again".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This removes the reference to the quit dialog box which is a separate element than where the setting is stored. This is a supplemental way to turn off the setting option.

So it needs to be:

"You can also check the Do not ask again checkbox on the quit dialog to disable the setting."

@@ -107,6 +107,15 @@ You can configure the following settings on the |compass| interface:
enabled. You cannot toggle this option on Linux. You can toggle this
setting only on Windows or macOS.

* - Show Quit Confirmation Dialog
- General
- Toggle whether a confirmation dialog is shown when quitting Compass.
Copy link
Collaborator

Choose a reason for hiding this comment

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

(term and active voice)
I'm a little concerned about toggle. I think we could get more specific. Also we want to stay away from "is shown". So maybe something like:
Specifies whether to display the confirmation dialog when you exit Compass.

source/keyboard-shortcuts.txt Show resolved Hide resolved
@ianf-mongodb ianf-mongodb requested a review from Anemy July 1, 2024 13:14
@ianf-mongodb
Copy link
Contributor Author

@Anemy this is ready for review.

source/settings/settings-reference.txt Outdated Show resolved Hide resolved
@jason-price-mongodb jason-price-mongodb merged commit 0706dd9 into mongodb:master Jul 2, 2024
1 check passed
@docs-builder-bot
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants