Boost: documenting the filters used in the plugin
The existing documentation covering the filters used in the plugin are woefully out of date.
Fixes #36250
Proposed changes:
- Adding docs to docs/DEVELOPEMENT_GUIDE.md
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:
No testing required, but needs to be read and verified.
Thank you for your PR!
When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:
- :white_check_mark: Include a description of your PR changes.
- :white_check_mark: Add a "[Status]" label (In Progress, Needs Team Review, ...).
- :white_check_mark: Add testing instructions.
- :white_check_mark: Specify whether this PR includes any changes to data or privacy.
- :white_check_mark: 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 :robot:
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.
Boost plugin:
- Next scheduled release: June 4, 2024.
- Scheduled code freeze: May 27, 2024.
If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.
It looks like jetpack_boost_module_enabled has been completely removed. It only exists now in tests and the documentation.
@thingalon seeing is believing 😅 - the guide has fallen out of fashion multiple times. So yeah, I agree - documentation should probably go in code comments.
Is this ready for another review/merge @donnchawp ?
@haqadn no, I decided other PRs were more urgent and put this aside for now. Should I close it?
Since this is almost ready, lets finish this. @donnchawp