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

SEO Upsell: update link to open in help center #39339

Merged
merged 12 commits into from
Sep 12, 2024
Merged

Conversation

eoigal
Copy link
Contributor

@eoigal eoigal commented Sep 10, 2024

Fixes https://github.com/Automattic/dotcom-forge/issues/8775

This will open the SEO tools upsell support post in the help center instead of in a new tab.
The support post is not localised as it is, so if the user has a non-English locale, the support post will open in English as things are.
This PR doesn't change this because adding support of localizeUrl into Jetpack is non-trivial as it comes with a lot of Calypso dependencies and would bloat Jetpack.
I think we can follow up with a PR like Automattic/wp-calypso#94492 to ensure the post URL is localised.

Proposed changes:

  • Updates the SEO upsell link to open help center with the SEO upsell post

Example

Screenshot 2024-09-11 at 16 42 05

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:

  • Test on simple sandbox with bin/jetpack-downloader test jetpack add/seo-link-help-center
  • Go to post editor for a free site and follow the following video to confirm SEO upsell link loads in help center
Screen.Recording.2024-09-11.at.16.46.06.mov

Copy link
Contributor

github-actions bot commented Sep 10, 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/seo-link-help-center branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack add/seo-link-help-center
    

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

@github-actions github-actions bot added [Extension] SEO [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Sep 10, 2024
Copy link
Contributor

github-actions bot commented Sep 10, 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!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for October 1, 2024 (scheduled code freeze on September 30, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@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 10, 2024
@eoigal
Copy link
Contributor Author

eoigal commented Sep 12, 2024

I've looked into workarounds on getting a non-localised support link to work in help center.

I've looked at using the Jetpack redirects but the Jetpack links aren't handled by the help/article endpoint and you end up with an error like the below;
Screenshot 2024-09-11 at 22 17 25

I think the way to go would be to update the help center use-post-by-url to either pass the locale to the help/article endpoint or use the localizeUrl function to update the post URL to it's localised version.

@eoigal eoigal added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and 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 labels Sep 12, 2024
arcangelini
arcangelini previously approved these changes Sep 12, 2024
Copy link
Contributor

@arcangelini arcangelini left a comment

Choose a reason for hiding this comment

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

Tested on simple site and it worked as expected. Added a couple of suggestions 👍

@eoigal eoigal merged commit 12cd610 into trunk Sep 12, 2024
57 checks passed
@eoigal eoigal deleted the add/seo-link-help-center branch September 12, 2024 20:51
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Sep 12, 2024
@github-actions github-actions bot added this to the jetpack/13.9 milestone Sep 12, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* SEO Upsell: update link to open in help center

* remove debug

* add changelog

* try without localizeUrl

* add localiseUrl to jetpack packages

* revert change to file

* needs yaml file

* remove css changes - not needed

* remove dependency on localiseUrl

* update to use getRedirectUrl

* remove the use of Jetpack redirects - not going to work with help center

* postId not needed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Extension] SEO [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants