Try more descriptive summary and labels for Group block and associated actions#16002
Try more descriptive summary and labels for Group block and associated actions#16002kjellr wants to merge 9 commits into
Conversation
| onClick={ onConvertToGroup } | ||
| > | ||
| { _x( 'Group', 'verb' ) } | ||
| { _x( 'Create a Group Block', 'Creates a new Group block containing the selected blocks in the Editor' ) } |
There was a problem hiding this comment.
The only concern I have is that it is implying you are just creating a new Block. It doesn't imply that you are necessarily containing the selected blocks within a new group block.
There was a problem hiding this comment.
Yeah, I struggled a bit with this one. "Group Blocks" didn't actually make a ton of sense, since you can trigger this from just one block. Maybe "Add to a Group Block"? My concern with that was that it wasn't clear that it was actually creating a new Group block. 😄
| onClick={ onConvertFromGroup } | ||
| > | ||
| { _x( 'Ungroup', 'Ungrouping blocks from within a Group block back into individual blocks within the Editor ' ) } | ||
| { _x( 'Ungroup Blocks', 'Ungrouping blocks from within a Group block back into individual blocks within the Editor ' ) } |
There was a problem hiding this comment.
This makes sense to me and is clearer.
|
I like the updated labels -- it makes it clearer that this is an actual block that contains other blocks as opposed to just some kind of mechanism for linking blocks together. |
|
I have trouble with "A block that contains other blocks". While I like being explicit that it's also a block, I feel we have several blocks that contain other blocks, ie. Columns, Media+Text, Cover, etc. Maybe we can use this opportunity to differentiate it from those others? Is there a way we can say this by also stating a purpose for this block? Maybe I'm overthinking this?
On the other hand, I think it's okay to just use the word to describe the action it's meant to perform, especially if the word describes it best, like "group". So I guess what I'm saying is that a Group block "groups" other blocks together is pretty straightforward IMO. Here's an example of the Column block.
+1 to the actions labels in the dropdown. |
|
I tend to think of the descriptions as definitions of the block. With that mindset, it'd be very weird to use the same word in both places. It's possible I'm thinking about that wrong though. I guess the Image block description uses the word image in it. 😄 To @michelleweber's point though, I do like using the word "contain" here because structurally, that's exactly what this is doing. It's not just linking the blocks together, it's creating a new block that contains them. |
I'm totally willing to accept this. 👍 A lot of our blocks seem to use the same word in the description as in the title, so I'm okay with that as well. "Group" to me, gives it a purpose while "contain" states it's function. I'm good either way! I don't want to hold this up. Thanks for thinking it through. |
|
Our block descriptions tend to use the action + subject format, like:
Given this (wordier!) format, we should change the description here to follow this convention. It may also help to give some context about why you might want to group blocks together. I think it's for easier moving and manipulation, but please correct me if I'm wrong there. A few suggestions:
Alternatively, there's an opportunity to reference a Spice Girls song here I'm sure. 😉 |
Spice girls or New Kids on the Block? 😆 @sarahmonster, great insight on the sentence structure of those descriptions. I like your second example best, myself.
|
As per @sarahmonster's description.
Agreed. I've updated the PR to match:
|
|
Looks good, Kjell! |
* Establish explicit naming convention for blocks in UI & docs. See #16118. * Elaborate on sentence format for block descriptions. Vaguely related: #16002. * Update docs/designers-developers/designers/block-design.md Co-Authored-By: Marcus Kazmierczak <marcus@mkaz.com> * Minor copyedit to Block Description section.
|
I dusted off this old PR and fixed the failing tests. Would someone mind giving it another look? |
|
Just tested again. Everything looks right. Block Settings
Ungrouping option
Grouping option
|
|
Reviewed in Gutenberg triage and we all agreed that a simple description with easy to understand words can be very helpful. The description should also follow the naming convention mentioned above by @sarahmonster: Our block descriptions tend to use the action + subject format Few suggestions:
Also, descriptions shouldn't use exclamation marks |
|
Here is the link to the discussion we had during the Gutenberg Design Triage session. (Slack registration required.) |
|
Switching to this branch basically took down my local site. It's an old PR, can we get a rebase, @kjellr ? |
Oof — I just tried to sync this up with I'm heading out for a short vacation, but I'll add this to my list for when I return. If someone else wants to pick it up before I get back, you're more than welcome to! |
|
I can pick this up real quick with a new PR. |
|
With the new PR created, #24297, I'm going to close this one out. |
This PR includes two small changes:
1. Updated Group Block description
The current description is:
... which is a bit unfortunate because it includes the word "Group" in it. 😄 This PR updates that to:
Other suggestions are welcome!
2. Updated "Group" and "Ungroup" labels
This came up in #15602 (comment). I'm not 100% sure this is necessary, or if I'm overthinking it. I'd definitely love feedback on this too.
Updates:
(Note that these screenshots are using the icons from #16001)