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

Document template parts used by the Classic Template block #48183

Merged
merged 9 commits into from
Jun 12, 2024

Conversation

Aljullu
Copy link
Contributor

@Aljullu Aljullu commented Jun 5, 2024

Changes proposed in this Pull Request:

This PR updates the documentation of the Classic Template block so:

  1. We unify two files where the documentation was split.
  2. We mention the template parts used by the Classic Template block, closing Document which templates parts are used by the Classic Template Placeholder block #47219. That documentation was requested by 3rd-party devs.
  3. We also mention PHP hooks which are run in the Classic Template block.
  4. We mention that we discourage both of those extensibility methods if they are not accompanied by specific blocks serving the same function in the blockified templates.

Closes #47219.

How to test the changes in this Pull Request:

  1. Read the documentation and make sure it's correct.

Changelog entry

  • Automatically create a changelog entry from the details below.
  • This Pull Request does not require a changelog entry. (Comment required below)
Changelog Entry Details

Significance

  • Patch
  • Minor
  • Major

Type

  • Fix - Fixes an existing bug
  • Add - Adds functionality
  • Update - Update existing functionality
  • Dev - Development related task
  • Tweak - A minor adjustment to the codebase
  • Performance - Address performance issues
  • Enhancement - Improvement to existing functionality

Message

Changelog Entry Comment

Comment

@Aljullu Aljullu added focus: template Issue related to WooCommerce templates. team: Kirigami & Origami WC Store Editing (FSE) labels Jun 5, 2024
@Aljullu Aljullu self-assigned this Jun 5, 2024
@github-actions github-actions bot added the plugin: woocommerce Issues related to the WooCommerce Core plugin. label Jun 5, 2024
@Aljullu Aljullu changed the title Fix/47219 classic template block template parts Document template parts used by the Classic Template block Jun 5, 2024
Copy link
Contributor

github-actions bot commented Jun 5, 2024

Test using WordPress Playground

The changes in this pull request can be previewed and tested using a WordPress Playground instance.
WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Test this pull request with WordPress Playground.

Note that this URL is valid for 30 days from when this comment was last updated. You can update it by closing/reopening the PR or pushing a new commit.

@Aljullu Aljullu marked this pull request as ready for review June 5, 2024 14:16
@woocommercebot woocommercebot requested review from a team and imanish003 and removed request for a team June 5, 2024 14:17
@Aljullu Aljullu requested a review from WunderBart June 5, 2024 14:17
Copy link
Contributor

github-actions bot commented Jun 5, 2024

Hi @WunderBart, @imanish003,

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

Copy link
Contributor

@imanish003 imanish003 left a comment

Choose a reason for hiding this comment

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

Hey @Aljullu,

Thanks for improving the documentation of the Classic Template block. I've reviewed the changes and they look good to me. I've left a few minor suggestions. I am pre-approving this PR so you can merge it once the suggestions are addressed 🚀

Aljullu and others added 4 commits June 11, 2024 15:51
…README.md

Co-authored-by: Manish Menaria <the.manish.menaria@gmail.com>
…classic-template.md

Co-authored-by: Manish Menaria <the.manish.menaria@gmail.com>
@Aljullu Aljullu merged commit 54854f1 into trunk Jun 12, 2024
14 checks passed
@Aljullu Aljullu deleted the fix/47219-classic-template-block-template-parts branch June 12, 2024 07:36
@github-actions github-actions bot added this to the 9.1.0 milestone Jun 12, 2024
@github-actions github-actions bot added the needs: analysis Indicates if the PR requires a PR testing scrub session. label Jun 12, 2024
@Stojdza Stojdza added status: analysis complete Indicates if a PR has been analysed by Solaris and removed needs: analysis Indicates if the PR requires a PR testing scrub session. labels Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
focus: template Issue related to WooCommerce templates. plugin: woocommerce Issues related to the WooCommerce Core plugin. status: analysis complete Indicates if a PR has been analysed by Solaris team: Kirigami & Origami WC Store Editing (FSE)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document which templates parts are used by the Classic Template Placeholder block
4 participants