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

Jetpack-mu-wpcom: Simplify the Help Center translations #38300

Merged
merged 7 commits into from
Jul 11, 2024

Conversation

alshakero
Copy link
Member

@alshakero alshakero commented Jul 11, 2024

Follow up on #38284

Proposed changes:

As @anomiex explained in #38284, including built translations files is cumbersome and forces us to 1) maintain them 2) redeploy again when they change 3) sync to Atomic to see their changes during dev.

This PR aims to load translations via HTTPS directly from the horse's mouth.

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?

No.

Testing instructions:

  1. Sync jetpack-mu-wpcom to your sandbox.
  2. Make sure translations work by changing locale and opening the Help Center.
Copy link
Contributor

github-actions bot commented Jul 11, 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.


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.


Wpcomsh plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 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 [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 Jul 11, 2024
Copy link
Contributor

github-actions bot commented Jul 11, 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 simplify/help-center-translations 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 simplify/help-center-translations
    

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
@alshakero alshakero marked this pull request as ready for review July 11, 2024 10:51
Copy link
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

Thanks for looking into this!

remove_filter( 'pre_determine_locale', array( $this, 'determine_iso_639_locale' ) );
// Load translations directly from widgets.wp.com.
wp_enqueue_script(
'help-center-translations',
Copy link
Contributor

Choose a reason for hiding this comment

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

Does ordering matter?

With the old code, the <script> with the translations for the 'help-center' script would be output into the page first, then the wp_add_inline_script( 'help-center', ..., 'before' ), then the <script> for 'help-center' itself.

With this new code, I think there's no constraint on whether the 'help-center-translations' <script> comes before or after 'help-center'. If the ordering matters, adding 'help-center-translations' to the dependencies array of 'help-center' should be enough to make 'help-center-translations' come first.

Copy link
Member Author

Choose a reason for hiding this comment

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

I tested and it does! Translations should be added first. I fixed that now.

// Load translations directly from widgets.wp.com.
wp_enqueue_script(
'help-center-translations',
'https://widgets.wp.com/help-center/languages/' . self::determine_iso_639_locale() . '-v1.js',
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like D155011-code accidentally reverted the the files you had added in D155004-code that you're trying to use here.

Copy link
Member Author

@alshakero alshakero Jul 11, 2024

Choose a reason for hiding this comment

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

What a catch, yes because I deployed my translations from a branch, not trunk, to make testing this easier. It shouldn't happen after Automattic/wp-calypso#92593 is merged.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll redeploy them to help test this.

Copy link
Member Author

Choose a reason for hiding this comment

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

They're live now.

anomiex
anomiex previously approved these changes Jul 11, 2024
Copy link
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

Change itself looks reasonable to me, and tests well.

Should this in the readme be updated too?

### Translations
Translation are download from `widgets.wp.com/help-center/languages` during `jetpack-mu-plugin` build process. Please cd into `projects/packages/jetpack-mu-wpcom` and run:
1. pnpm run build-production-js
2. jetpack rsync mu-wpcom-plugin
This will update the translations files.

@escapemanuele escapemanuele self-requested a review July 11, 2024 17:36
Copy link
Contributor

@escapemanuele escapemanuele left a comment

Choose a reason for hiding this comment

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

Tested and translation were working great ✌️

@github-actions github-actions bot added the Docs label Jul 11, 2024
@alshakero alshakero merged commit e76624a into trunk Jul 11, 2024
54 checks passed
@alshakero alshakero deleted the simplify/help-center-translations branch July 11, 2024 18:15
@github-actions github-actions bot removed [Status] In Progress [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment