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

Boost: Add "load default strings" to excludes in concatenate UI #40496

Open
wants to merge 9 commits into
base: trunk
Choose a base branch
from

Conversation

dilirity
Copy link
Member

@dilirity dilirity commented Dec 6, 2024

Proposed changes:

  • Add a button, similar to cornerstone pages, that loads default exclude values for concatenate JS and CSS;
  • Clean up CSS in minify component.

CleanShot 2024-12-06 at 16 59 15

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

n/a

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

no

Testing instructions:

  • Setup Boost;
  • Make sure concatenate JS/CSS UI is behaving as expected.

@dilirity dilirity added Admin Page React-powered dashboard under the Jetpack menu [Status] Needs Team Review [Plugin] Boost A feature to speed up the site and improve performance. [Boost Feature] Minify labels Dec 6, 2024
@dilirity dilirity added this to the boost/next milestone Dec 6, 2024
@dilirity dilirity requested a review from a team December 6, 2024 15:00
@dilirity dilirity self-assigned this Dec 6, 2024
Copy link
Contributor

github-actions bot commented Dec 6, 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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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!


Boost plugin:

  • Next scheduled release: none scheduled.

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 Dec 6, 2024
@dilirity dilirity added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Dec 6, 2024
Copy link
Contributor

@donnchawp donnchawp left a comment

Choose a reason for hiding this comment

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

Some minor things, but looks good otherwise.

className={ styles.button }
variant="link"
>
{ __( 'Load default strings', 'jetpack-boost' ) }
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd much rather we didn't use "strings" here or in the sub header. Yes, they literally are strings, but they're the handles used to register JS and CSS files. Strings describes what those pixels on the screen are, not what they do or represent
.
Maybe use "scripts" instead? "JS Scripts" "CSS Scripts" ?

I'm not sure. Could be a job for another PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree. The values aren't just strings. They are handles. I'd suggest calling them "default handles" as well.

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 don't mind calling them handles, I'm worried that a lot of users have no idea what that means. We're mentioning strings everywhere.

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed in 34fde9b.

We should probably change the labels as well.

Copy link
Contributor

Choose a reason for hiding this comment

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

I should have looked more carefully at the modules.

In the JS module:

  1. "Scripts" is used to describe the files loaded.
  2. The toggle says, "Exclude JS Strings".
  3. The sub header says, "Exclude JS Strings".

In the CSS module:

  1. "Styles" is used to describe the files loaded.
  2. The toggle says, "Exclude CSS Strings".
  3. The sub header says, "Exclude CSS Strings".

This patch adds a button saying, "Load default handles".

Would it be better to use "scripts" in the JS module, and "styles" in the CSS module? This is what it might look like:

Screenshot 2024-12-11 at 12 06 48

Copy link
Member Author

Choose a reason for hiding this comment

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

What if we drop "Scripts/Styles" from the label and just say "Exclude JS" or "Exclude CSS".

Then we could update the description to say "handles" and maybe add a link to a support article that mentions how to identify those? Then the button will be "Load default handles".

Copy link
Contributor

Choose a reason for hiding this comment

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

That makes sense when I say "JS scripts" out loud, as in "JavaScript scripts". It's a bit cumbersome.
I'd go one step further and change that last string to "Load Defaults" too. No need to confuse the user with new jargon.

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'd go one step further and change that last string to "Load Defaults" too.

Funny you should say that. I intentionally added what is being loaded (hence the strings part), since @haqadn pointed out that it's not clear what "Load defaults" loads when using the button when I initially added it to the dashboard in Cornerstone Pages.

Now I'm confused 😅

I also think we're getting a bit carried away with details.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think handle is fine considering this terminology is coming WP itself, Example.

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've updated the UI accordingly in 04a0dfd.

@dilirity dilirity requested review from donnchawp and haqadn December 11, 2024 09:02
Copy link
Contributor

@haqadn haqadn left a comment

Choose a reason for hiding this comment

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

Looks good to me. I did make some changes. Since I am the one who made the latest changes, leaving the approval to others.

Rationale behind my commit (b2c5854):
I wanted to keep the stores for CSS and JS separate. This will allow us to easily move the store registrations to individual modules, which we need to do soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Admin Page React-powered dashboard under the Jetpack menu [Boost Feature] Minify [Plugin] Boost A feature to speed up the site and improve performance. [Status] Needs Team Review [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants