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

Rename "Options" modal to "Preferences". #25683

Merged
merged 2 commits into from
Oct 9, 2020

Conversation

ZebulanStanphill
Copy link
Member

Description

This PR renames the "Options" modal to "Preferences". This helps get rid of the confusion of having an "Options" option located under the "Options" menu. (See, it even sounds confusing! 😛) This also helps narrow down the purpose of the modal a bit, and makes it clear what kind of options belong in it.

There are no functional changes in this PR. Only name changes.

Screenshots

Before

image
image

After

image
image

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

@ZebulanStanphill ZebulanStanphill added [Type] Enhancement A suggestion for improvement. [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). Needs Design Feedback Needs general design feedback. Needs Copy Review Needs review of user-facing copy (language, phrasing) Needs Accessibility Feedback Need input from accessibility labels Sep 28, 2020
@github-actions
Copy link

github-actions bot commented Sep 28, 2020

Size Change: +18 B (0%)

Total Size: 1.18 MB

Filename Size Change
build/edit-post/index.js 306 kB +10 B (0%)
build/edit-post/style-rtl.css 6.29 kB +3 B (0%)
build/edit-post/style.css 6.28 kB +5 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.52 kB 0 B
build/api-fetch/index.js 3.35 kB 0 B
build/autop/index.js 2.72 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 8.55 kB 0 B
build/block-directory/style-rtl.css 943 B 0 B
build/block-directory/style.css 942 B 0 B
build/block-editor/index.js 129 kB 0 B
build/block-editor/style-rtl.css 10.9 kB 0 B
build/block-editor/style.css 10.9 kB 0 B
build/block-library/editor-rtl.css 8.6 kB 0 B
build/block-library/editor.css 8.6 kB 0 B
build/block-library/index.js 135 kB 0 B
build/block-library/style-rtl.css 7.66 kB 0 B
build/block-library/style.css 7.65 kB 0 B
build/block-library/theme-rtl.css 741 B 0 B
build/block-library/theme.css 741 B 0 B
build/block-serialization-default-parser/index.js 1.78 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 47.5 kB 0 B
build/components/index.js 169 kB 0 B
build/components/style-rtl.css 15.3 kB 0 B
build/components/style.css 15.3 kB 0 B
build/compose/index.js 9.42 kB 0 B
build/core-data/index.js 12 kB 0 B
build/data-controls/index.js 685 B 0 B
build/data/index.js 8.6 kB 0 B
build/date/index.js 31.9 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 568 B 0 B
build/dom/index.js 4.42 kB 0 B
build/edit-navigation/index.js 10.7 kB 0 B
build/edit-navigation/style-rtl.css 868 B 0 B
build/edit-navigation/style.css 871 B 0 B
build/edit-site/index.js 20.4 kB 0 B
build/edit-site/style-rtl.css 3.84 kB 0 B
build/edit-site/style.css 3.84 kB 0 B
build/edit-widgets/index.js 21.1 kB 0 B
build/edit-widgets/style-rtl.css 3 kB 0 B
build/edit-widgets/style.css 3 kB 0 B
build/editor/editor-styles-rtl.css 492 B 0 B
build/editor/editor-styles.css 493 B 0 B
build/editor/index.js 45.5 kB 0 B
build/editor/style-rtl.css 3.85 kB 0 B
build/editor/style.css 3.84 kB 0 B
build/element/index.js 4.44 kB 0 B
build/escape-html/index.js 734 B 0 B
build/format-library/index.js 7.49 kB 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 1.74 kB 0 B
build/html-entities/index.js 621 B 0 B
build/i18n/index.js 3.54 kB 0 B
build/is-shallow-equal/index.js 710 B 0 B
build/keyboard-shortcuts/index.js 2.39 kB 0 B
build/keycodes/index.js 1.85 kB 0 B
build/list-reusable-blocks/index.js 3.02 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/media-utils/index.js 5.12 kB 0 B
build/notices/index.js 1.69 kB 0 B
build/nux/index.js 3.27 kB 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/plugins/index.js 2.44 kB 0 B
build/primitives/index.js 1.34 kB 0 B
build/priority-queue/index.js 790 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 13 kB 0 B
build/server-side-render/index.js 2.6 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.24 kB 0 B
build/url/index.js 4.06 kB 0 B
build/viewport/index.js 1.74 kB 0 B
build/warning/index.js 1.13 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

