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

Add a description to the Site Title block. #23462

Merged
merged 1 commit into from
Oct 5, 2020

Conversation

mtias
Copy link
Member

@mtias mtias commented Jun 25, 2020

Block descriptions are a crucial pieces of information to teach users about the different aspects of a site. We should pay extra care in crafting them.

@mtias mtias added Needs Design Feedback Needs general design feedback. Needs Copy Review Needs review of user-facing copy (language, phrasing) [Block] Site Title Affects the Site Title Block labels Jun 25, 2020
@michelleweber
Copy link

Is there a description at the moment, or is this thread to figure out what the description should be?

@github-actions
Copy link

github-actions bot commented Jun 25, 2020

Size Change: +89 B (0%)

Total Size: 1.18 MB

Filename Size Change
build/block-library/index.js 135 kB +89 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 668 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.65 kB 0 B
build/block-library/editor.css 8.65 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-post/index.js 306 kB 0 B
build/edit-post/style-rtl.css 6.29 kB 0 B
build/edit-post/style.css 6.27 kB 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.2 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

@mtias
Copy link
Member Author

mtias commented Jun 25, 2020

@michelleweber currently there's no description, this PR adds one.

@@ -15,6 +15,9 @@ export { metadata, name };

export const settings = {
title: __( 'Site Title' ),
description: __(
'The name of the site is an important setting that determines how the website is displayed in various places, including the title bar of a web browser, search engine results, and RSS feeds. It can also be edited in Settings > General.'
Copy link
Contributor

@MichaelArestad MichaelArestad Jun 25, 2020

Choose a reason for hiding this comment

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

Because many of the core blocks start with words like "Introduce," "add," and "Insert," perhaps something similar could work here:

Display the title of your site — perfect for your site header.

@kristastevens
Copy link

Hello! I'll be jumping in on this one for @michelleweber. Ping me when you're ready! I'm standing by.

@shaunandrews
Copy link
Contributor

Here's a few ideas, shown in context to get a sense for sizing and how it affects the layout:

image

Here's the options typed out to make them easier to read and copy/paste:

--

Your site's title is shown in various places including search engine results, bookmarks, the browser's title bar, and more. You can also edit your site's title in Settings > General.

--

The name of your site that appears in the browser title bar, in search results, and more.

--

The name of your site that appears in the browser title bar, in search results, and more.

Also available in Settings > General

--

@MichaelArestad
Copy link
Contributor

@shaunandrews Most of the blocks descriptions start with verbs like "add," "insert," "use," etc. Should we stick to that convention here? (I think only a handful of people will notice)

That's why I suggested something like:

Display the title of your site — perfect for your site header.

@shaunandrews
Copy link
Contributor

blocks descriptions start with verbs like "add," "insert," "use," etc. Should we stick to that convention here?

I don't have a strong opinion; Starting with "Display..." seems to imply that you wouldn't be able to edit the site title.

If you can edit, then I think its important to mention that the contents of this block are used in many other places.

@carolinan
Copy link
Contributor

The description needs to indicate that the site title is a link on the front, because it is not obvious in the editor.

@mtias mtias force-pushed the add/site-title-block-description branch from b982e4c to b03aafc Compare October 5, 2020 14:09
@jasmussen jasmussen self-requested a review October 5, 2020 15:02
Copy link
Contributor

@jasmussen jasmussen left a comment

Choose a reason for hiding this comment

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

Nice little improvement!

@mtias mtias merged commit 29e8fa4 into master Oct 5, 2020
@mtias mtias deleted the add/site-title-block-description branch October 5, 2020 15:14
@github-actions github-actions bot added this to the Gutenberg 9.2 milestone Oct 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Site Title Affects the Site Title Block Needs Copy Review Needs review of user-facing copy (language, phrasing) Needs Design Feedback Needs general design feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants