Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-blocks/docs/README.md

156 lines
10 KiB
Markdown
Raw Normal View History

Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
# WooCommerce Blocks Handbook <!-- omit in toc -->
## Table of Contents <!-- omit in toc -->
Update the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6601) * Update the WooCommerce Blocks Handbook Add 3 subsections to the Developer resources section and add the new tools we have availble * Grammar fixes
2022-06-21 13:41:30 +00:00
- [Contributors](#contributors)
- [Internal developers](#internal-developers)
- [Third-party developers](#third-party-developers)
- [Designers](#designers)
Fix list indentation for the Blocks Handbook
2022-06-21 13:43:23 +00:00
- [Developer Resources](#developer-resources)
Update MD editor config (https://github.com/woocommerce/woocommerce-blocks/pull/7968) * Remove MD from editor config. Prettier handles formatting. * Resave docs * Update MD files
2022-12-19 12:06:48 +00:00
- [Tools](#tools)
- [Articles](#articles)
- [Tutorials](#tutorials)
Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) * Move coding guideline and release docs to subdirectories * Strip down contributing md to link to new docs * Create main readme file to act as TOC * Getting started and testing docs from contributing.md * WP update testing checklist and docs for woocommerce/woocommerce-blocks#1285 * Update docs/contributors/smoke-testing.md Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * link to svn doc * Link to docs from readme * Resolve feedback * More consistent $ usage Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-01-31 12:48:11 +00:00
The WooCommerce Blocks Handbook provides documentation for designers and developers on how to extend or contribute to blocks, and how internal developers should handle new releases.
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
## Contributors
> Want to contribute to the WooCommerce Blocks plugin? The following documents offer information that can help you get started.
Adjust contributor docs (https://github.com/woocommerce/woocommerce-blocks/pull/9622) * Adjust contributor docs * Adjust contributor docs
2023-05-30 06:30:36 +00:00
- [Contributing](contributors/README.md)
- [Getting Started](contributors/getting-started.md)
- [Coding Guidelines](contributors/coding-guidelines.md)
- [Block Script Assets](contributors/block-assets.md)
- [CSS Build System](contributors/css-build-system.md)
- [JavaScript Build System](contributors/javascript-build-system.md)
- [JavaScript Testing](contributors/javascript-testing.md)
- [Storybook & Components](contributors/storybook-and-components.md)
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
## Internal developers
> Are you an internal developer? The following documents offer information about the different blocks, the Block Client APIs, the Store API, the templates and the testing process.
- [Blocks](internal-developers/blocks/README.md)
- [Stock Reservation during Checkout](internal-developers/blocks/stock-reservation.md)
- [Features Flags and Experimental interfaces](internal-developers/blocks/feature-flags-and-experimental-interfaces.md)
- [Block Data](../assets/js/data/README.md)
- [Collections Store](../assets/js/data/collections/README.md)
- [Query State Store](../assets/js/data/query-state/README.md)
- [Schema Store](../assets/js/data/schema/README.md)
- [Block Client APIs](internal-developers/block-client-apis/README.md)
- [Checkout API interface](internal-developers/block-client-apis/checkout/checkout-api.md)
- [Checkout Flow and Events](internal-developers/block-client-apis/checkout/checkout-flow-and-events.md)
- [Notices](internal-developers/block-client-apis/notices.md)
Add internal validation data store docs (https://github.com/woocommerce/woocommerce-blocks/pull/8100) * Add internal validation docs * Add TOC entries
2023-01-05 14:44:11 +00:00
- [Data store](internal-developers/data-store/README.md)
- [Validation](internal-developers/data-store/validation.md)
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
- [Editor Components](../assets/js/editor-components/README.md)
- [SearchListControl](../assets/js/editor-components/search-list-control/README.md)
- [Tag](../assets/js/editor-components/tag/README.md)
- [TextToolbarButton](../assets/js/editor-components/text-toolbar-button/README.md)
- [Icons](../assets/js/icons/README.md)
- [Store API (REST API)](../src/StoreApi/README.md)
- [Storybook](../storybook/README.md)
- [Templates](internal-developers/templates/README.md)
- [BlockTemplateController.php](internal-developers/templates/block-template-controller.md)
- [ClassicTemplate.php](internal-developers/templates/classic-template.md)
- [Classic Template Block](../assets/js/blocks/classic-template/README.md)
- [Testing](internal-developers/testing/README.md)
- [When to employ end to end testing](internal-developers/testing/when-to-employ-e2e-testing.md)
- [Smoke Testing](internal-developers/testing/smoke-testing.md)
- [Cart and Checkout Testing](internal-developers/testing/cart-checkout/README.md)
- [General Flow](internal-developers/testing/cart-checkout/general-flow.md)
- [Editor](internal-developers/testing/cart-checkout/editor.md)
- [Shipping](internal-developers/testing/cart-checkout/shipping.md)
- [Payments](internal-developers/testing/cart-checkout/payment.md)
- [Items](internal-developers/testing/cart-checkout/items.md)
- [Taxes](internal-developers/testing/cart-checkout/taxes.md)
- [Coupons](internal-developers/testing/cart-checkout/coupons.md)
- [Compatibility](internal-developers/testing/cart-checkout/compatibility.md)
- [Releases](internal-developers/testing/releases/README.md)
Update MD editor config (https://github.com/woocommerce/woocommerce-blocks/pull/7968) * Remove MD from editor config. Prettier handles formatting. * Resave docs * Update MD files
2022-12-19 12:06:48 +00:00
- [Translations](internal-developers/translations/README.md)
Clean up docs (https://github.com/woocommerce/woocommerce-blocks/pull/6550) * Link translation section to docs file * Delete duplicated docs * Move internal developer docs into corresponding folder * Correct merge conflict * Change ‘docs/testing/’ to ‘docs/internal-developers/testing’ * Fix visible \ and missing bulletpoint * Add missing testing notes
2022-06-20 17:04:41 +00:00
- [Translation basics](internal-developers/translations/translation-basics.md)
- [Translations in PHP files](internal-developers/translations/translations-in-PHP-files.md)
- [Translations in JS/TS files](internal-developers/translations/translations-in-JS-TS-files.md)
- [Translations in FSE templates](internal-developers/translations/translations-in-FSE-templates.md)
- [Translations for lazy-loaded components](internal-developers/translations/translations-for-lazy-loaded-components.md)
- [Translation loading](internal-developers/translations/translation-loading.md)
- [Translation management](internal-developers/translations/translation-management.md)
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
## Third-party developers
> Are you a third-party developer? The following documents explain how to extend the WooCommerce Blocks plugin with your custom extension.
- [Extensibility](third-party-developers/extensibility/README.md)
- Hooks
- [Actions](third-party-developers/extensibility/hooks/actions.md)
- [Filters](third-party-developers/extensibility/hooks/filters.md)
- REST API
- [Exposing your data in the Store API](third-party-developers/extensibility/rest-api/extend-rest-api-add-data.md)
- [Available endpoints to extend with ExtendSchema](third-party-developers/extensibility/rest-api/available-endpoints-to-extend.md)
Add readme file to extend-rest-api directory and move internal doc into internal folder (https://github.com/woocommerce/woocommerce-blocks/pull/10926) Co-authored-by: Niels Lange <info@nielslange.de>
2023-09-14 12:47:35 +00:00
- [Adding an endpoint to ExtendSchema](internal-developers/rest-api/extend-rest-api-new-endpoint.md)
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
- [Available Formatters](third-party-developers/extensibility/rest-api/extend-rest-api-formatters.md)
- [Updating the cart with the Store API](third-party-developers/extensibility/rest-api/extend-rest-api-update-cart.md)
- Checkout Payment Methods
- [Checkout Flow and Events](third-party-developers/extensibility/checkout-payment-methods/checkout-flow-and-events.md)
- [Payment Method Integration](third-party-developers/extensibility/checkout-payment-methods/payment-method-integration.md)
- [Filtering Payment Methods](third-party-developers/extensibility/checkout-payment-methods/filtering-payment-methods.md)
Update the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6601) * Update the WooCommerce Blocks Handbook Add 3 subsections to the Developer resources section and add the new tools we have availble * Grammar fixes
2022-06-21 13:41:30 +00:00
- Checkout Blocks
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
- [IntegrationInterface](third-party-developers/extensibility/checkout-block/integration-interface.md)
- [Available Filters](third-party-developers/extensibility/checkout-block/available-filters.md)
- [Slots and Fills](third-party-developers/extensibility/checkout-block/slot-fills.md)
- [Available Slot Fills](third-party-developers/extensibility/checkout-block/available-slot-fills.md)
- [DOM Events](third-party-developers/extensibility/checkout-block/dom-events.md)
- [Blocks Registry](../packages/checkout/blocks-registry/README.md)
- [Components](../packages/checkout/components/README.md)
- [Filter Registry](../packages/checkout/filter-registry/README.md)
- [Slot and Fill](../packages/checkout/slot/README.md)
- [Utilities](../packages/checkout/utils/README.md)
## Designers
> Are you a designer? The following documents explain how to apply design-changes to the WooCommerce Blocks plugin.
- [Theming](designers/theming/README.md)
Rename docs which unnecessary mention the All Products block (https://github.com/woocommerce/woocommerce-blocks/pull/9265) * Rename docs which unnecessary mention the All Products block * Fix two more links
2023-04-27 16:26:18 +00:00
- [Filter blocks](designers/theming/filter-blocks.md)
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
- [Cart and Checkout](designers/theming/cart-and-checkout.md)
- [Class names update in 4.6.0](designers/theming/class-names-update-460.md)
- [Class names update in 3.4.0](designers/theming/class-names-update-340.md)
- [Class names update in 3.3.0](designers/theming/class-names-update-330.md)
- [Class names update in 2.8.0](designers/theming/class-names-update-280.md)
- [Product grid blocks style update in 2.7.0](designers/theming/product-grid-270.md)
## Developer Resources
Update the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6601) * Update the WooCommerce Blocks Handbook Add 3 subsections to the Developer resources section and add the new tools we have availble * Grammar fixes
2022-06-21 13:41:30 +00:00
### Tools
Remove newsletter repo example from the docs (https://github.com/woocommerce/woocommerce-blocks/pull/8417) * Remove newsletter repo example from the docs The newsletter is not maintained anymore and we use the @woocommerce/extend-cart-checkout-block to showcase our extensibility points * Update docs/README.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> --------- Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com>
2023-02-13 17:24:17 +00:00
- [@woocommerce/extend-cart-checkout-block](https://www.npmjs.com/package/@woocommerce/extend-cart-checkout-block) This is a template to be used with @wordpress/create-block to create a WooCommerce Blocks extension starting point. It also showcases how to use some extensibility points, e.g. registering an inner block in the Checkout Block, applying filters to certain texts such as the place order button, using Slot/Fill and how to change the behaviour of the Store API.
Update the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6601) * Update the WooCommerce Blocks Handbook Add 3 subsections to the Developer resources section and add the new tools we have availble * Grammar fixes
2022-06-21 13:41:30 +00:00
### Articles
The following posts from [developer.woocommerce.com](https://developer.woocommerce.com/category/developer-resources/) provide deeper insights into the WooCommerce Blocks development.
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
- [Store API is now considered stable](https://developer.woocommerce.com/2022/03/25/store-api-is-now-considered-stable/)
- [Available Extensibility Interfaces for The Cart and Checkout Blocks](https://developer.woocommerce.com/2021/11/09/available-extensibility-interfaces-for-the-cart-and-checkout-blocks/)
Update README.md
2022-10-27 13:21:29 +00:00
- [How The Checkout Block Processes An Order](https://developer.woocommerce.com/2022/10/06/how-the-checkout-block-processes-an-order/)
- [New @wordpress/data stores in WooCommerce Blocks](https://developer.woocommerce.com/2022/10/17/new-wordpress-data-stores-in-woocommerce-blocks/)
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
Update the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6601) * Update the WooCommerce Blocks Handbook Add 3 subsections to the Developer resources section and add the new tools we have availble * Grammar fixes
2022-06-21 13:41:30 +00:00
### Tutorials
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
Update the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6601) * Update the WooCommerce Blocks Handbook Add 3 subsections to the Developer resources section and add the new tools we have availble * Grammar fixes
2022-06-21 13:41:30 +00:00
The following tutorials from [developer.woocommerce.com](https://developer.woocommerce.com/category/tutorials/) help you with extending the WooCommerce Blocks plugin.
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
Update README.md
2023-08-21 16:43:19 +00:00
- [📺 Tutorial: Extending the WooCommerce Checkout Block](https://developer.woocommerce.com/2023/08/07/extending-the-woocommerce-checkout-block-to-add-custom-shipping-options/)
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
- [Hiding Shipping and Payment Options in the Cart and Checkout Blocks](https://developer.woocommerce.com/2022/05/20/hiding-shipping-and-payment-options-in-the-cart-and-checkout-blocks/)
- [Integrating your Payment Method with Cart and Checkout Blocks](https://developer.woocommerce.com/2021/03/15/integrating-your-payment-method-with-cart-and-checkout-blocks/)
Update MD editor config (https://github.com/woocommerce/woocommerce-blocks/pull/7968) * Remove MD from editor config. Prettier handles formatting. * Resave docs * Update MD files
2022-12-19 12:06:48 +00:00
- [Exposing Payment Options in the Checkout Block](https://developer.woocommerce.com/2022/07/07/exposing-payment-options-in-the-checkout-block/)
Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) * Add links to single routes in main index woocommerce/woocommerce-blocks#4473 * Footer * Feedback template * Remove footer from existing MD files * Add doc footer script * Apply script to all docs * Fix examples
2022-02-02 14:27:46 +00:00
<!-- FEEDBACK -->
Format Markdown files using wp-scripts (https://github.com/woocommerce/woocommerce-blocks/pull/6462) * Format Markdown files using Prettier * Format Markdown files using wp-scripts * Adjust MD linting
2022-06-09 12:43:17 +00:00
Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) * Add links to single routes in main index woocommerce/woocommerce-blocks#4473 * Footer * Feedback template * Remove footer from existing MD files * Add doc footer script * Apply script to all docs * Fix examples
2022-02-02 14:27:46 +00:00
---
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
Correct broken *.md links (https://github.com/woocommerce/woocommerce-blocks/pull/7108)
2022-09-12 04:29:24 +00:00
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/README.md)
Format Markdown files using wp-scripts (https://github.com/woocommerce/woocommerce-blocks/pull/6462) * Format Markdown files using Prettier * Format Markdown files using wp-scripts * Adjust MD linting
2022-06-09 12:43:17 +00:00
Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) * Add links to single routes in main index woocommerce/woocommerce-blocks#4473 * Footer * Feedback template * Remove footer from existing MD files * Add doc footer script * Apply script to all docs * Fix examples
2022-02-02 14:27:46 +00:00
<!-- /FEEDBACK -->
Fixed newly detected broken links (https://github.com/woocommerce/woocommerce-blocks/pull/10537) * Update check-doc-links.yml * Update check-doc-links.yml * Update check-doc-links.yml * Update check-doc-links.yml * POC: Exclude releases folder from MD link check using “ignorePatterns” * Update check-doc-links.yml to use tcort/markdown-link-check * Update check-doc-links.yml to use existing config * reverted check-doc-links-config.json * fixed broken links * fixed broken links and generated docs * updated docs --------- Co-authored-by: Niels Lange <info@nielslange.de>
2023-08-22 09:51:18 +00:00