Port wpcom-block-description-links from ETK

[taipeicoder]

Related to https://github.com/Automattic/dotcom-forge/issues/8037.

Proposed changes:

Port the wpcom-block-description-links feature from ETK, which adds a block description link in the Settings panel. See for example:

If the Help Center is available, clicking the link will open the Help Center. Otherwise, it will take users to the block's support article.

Note

I did not port the use of localeUrl() since it was more complicated than I thought. As a result, the link URL will always link to the English version. This seems like an acceptible compromise since the support page already has links to other languages in it header.

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:

• Head to Site Editor.
• Insert a block such as the Image Block or the List Block.
• Open the Settings panel and select the Block tab.
• Ensure that the Block Guide link is as shown in the screenshot above.
• Ensure that clicking the link opens the Help Center.

[github-actions]

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 etk/wpcom-block-description-links 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 etk/wpcom-block-description-links
  

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]

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.

---

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

[arthur791004]

Tested and works as expected!

[fushar]

I did not port the use of localeUrl() since it was more complicated than I thought. As a result, the link URL will always link to the English version. This seems like an acceptible compromise since the support page already has links to other languages in it header.

Haven't reviewed the PR/code, but to me this makes sense. Let's make sure we communicate this to HEs (maybe in the PT status update), to see whether it's a hard requirement (in which case, we need to prioritize accordingly).

[taipeicoder]

I did not port the use of localeUrl() since it was more complicated than I thought. As a result, the link URL will always link to the English version. This seems like an acceptible compromise since the support page already has links to other languages in it header.

Haven't reviewed the PR/code, but to me this makes sense. Let's make sure we communicate this to HEs (maybe in the PT status update), to see whether it's a hard requirement (in which case, we need to prioritize accordingly).

Excellent point! I'll add it to the PT 🙂