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 descriptive text to post settings #1513

Closed
jwold opened this issue Jun 27, 2017 · 6 comments
Closed

Add descriptive text to post settings #1513

jwold opened this issue Jun 27, 2017 · 6 comments
Labels
[Feature] Document Settings Document settings experience

Comments

@jwold
Copy link

jwold commented Jun 27, 2017

@nb and I discussed the potential for adding descriptive text to each of the blocks in the core-editor channel. This text could be added into the post settings panel and would help explain each of the blocks with a line or two of text.

As a great example, I would imagine some users would have no idea what Classic Text means (it might make sense to revisit that label in another ticket). We had talked about adding tooltips to each of the blocks inside the inserter modal, but that doesn’t seem ideal.

Any feedback/thoughts on the annotations below?

annotation

@mtias
Copy link
Member

mtias commented Jun 27, 2017

I like this but on a per case basis (I added something very similar to the "more" block). I don't think all blocks would need it.

@mtias
Copy link
Member

mtias commented Jun 27, 2017

See #1440

@swissspidy
Copy link
Member

I did the same in #1467.

Can we put together a list of blocks that could benefit from such a description? We could then add those all in one swoop.

@jasmussen
Copy link
Contributor

In #2427 I've started work on this. Though I think it would be good to have a discussion: do we want descriptions for all blocks, or only some?

Back when we had the breadcrumb trail in the sidebar, I would have agreed with having it on a case by case basis. But now that we have an explicit "Block" tab that you can keep open, it feels like we should have descriptions for every single block, even to the point that if a block author didn't provide one, we should output: "This block did not provide a description", or something in that vein.

@jasmussen jasmussen added Design [Feature] Document Settings Document settings experience [Type] Question Questions about the design or development of the editor. labels Aug 18, 2017
@jwold
Copy link
Author

jwold commented Aug 22, 2017

I agree that descriptions on all the things makes more sense than being selective. I like that.

@karmatosed karmatosed removed the [Type] Question Questions about the design or development of the editor. label Sep 24, 2017
@mtias
Copy link
Member

mtias commented Oct 24, 2017

This can be considered done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Document Settings Document settings experience
Projects
None yet
Development

No branches or pull requests

5 participants