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

Establish consistency with notices and callouts #89

Open
ndiego opened this issue Feb 22, 2024 · 2 comments
Open

Establish consistency with notices and callouts #89

ndiego opened this issue Feb 22, 2024 · 2 comments
Assignees
Labels
[Component] Content Bugs or issues related to the page content Redesign

Comments

@ndiego
Copy link
Member

ndiego commented Feb 22, 2024

Notices and callouts throughout the content of the Documentation section are inconsistent, and I have not found any that use the built-in Notice block.

Example 1 Example 2
image image
Example 3 Example 4
image image

The Notice block provides four different options (tip, notice, alert, warning) and uses the approved colors and iconography. We should update all notices and callouts to use the Notice block and update any Docs procedures to remind contributors to use the Notice block.

Here is a quick edit demonstrating the update. During this process, we should also try to ensure the Notice block is used sparingly. There are pages that have 10+ notices/callouts that may or may not be needed.

Before After
image image
@ndiego ndiego added [Component] Content Bugs or issues related to the page content Redesign labels Feb 22, 2024
@ndiego ndiego self-assigned this Feb 22, 2024
@ndiego ndiego moved this to 📋 To do in WordPress.org Feb 22, 2024
@estelaris
Copy link
Member

@ndiego is this something can be changed with code or do we need to change them manually?

@ndiego
Copy link
Member Author

ndiego commented Feb 29, 2024

It would be a manual process. But I don't think it would take more than an hour or so. I am happy to do it. More importantly, we just need to make sure the Notice block is used for all future notices/callouts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Component] Content Bugs or issues related to the page content Redesign
Projects
Status: 📋 To do
Development

No branches or pull requests

2 participants