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

Review the wording of the pre-publish panel description when submitting for review as a contributor #65368

Closed
2 tasks done
afercia opened this issue Sep 16, 2024 · 16 comments · Fixed by #67328
Closed
2 tasks done
Assignees
Labels
Needs Design Needs design efforts. [Package] Editor /packages/editor [Status] In Progress Tracking issues with work in progress [Type] Bug An existing feature does not function as intended

Comments

@afercia
Copy link
Contributor

afercia commented Sep 16, 2024

Description

When users with the contributor role submit a post for review, the pre-publish panel shows the following description:

Screenshot 2024-09-16 at 09 52 55

The description text is:

When you’re ready, submit your work for review, and an Editor will be able to approve it for you.

The wording assumes the other user who will review is an Editor. The uppercase E hints it's an user with role editor, which may or may not be true. Actually, any user with the publish capability may review and publish. Instead, the current wording assumes it's an Editor role. This is inaccurate and should be changed.

Minor:
I'm not sure When you’re ready at the beginning of the sentence is necessary. As a contributor user I already clicked the first button 'Submit for Review`. It's likely I already determined I'm ready to submit.

Step-by-step reproduction instructions

  • Log in as a contributor.
  • Create a new post and click Submit for Review.
  • Observe the pre-publish check description.

Screenshots, screen recording, code snippet

No response

Environment info

No response

Please confirm that you have searched existing issues in the repo.

  • Yes

Please confirm that you have tested with all plugins deactivated except Gutenberg.

  • Yes
@afercia afercia added [Type] Bug An existing feature does not function as intended Needs Design Needs design efforts. [Package] Editor /packages/editor labels Sep 16, 2024
@sarthaknagoshe2002
Copy link
Contributor

@afercia I have come up with some suggestions to modify the message

  1. "Your work will be submitted for review, and a user with publishing permissions will be able to review and approve it for you."
  2. "Submit your work for review. A user with publishing permissions will review and approve it."
  3. "Submit for review. A user with publishing capabilities will handle your submission."
  4. "Once submitted, your post will be reviewed and approved by someone with publishing rights."

I personally feel the 1st one will be good for the following reasons

  • The Tone matches WordPress's overall user-friendly style—professional but approachable tone.
  • Since the meaning is well elaborated it is Localization-Friendly.

To enhance this further we can make the message dynamic.
Example:-
"Since you are a {role}, your work will be submitted for review, and a user with publishing permissions will be able to review and approve it for you."

I'll be raising a PR for the 1st suggestion with the suggested enhancement, however we can always change if we feel the need to.

@hanneslsm
Copy link

Good suggestions.

I think we can shorten it to:
'A user with publishing permissions can review and approve it.'

It's not necessary to add the role and repeat that it will be submitted for review, because that's already said in the button and heading.
I fell like "can" is easier to understand than "will be able to"

@sarthaknagoshe2002
Copy link
Contributor

@hanneslsm On it.

@sarthaknagoshe2002
Copy link
Contributor

Just a suggestion, we can also keep it as user with publishing permissions can review and approve it for you.

@afercia
Copy link
Contributor Author

afercia commented Nov 28, 2024

Thanks all for looking into this. Personally, I'd prefer the shorter version.
It's likely that users who will see this message do work in an editorial context and they're already educated to the review process. I'd expect they do know they're submitting for review to someone else with higher permissions.

@sarthaknagoshe2002
Copy link
Contributor

@afercia
Given the context that users likely understand the editorial process and know they are submitting content for review to someone with higher permissions, here are some alternatives that i could think of:

  1. "Your post will be reviewed by a user with higher permissions."
  2. "A user with publishing permissions can review and approve your work."
  3. "Your content is ready for review. A team member will review and approve it for publishing."

@afercia
Copy link
Contributor Author

afercia commented Nov 28, 2024

Good suggestions. What about entirely avoiding to mention other users? Something like:

Submit your work and it will be reviewed and approved.

@sarthaknagoshe2002
Copy link
Contributor

I feel using the word "user" is necessary since, now-a-days it can be assumed that the post can be reviewed by an AI tool too.

@sarthaknagoshe2002
Copy link
Contributor

also as @hanneslsm said we should avoid using "Submit your work" since that will introduce redundancy

@afercia
Copy link
Contributor Author

afercia commented Nov 29, 2024

IMHO, any reference to user with publishing permissions or user with higher permissions and similar would make the message unnecessarily complicated:

  • Average users may not even know or fully understand what a permission is.
  • Users familiar with an editorial flow (thinking at users working in an editorial team) already know someone else is in charge to review and approve.

Overall, I'd think the message should avoid technical terms and just commuicate the concept 'submit and it will be reviewed'.

@sarthaknagoshe2002
Copy link
Contributor

What about

  1. `your work will be submitted for review and will be approved.
  2. `your work will be reviewed and then approved.

@afercia
Copy link
Contributor Author

afercia commented Dec 2, 2024

👍🏻 for 2 from my side. The shorter, the better.

@sarthaknagoshe2002
Copy link
Contributor

@afercia On it.

@sarthaknagoshe2002
Copy link
Contributor

I have updated the code.

@afercia
Copy link
Contributor Author

afercia commented Dec 4, 2024

Thanks @sarthaknagoshe2002 ! Can you please add 'before and after' screenshots on the PR #67328 so that other contributors can quickly check the change? Thanks!

@sarthaknagoshe2002
Copy link
Contributor

@afercia I have updated the PR description.
Please have a look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Design Needs design efforts. [Package] Editor /packages/editor [Status] In Progress Tracking issues with work in progress [Type] Bug An existing feature does not function as intended
Projects
None yet
3 participants