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

Global Styles: Add Help Link to Plan Limitation Message #39226

Merged
merged 7 commits into from
Sep 24, 2024

Conversation

epeicher
Copy link
Contributor

@epeicher epeicher commented Sep 4, 2024

Resolves Automattic/wp-calypso#93401

Proposed changes:

  • Adds a new link to the plan limitation notice message on the editor
Before After Clicking the link
Site Editor CleanShot 2024-09-05 at 13 35 39@2x CleanShot 2024-09-06 at 11 41 28@2x CleanShot 2024-09-06 at 11 41 45@2x
Post Editor CleanShot 2024-09-23 at 18 33 16@2x CleanShot 2024-09-23 at 18 31 16@2x CleanShot 2024-09-23 at 18 32 46@2x

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

  • Apply these changes using the instructions below
  • Navigate to a site that has a lower than Premium plan, e.g. free
  • Sandbox your environment. If you are using a Simple Site, sandbox the site
  • Navigate to the Styles editor, make sure your site has a theme that allows it, for example Twenty Twenty Four theme. The URL should be https://<your-site>/wp-admin/site-editor.php?path=%2Fwp_global_styles
  • Change the Style and click on the main editor to open it
  • Check the top notice is displayed, and it contains a new link Learn more. Click on the link and check the Help Center opens with the URL https://wordpress.com/support/using-styles/#access-to-styles
  • Save your changes

Copy link
Contributor

github-actions bot commented Sep 4, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the add/help-link-to-plan-limitation-message branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/help-link-to-plan-limitation-message
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

Copy link
Contributor

github-actions bot commented Sep 4, 2024

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Sep 4, 2024
miksansegundo
miksansegundo previously approved these changes Sep 6, 2024
Copy link
Contributor

@miksansegundo miksansegundo left a comment

Choose a reason for hiding this comment

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

LGTM 👍

I'm not sure about using the question mark icon (?) in the "Learn more" link because we don't seem to use it.

See for reference:

Screenshot 2567-09-06 at 12 54 22 Screenshot 2567-09-06 at 12 48 47 Screenshot 2567-09-06 at 12 54 32

Follow-up improvement

Opening the help center within the editor would be a nice improvement. See an example here that is using the component DescriptionSupportLink.

For another reference, see the component InlineSupportLink but that lives in Calypso.

@epeicher
Copy link
Contributor Author

epeicher commented Sep 6, 2024

Thanks, @miksansegundo, for the recommendations. I have followed your suggestions, and I have been able to display the URL of the link on the Help Center as part of these changes: 9c412ad. The PR is ready for another review 🙌

@mmtr, @taipeicoder, it would be great if you could review the changes as you have been involved in some previous changes related to this functionality 🙏

Copy link
Member

@mmtr mmtr left a comment

Choose a reason for hiding this comment

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

Works great! But I think we need to revisit how the warning looks in the post editor. We display different actions there, and the addition of the new "Learn more" action looks a bit off:

Screenshot 2024-09-12 at 17 56 28

I think we can probably remove the "Remove premium styles" action, since it links to a section that users can already find via the new "Learn more" action.

@epeicher
Copy link
Contributor Author

Thanks for your suggestion, @mmtr! I agree with that. It looks off, and both actions, Remove premium styles and Learn more open a similar link, so I will go ahead and remove the Remove premium styles link from the post editor.

This is because the new Learn More link covers that functionality
@epeicher
Copy link
Contributor Author

Hi @mmtr, I have applied your suggestions that apply to the Post editor as part of 0a4afe3 and the changes are ready for another review.

As you can see, I have also removed the leftovers after the changes. I have checked that they are not used, but please let me know if you find any regressions or other potential changes that could be done. Thanks!

@epeicher epeicher added the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Sep 23, 2024
mmtr
mmtr previously approved these changes Sep 24, 2024
Copy link
Member

@mmtr mmtr left a comment

Choose a reason for hiding this comment

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

Works great! Just left a minor note about removing some unused code.

@epeicher epeicher merged commit 49ec30f into trunk Sep 24, 2024
55 checks passed
@epeicher epeicher deleted the add/help-link-to-plan-limitation-message branch September 24, 2024 15:41
@epeicher epeicher removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] In Progress [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Sep 24, 2024
@epeicher
Copy link
Contributor Author

I have done a quick testing in atomic sites after the release p1727207048460609-slack-C05GLGHLM8U, and I have not found any issues 🙌

gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* Add Help Link to Premium Styles Plan Limitation Message

* changelog

* Global Styles: Add Learn More to premium styles notice

* Use Help Center to display the Learn More support link

* Remove reset styles support link in Post editor

This is because the new Learn More link covers that functionality

* Remove unused CSS styles
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Help Link to Premium Styles Plan Limitation Message
3 participants