-
Notifications
You must be signed in to change notification settings - Fork 109
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
Feature/ #636 Module Specific Readme Files #664
Feature/ #636 Module Specific Readme Files #664
Conversation
…ded in later commits.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@10upsimon Can you please limit the changes here to just the WebP Uploads module? Other modules to deploy as standalone plugins will be handled in a separate issue.
.gitattributes
Outdated
/modules/images/dominant-color/readme.txt export-ignore | ||
/modules/images/fetchpriority/readme.txt export-ignore | ||
/modules/images/webp-support/readme.txt export-ignore | ||
/modules/images/webp-uploads/readme.txt export-ignore |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The requirements state to only add a readme for WebP Uploads as part of this issue. Let's stick to that and ignore all other modules.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@felixarntz I've changed this to a single 1 line glob pattern now, based on @joemcgill 's feedback so that we can match current and future readme.txt
files
/modules/**/readme.txt export-ignore
Let me know if this is good, or if you want me to specifically define it as webp-uploads only, and single out modules in the future.
@felixarntz I've addressed your comment RE restricting this to Once @mukeshpanchal27 's PR at #662 is approved and merged, I'll enhance the CLI command to handle the copy of the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@10upsimon Thank you for the updates. I think there is a misunderstanding here, as the standalone plugins will be in fact standalone. They should not be branded/marketed as extensions to the Performance Lab plugin.
Right now, as part of Milestone 1 (see #656), they will exist in both places, as a standalone plugin and as a module in the Performance Lab plugin. But once we're done with Milestone 2, they will only exist as standalone plugin.
Using Performance Lab alongside them is perfectly fine and we would still encourage users to use Performance Lab if they want to follow along what the performance team is working on. But someone that wants to just use WebP would be perfectly fine to only install this plugin on its own.
Regarding the dependency on #662, I don't think we technically have to wait for that PR. Once this PR is finalized, it can be merged as is, since #662 will copy the entire directory already, so the readme.txt
here will be included.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @10upsimon, I left one minor suggestion, and could you please remove the readme.txt
file for sqlite?
…Press/performance into feature/creating-standalone-plugins
…-module-specific-readme-files
@mukeshpanchal27 @felixarntz many thanks for your feedback and comments. I believe I have addressed them all and have requested a re-review of the PR. I confirm the readme.txt was copied across as expected with @mukeshpanchal27 latest merge of #662 @felixarntz |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @10upsimon, The changes look good to me.
Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@10upsimon This is pretty much good to go now, just one small thing and one slightly bigger thing. It would be great if you could expand the description just a tiny bit to explain a bit more clearly what the plugin does.
We can also iterate in a follow up if you prefer for just that content, in order to unblock this PR. Let me know what you prefer.
Co-authored-by: Felix Arntz <felixarntz@users.noreply.github.com>
…om:WordPress/performance into add/issue-636-module-specific-readme-files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@10upsimon Thank you for the updates, LGTM!
Summary
Addresses #636
Relevant technical choices
readme.txt
file to thewebp-uploads
module folder for copying over to the relevant build directory as per the work carried out in CLI command for a build process to transform modules into standalone plugins #662 .readme.txt
files in all performance plugin module folders forexport-ignore
via.gitattributes
glob pattern match.Checklist
[Focus]
orInfrastructure
label.[Type]
label.no milestone
label.