Directory

Styles: More descriptive text for revisions timeline by sacerro · Pull Request #55868 · WordPress/gutenberg · GitHub
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

Styles: More descriptive text for revisions timeline #55868

Merged
merged 4 commits into from
Nov 14, 2023

Conversation

sacerro
Copy link
Contributor

@sacerro sacerro commented Nov 5, 2023

What?

Fixes #55648. Made in WordCamp Madrid 2023

Why?

Current text needs more context. Proposed text fits better.

How?

Replaced old text by new one proposed.

Testing Instructions

  1. Open Theme Editor
  2. Go to "Styles"
  3. Change anything (a change is needed to display changes timeline)
  4. Open revisions
  5. Check if the new text appears.

Testing Instructions for Keyboard

N/A

Screenshots or screencast

image

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Nov 5, 2023
Copy link

github-actions bot commented Nov 5, 2023

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @sacerro! In case you missed it, we'd love to have you join us in our Slack community, where we hold regularly weekly meetings open to anyone to coordinate with each other.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

@cbravobernal cbravobernal added Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json [Type] Code Quality Issues or PRs that relate to code quality [Type] Copy Issues or PRs that need copy editing assistance and removed [Type] Code Quality Issues or PRs that relate to code quality Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json labels Nov 5, 2023
@@ -95,7 +95,7 @@ function ScreenRevisions() {
<ScreenHeader
title={ __( 'Revisions' ) }
description={ __(
'Revisions are added to the timeline when style changes are saved.'
'Restore styles from an earlier version of changes that was automatically added to this timeline when new styles were saved.'
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for the PR!

The three clauses make it a bit of a mouthful in my opinion.

If we're seeking both clarity and guidance as mentioned in the issue, maybe we could:

  1. describe what the user is looking at (the clarity)
  2. provide instruction on how to restore styles (the guidance).

Not being prescriptive, these are just ideas. Language is fuzzy 😄

E.g.,

This is pretty verbose:

Click on previously saved styles to preview them. To restore a selected version to the editor, hit "Apply". When you're ready, save the template to commit your changes.

A bit more condensed:

A timeline of saved changes to your site's styles. Click "Apply" to restore a selected version in the editor.

What do you reckon?

As a heads up, the revisions panel will be getting a UX makeover soon: #55776

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think the verbose option is the best. It explains better to the user what this panel do.
What do you think @pablohoneyhoney?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I replace the text by the one you suggested 💪

Choose a reason for hiding this comment

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

@sacerro wording looks good on the longer option, but the period needs to go inside the quotation mark like so:

Click on previously saved styles to preview them. To restore a selected version to the editor, hit "Apply." When you're ready, save the template to commit your changes.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks @provenself

I've updated the copy to reflect the latest changes.

Screenshot 2023-11-09 at 10 59 11 am

I'll merge this PR.

Thanks also to @sacerro !

@ramonjd ramonjd added the Needs Copy Review Needs review of user-facing copy (language, phrasing) label Nov 5, 2023
@sacerro sacerro requested a review from ramonjd November 7, 2023 10:44
Co-authored-by: Ramon <ramonjd@users.noreply.github.com>
@sacerro sacerro requested a review from ramonjd November 8, 2023 13:46
@ramonjd ramonjd enabled auto-merge (squash) November 9, 2023 00:00
@ramonjd
Copy link
Member

ramonjd commented Nov 14, 2023

Sorry, I'd set this to auto merge, but I think forgot to approve 🤦🏻

Thanks for your patience!

Copy link
Member

@ramonjd ramonjd left a comment

Choose a reason for hiding this comment

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

👍🏻

@ramonjd ramonjd merged commit c64d93b into WordPress:trunk Nov 14, 2023
50 checks passed
@github-actions github-actions bot added this to the Gutenberg 17.1 milestone Nov 14, 2023
@oandregal oandregal added the [Type] Enhancement A suggestion for improvement. label Nov 16, 2023
Copy link

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
  • Labels found: [Type] Enhancement, [Type] Copy, Needs Copy Review, First-time Contributor, Global Styles.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json Needs Copy Review Needs review of user-facing copy (language, phrasing) [Type] Copy Issues or PRs that need copy editing assistance [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Styles: Revisions Description Text
5 participants