@carolynannewells
Copy link

Hello, Carolyn from editorial. I agree that "preferences" works better than "options". Is there anything else you would like me to look at?

@ZebulanStanphill
Copy link
Member Author

Hello, Carolyn from editorial. I agree that "preferences" works better than "options". Is there anything else you would like me to look at?

There's no other copy changes in this PR besides the renaming, so that's all. Thank you for your quick review! 😄

@ZebulanStanphill ZebulanStanphill removed the Needs Copy Review Needs review of user-facing copy (language, phrasing) label Sep 28, 2020
Copy link
Contributor

@afercia afercia left a comment

Choose a reason for hiding this comment

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

25 changed files just to change a string. There must be something wrong! 😆

Jokes apart, makes sense to me. Quick question:

Should the "Keyboard options" section within the modal be renamed to "Keyboard preferences"? Or maybe just remove the word "options" as it seems to me this is the only section name with the term "options", not sure why.

From a technical perspective, I don't have the knowledge to determine whether these changes need deprecations/aliases or whatever, given fome files and components are renamed.

@ZebulanStanphill ZebulanStanphill added Needs Technical Feedback Needs testing from a developer perspective. and removed Needs Accessibility Feedback Need input from accessibility labels Sep 29, 2020
@ZebulanStanphill
Copy link
Member Author

@afercia To be fair, I'm changing the CSS class names and function names, which isn't strictly necessary, but the confusion between the "More options" button and "Options" modal applies to the internal names as well, so I figured I ought to change them too. And of course, I had to update all the unit tests and end-to-end tests that check for specific classes and strings.

I'm pretty sure most of the internal name changes should be fine. The only thing I'm not sure about is changing MODAL_NAME from edit-post/options to edit-post/preferences. Is openModal exposed publicly? Hypothetically, if a plugin were to try using openModal( 'edit-post/options' ), it would now do nothing. I'm not sure why a 3rd-party plugin would do that, though, or if it's even possible. I'll wait for a technical review on that bit. It's easy enough to revert.

And yeah, "Keyboard options" should probably just be "Keyboard", though I figure that should be its own PR.

@afercia
Copy link
Contributor

afercia commented Sep 30, 2020

@ZebulanStanphill sure, I was joking on the changed files number, mostly because I'm surprised that in "modern development" one has to change 25 files to rename a string to "do it right". Old-school guy here, missing the old good days when changing a string was just... changing a string 🙂

And yeah, "Keyboard options" should probably just be "Keyboard", though I figure that should be its own PR.

I'd say: throw that change in and pretend others don't see it :trollface:

@ZebulanStanphill
Copy link
Member Author

Now that I think about it, the Preferences modal probably shouldn't even have its own CSS class. I see it uses it for section margins... but I think that kind of styling should probably be made generic to all modals. Of course, the Preferences modal is likely to be completely redesigned soon, so I guess we can probably remove the class along the way when we implement that.

@mtias
Copy link
Member

mtias commented Oct 1, 2020

I'm fine with this change, don't have a strong opinion but seems "Preferences" can be a better fit. Also happy with sneaking in "Keyboard options" → "Keyboard" :)

@karmatosed
Copy link
Member

I'm going to remove the design feedback as for me I'm also keen on not having options > options. I'd +1 the change @mtias suggests of using this as an option to remove other 'options'. I do think it could do with a little code check as that feels like quite a lot of spots it's in, as has been noted this could be a great opportunity for iteration there and streaming of process.

@karmatosed karmatosed removed the Needs Design Feedback Needs general design feedback. label Oct 1, 2020
@ZebulanStanphill
Copy link
Member Author

Applied the "Keyboard options" to "Keyboard" change.

@ZebulanStanphill ZebulanStanphill removed the Needs Technical Feedback Needs testing from a developer perspective. label Oct 9, 2020
@ZebulanStanphill
Copy link
Member Author

I'm going to go ahead and merge this.

@ZebulanStanphill ZebulanStanphill merged commit 78585d6 into master Oct 9, 2020
@ZebulanStanphill ZebulanStanphill deleted the update/options-modal-label branch October 9, 2020 02:04
@github-actions github-actions bot added this to the Gutenberg 9.2 milestone Oct 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants