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

Link to external documentation in Pattern creation snackbar #33481

Open
critterverse opened this issue Jul 15, 2021 · 8 comments
Open

Link to external documentation in Pattern creation snackbar #33481

critterverse opened this issue Jul 15, 2021 · 8 comments
Labels
[Block] Block The "Reusable Block" Block [Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced Needs Design Feedback Needs general design feedback. [Type] Enhancement A suggestion for improvement.

Comments

@critterverse
Copy link
Contributor

critterverse commented Jul 15, 2021

Follow up to #32464

Since the Welcome Guide in the above PR is only accessible from a temporary snack bar shown after the Reusable block is saved, it would be helpful to provide more information about the Reusable block earlier in the editing process.

block-description-1

Making use of the existing block description in the Settings sidebar, it would be great to link out to external documentation about using Reusable blocks: https://wordpress.org/support/article/reusable-blocks/

@kellychoffman
Copy link
Contributor

For the amount of content shown, it could be a bit disruptive. We should better utilize the block description area for informing and educating users. We can add a link off to learn more within there as well. I'd reserve this guide for something that is multi page or introduces a larger change.

@critterverse critterverse changed the title One-time Welcome Guide shown upon Reusable block creation Link to external documentation in Reusable block description Jul 27, 2021
@critterverse
Copy link
Contributor Author

We should better utilize the block description area for informing and educating users.

Like this idea! I've updated the issue title and description.

@kellychoffman
Copy link
Contributor

Not to open a can of worms but: Would this be even more clear if the name of the block was called something else that more reflected what it does? How about Synced Block?

@simison
Copy link
Member

simison commented Aug 11, 2021

Reminds me of adding a declarative way to add support links for any block: #11330

@paaljoachim
Copy link
Contributor

It is a good idea to bring in a link to documentation in the Reusable block description area!
As it can give some help to users who are wondering about how to use Reusable blocks.


Kelly. I have heard from a few people who mentioned that Reusable blocks is not a clear name for what is actually a global/synced block. Synced block is a good name for it. Anyhow that is a nice sidetrack to this issue...:)

@critterverse
Copy link
Contributor Author

critterverse commented Aug 30, 2021

Based on discussion taking place in #32464, I wanted to revisit some of the different options available that would help with this issue's goal of providing information about the Reusable block before the point of saving:

  • Linking to external documentation from the block description area (see issue description)
  • Linking to the Welcome Guide from the block description area
  • Linking to the Welcome Guide from the snack bar upon Reusable block creation

^ The Welcome Guide could also link to the external documentation which is a more robust resource.

I do like the idea of showing a "Learn more" link in the snack bar after both the block creation and block save — this might be helpful since it's only available temporarily and a lot of time could pass between creating and editing:

Snack bar copy Welcome guide copy
Reusable block created. Learn more You just created a Reusable block. When saved, other documents that include this block will be updated as well. To make local changes, try converting to regular blocks first.
Reusable block saved. Learn more You just saved a Reusable block. Any other documents that include this block have been updated to reflect this change. To make local changes, try converting to regular blocks first.

But using the block description area would have the advantage of the link being more discoverable. Thoughts?

@paaljoachim
Copy link
Contributor

A couple of things.

I suggest we add the snackbar notification with a Learn more to when the user initially creates a Reusable block. As suggested in this comment: #32464 (comment)
Removing it away from when saving a Reusable block.


The sidetrack...
Regarding Synced block: Matias opened this issue: #34352
Changing the name Reusable block into Synced block.

@paaljoachim
Copy link
Contributor

Hey @critterverse Channing.

I would suggest in the description to only link to the Welcome Guide (getting people used to having it available).
Then in the Welcome Guide for additional information there can be a link to external documentation.

Having a Learn more in the snack bar for creating a Reusable block and perhaps also for saving a Reusable block gives people the additional chance to click the link and enter the Welcome Guide area.

Using the Welcome Guide as a quick tip area to where they get shorter tips as well as an external link to more information.

@jordesign jordesign added [Type] Enhancement A suggestion for improvement. [Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced labels Aug 18, 2023
@jordesign jordesign changed the title Link to external documentation in Reusable block description Link to external documentation in Pattern creation snackbar Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Block The "Reusable Block" Block [Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced Needs Design Feedback Needs general design feedback. [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

No branches or pull requests

5 participants