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

Fix broken links from issue #46336 (#46381) 

* Fixing broken links

* Update docs/payments/payment-gateway-api.md

Co-authored-by: Leif Singer <leif@automattic.com>

* Update docs/contributing/common-issues.md

Co-authored-by: Néstor Soriano <konamiman@konamiman.com>

* Update docs/payments/payment-gateway-api.md

Co-authored-by: Leif Singer <leif@automattic.com>

* Update writing-high-quality-testing-instructions.md

* Add changefile(s) from automation for the following project(s): @woocommerce/components, woocommerce-blocks, woocommerce

* ignore MD029 rule (1/2/3) as the linebreaks that are needed for the code block confuse its numbering

* update the docs manifest

`pnpm utils md-docs create docs woocommerce -o docs/docs-manifest.json`

---------

Co-authored-by: Leif Singer <leif@automattic.com>
Co-authored-by: Néstor Soriano <konamiman@konamiman.com>
Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Leif Singer <git@singer.sh>
This commit is contained in:
Brent MacKinnon 2024-04-15 09:30:37 -03:00 committed by GitHub
parent d69a36b1d5
commit 8fc82e9bfd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
13 changed files with 29 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/contributing/common-issues.md
View File

@ -80,7 +80,7 @@ Add this to `wp-config.php`:
define( 'WCPAY_DEV_MODE', true ); define( 'WCPAY_DEV_MODE', true );
``` ```
Also see [this document](https://woocommerce.com/document/payments/testing/dev-mode). Also see [this document](https://woocommerce.com/document/woopayments/testing-and-troubleshooting/sandbox-mode/).
## WooCommerce Admin install timestamp ## WooCommerce Admin install timestamp

10
docs/docs-manifest.json
View File

@ -227,7 +227,7 @@
"menu_title": "Common issues", "menu_title": "Common issues",
"tags": "reference", "tags": "reference",
"edit_url": "https://github.com/woocommerce/woocommerce/edit/trunk/docs/contributing/common-issues.md", "edit_url": "https://github.com/woocommerce/woocommerce/edit/trunk/docs/contributing/common-issues.md",
"hash": "1d89051f8ed4cb566b9f1fb18f12ec15acc1365b0ae999783f94dfd2f2a26ace", "hash": "9d8f0b78a0597ab22dce58e2b3707e3a08770bc22e2b901c0c6690928b1596bf",
"url": "https://raw.githubusercontent.com/woocommerce/woocommerce/trunk/docs/contributing/common-issues.md", "url": "https://raw.githubusercontent.com/woocommerce/woocommerce/trunk/docs/contributing/common-issues.md",
"id": "5766fb43cf9135d5a2cceaf0d386ec14b57c9ba0" "id": "5766fb43cf9135d5a2cceaf0d386ec14b57c9ba0"
}, },
@ -622,7 +622,7 @@
"menu_title": "Payment Gateway API", "menu_title": "Payment Gateway API",
"tags": "reference", "tags": "reference",
"edit_url": "https://github.com/woocommerce/woocommerce/edit/trunk/docs/payments/payment-gateway-api.md", "edit_url": "https://github.com/woocommerce/woocommerce/edit/trunk/docs/payments/payment-gateway-api.md",
"hash": "9a424247decbeee8f3b28ccb5ed9583137a4d1d826c4e33404ef56889bdca228", "hash": "812b0beff6b99ca3ac54a896be7daf3c2baca79cc0ba6caa6010c5563c97bd8f",
"url": "https://raw.githubusercontent.com/woocommerce/woocommerce/trunk/docs/payments/payment-gateway-api.md", "url": "https://raw.githubusercontent.com/woocommerce/woocommerce/trunk/docs/payments/payment-gateway-api.md",
"id": "b337203996650b567f91c70306e1010d6f1ae552" "id": "b337203996650b567f91c70306e1010d6f1ae552"
} }
@ -675,7 +675,7 @@
"post_title": "Writing high quality testing instructions", "post_title": "Writing high quality testing instructions",
"tags": "reference", "tags": "reference",
"edit_url": "https://github.com/woocommerce/woocommerce/edit/trunk/docs/quality-and-best-practices/writing-high-quality-testing-instructions.md", "edit_url": "https://github.com/woocommerce/woocommerce/edit/trunk/docs/quality-and-best-practices/writing-high-quality-testing-instructions.md",
"hash": "77c0027dc13fa8970a2cff15a5467ea38d41812f05701717a324ae66ed8c790a", "hash": "51fb384f8b1dfcb82fdbad6db08145b2c51dba6227529b8b54e2a281fc4b8ef7",
"url": "https://raw.githubusercontent.com/woocommerce/woocommerce/trunk/docs/quality-and-best-practices/writing-high-quality-testing-instructions.md", "url": "https://raw.githubusercontent.com/woocommerce/woocommerce/trunk/docs/quality-and-best-practices/writing-high-quality-testing-instructions.md",
"id": "56a8ef0ef0afec9c884f655e7fdd23d9666c9d00" "id": "56a8ef0ef0afec9c884f655e7fdd23d9666c9d00"
}, },
@ -836,7 +836,7 @@
"menu_title": "Shipping method API", "menu_title": "Shipping method API",
"tags": "reference", "tags": "reference",
"edit_url": "https://github.com/woocommerce/woocommerce/edit/trunk/docs/shipping/shipping-method-api.md", "edit_url": "https://github.com/woocommerce/woocommerce/edit/trunk/docs/shipping/shipping-method-api.md",
"hash": "ac3b99a8e8ffbd3a9f9d803b2066e121d6d7d70cf19623bde1bdd2977e18113f", "hash": "40bf33d540692608fccec48e9a6cc08e51c510c894c32414723c75cc2d2dc3a8",
"url": "https://raw.githubusercontent.com/woocommerce/woocommerce/trunk/docs/shipping/shipping-method-api.md", "url": "https://raw.githubusercontent.com/woocommerce/woocommerce/trunk/docs/shipping/shipping-method-api.md",
"id": "70270a01c8f1f2b630c809c0b9611940e99293a9", "id": "70270a01c8f1f2b630c809c0b9611940e99293a9",
"links": { "links": {
@ -1241,5 +1241,5 @@
"categories": [] "categories": []
} }
], ],
"hash": "8405edcef5099817f6f890009993f1f2542bdfac1c6a30db0507097ee15be782" "hash": "ca683a7750097a24dfcb4b472ea3575dd40a05e0ce7bd9dd54277ed3ed30fa61"
} }

4
docs/payments/payment-gateway-api.md
View File

@ -27,7 +27,7 @@ Payment gateways should be created as additional plugins that hook into WooComme
add_action( 'plugins_loaded', 'init_your_gateway_class' ); add_action( 'plugins_loaded', 'init_your_gateway_class' );
``` ```
It is also important that your gateway class extends the WooCommerce base gateway class, so you have access to important methods and the [settings API](https://woocommerce.com/document/settings-api/ "https://woocommerce.com/document/settings-api/"): It is also important that your gateway class extends the WooCommerce base gateway class, so you have access to important methods and the [settings API](https://developer.woocommerce.com/docs/settings-api/):
```php ```php
function init_your_gateway_class() { function init_your_gateway_class() {
@ -87,7 +87,7 @@ add_action( 'woocommerce_update_options_payment_gateways\_' . $this->id, array(
#### init_form_fields() #### init_form_fields()
Use this method to set `$this->form_fields` - these are options you'll show in admin on your gateway settings page and make use of the [WC Settings API](https://woocommerce.com/document/settings-api/ "https://woocommerce.com/document/settings-api/"). Use this method to set `$this->form_fields` - these are options you'll show in admin on your gateway settings page and make use of the [WC Settings API](https://developer.woocommerce.com/docs/settings-api/).
A basic set of settings for your gateway would consist of _enabled_, _title_ and _description_: A basic set of settings for your gateway would consist of _enabled_, _title_ and _description_:

2
docs/quality-and-best-practices/writing-high-quality-testing-instructions.md
View File

@ -53,7 +53,7 @@ Therefore, a PR could have testing instructions for multiple scenarios, in fact,
3. Identify the **preconditions**, **action** and **validation** steps. 3. Identify the **preconditions**, **action** and **validation** steps.
4. Write **as many preconditions as you need** to explain how to set up the state of WooCommerce so that you can execute the desired action to test every flow. 4. Write **as many preconditions as you need** to explain how to set up the state of WooCommerce so that you can execute the desired action to test every flow.
1. Try to be detailed when explaining the interactions the user needs to perform in WooCommerce. 1. Try to be detailed when explaining the interactions the user needs to perform in WooCommerce.
2. If there are several preconditions for a user flow that is explained in a public guide, feel free to simply link the guide in the testing instructions instead of writing several steps. For example, _"Enable dev mode in WooCommerce Payments by following the steps mentioned [here](https://woocommerce.com/document/woocommerce-payments/testing-and-troubleshooting/dev-mode/)"_. 2. If there are several preconditions for a user flow that is explained in a public guide, feel free to simply link the guide in the testing instructions instead of writing several steps. For example, _"Enable dev mode in WooCommerce Payments by following the steps mentioned [here](https://woocommerce.com/document/woocommerce-payments/testing-and-troubleshooting/sandbox-mode/)"_.
5. Write **the action step**, which should cover the specific action that we want to test as part of this user flow. 5. Write **the action step**, which should cover the specific action that we want to test as part of this user flow.
6. Write **as many validation steps** as needed in order to assess that the actual result meets expectations. 6. Write **as many validation steps** as needed in order to assess that the actual result meets expectations.
1. Bear in mind to check only the steps needed to validate that this change works. 1. Bear in mind to check only the steps needed to validate that this change works.

2
docs/shipping/shipping-method-api.md
View File

@ -76,7 +76,7 @@ if ( ! class_exists( 'WC_Your_Shipping_Method' ) ) {
## Defining settings/options ## Defining settings/options
You can then define your options using the settings API. In the snippets above you'll notice we init_form_fields and init_settings. These load up the settings API. To see how to add settings, see [WooCommerce settings API](https://woocommerce.com/document/settings-api/). You can then define your options using the settings API. In the snippets above you'll notice we init_form_fields and init_settings. These load up the settings API. To see how to add settings, see [WooCommerce settings API](https://developer.woocommerce.com/docs/settings-api/).
## The calculate_shipping() method ## The calculate_shipping() method

4
packages/js/components/changelog/46381-apr9-broken-links Normal file
View File

@ -0,0 +1,4 @@
Significance: patch
Type: fix
Fix a few broken links.

4
packages/js/components/src/dynamic-form/README.md
View File

@ -23,7 +23,7 @@ const initialValues = { firstName: '' };
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fields` | {} or [] | [] | An object to describe the structure and types of all fields, matching the structure returned by the [Settings API](https://woocommerce.com/document/settings-api/) | | `fields` | {} or [] | [] | An object to describe the structure and types of all fields, matching the structure returned by the [Settings API](https://developer.woocommerce.com/docs/settings-api/) |
| `isBusy` | Boolean | false | Boolean indicating busy state of submit button | | `isBusy` | Boolean | false | Boolean indicating busy state of submit button |
| `onSubmit` | Function | `noop` | Function to call when a form is submitted with valid fields | | `onSubmit` | Function | `noop` | Function to call when a form is submitted with valid fields |
| `onChange` | Function | `noop` | Function to call when any values on the form are changed | | `onChange` | Function | `noop` | Function to call when any values on the form are changed |
@ -32,7 +32,7 @@ const initialValues = { firstName: '' };
### Fields structure ### Fields structure
Please reference the [WordPress settings API documentation](https://woocommerce.com/document/settings-api/) to better understand the structure expected for the fields property. This component accepts the object returned via the `settings` property when querying a gateway via the API, or simply the array provided by `Object.values(settings)`. Please reference the [WordPress settings API documentation](https://developer.woocommerce.com/docs/settings-api/) to better understand the structure expected for the fields property. This component accepts the object returned via the `settings` property when querying a gateway via the API, or simply the array provided by `Object.values(settings)`.
### Currently Supported Types ### Currently Supported Types

2
plugins/woocommerce-blocks/docs/README.md
View File

@ -136,7 +136,7 @@ The following posts from [developer.woo.com](https://developer.woocommerce.com/c
### Tutorials ### Tutorials
The following tutorials from [developer.woo.com](https://developer.woocommerce.com/category/tutorials/) help you with extending the WooCommerce Blocks plugin. The following tutorials from [developer.woo.com](https://developer.woocommerce.com/) help you with extending the WooCommerce Blocks plugin.
- [📺 Tutorial: Extending the WooCommerce Checkout Block](https://developer.woocommerce.com/2023/08/07/extending-the-woocommerce-checkout-block-to-add-custom-shipping-options/) - [📺 Tutorial: Extending the WooCommerce Checkout Block](https://developer.woocommerce.com/2023/08/07/extending-the-woocommerce-checkout-block-to-add-custom-shipping-options/)
- [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/) - [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/)

6
plugins/woocommerce-blocks/docs/internal-developers/testing/releases/750.md
View File

@ -50,7 +50,7 @@ Zip file for testing: [woocommerce-gutenberg-products-block.zip](https://github.
### Allow saved payment methods labels other than card/eCheck to display brand & last 4 digits if present. ([6177](https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/6177)) ### Allow saved payment methods labels other than card/eCheck to display brand & last 4 digits if present. ([6177](https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/6177))
1. Install latest dev/release version of WooCommerce Payments & setup an account in [dev mode](https://woocommerce.com/document/payments/testing/dev-mode/). 1. Install latest dev/release version of WooCommerce Payments & setup an account in [dev mode](https://woocommerce.com/document/woopayments/testing-and-troubleshooting/sandbox-mode/).
2. Under WooCommerce Payments -> Settings, Enable the new WooCommerce Payments checkout experience and add new payment methods. 2. Under WooCommerce Payments -> Settings, Enable the new WooCommerce Payments checkout experience and add new payment methods.
- This _should_ have enabled Euros in Multi-Currency automatically, but if not, go to WooCommerce > Settings > Multi-Currency and enable Euros as an additional currency. - This _should_ have enabled Euros in Multi-Currency automatically, but if not, go to WooCommerce > Settings > Multi-Currency and enable Euros as an additional currency.
3. Save SEPA account to your customer account in one of two ways: 3. Save SEPA account to your customer account in one of two ways:
@ -102,8 +102,8 @@ mv wp-content/plugins/woocommerce ~/Desktop/woocommerce
ln -s ~/Desktop/woocommerce wp-content/plugins/woocommerce ln -s ~/Desktop/woocommerce wp-content/plugins/woocommerce
``` ```
2. Install WooCommerce Subscriptions. 2. Install WooCommerce Subscriptions.<!-- markdownlint-disable-line MD029 -->
3. Try to open wp-admin > WooCommerce > Home (/wp-admin/admin.php?page=wc-admin). With base branch, expect a blank page. With this PR branch, expect page loads normally. 3. Try to open wp-admin > WooCommerce > Home (/wp-admin/admin.php?page=wc-admin). With base branch, expect a blank page. With this PR branch, expect page loads normally.<!-- markdownlint-disable-line MD029 -->
### Make Filters Products by Price work with Active Filters block for the PHP rendered Classic Template. ([6245](https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/6245)) ### Make Filters Products by Price work with Active Filters block for the PHP rendered Classic Template. ([6245](https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/6245))

4
plugins/woocommerce/changelog/46381-apr9-broken-links Normal file
View File

@ -0,0 +1,4 @@
Significance: patch
Type: fix
Fix a few broken links.

6
plugins/woocommerce/readme.txt
View File

@ -57,9 +57,9 @@ Unlike hosted ecommerce solutions, WooCommerce store data is future-proof; you
Developers can use [WooCommerce](https://woocommerce.com/woocommerce/) to create, customize, and scale a store to meet a client’s exact specifications, making enhancements through extensions or custom solutions. Developers can use [WooCommerce](https://woocommerce.com/woocommerce/) to create, customize, and scale a store to meet a client’s exact specifications, making enhancements through extensions or custom solutions.
- Leverage [hooks and filters](https://woocommerce.com/document/introduction-to-hooks-actions-and-filters/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing) to modify or create functionality. - Leverage [hooks and filters](https://woocommerce.com/document/introduction-to-hooks-actions-and-filters/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing) to modify or create functionality.
- Integrate virtually any service using a robust [REST API](https://woocommerce.com/document/woocommerce-rest-api/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing) and webhooks. - Integrate virtually any service using a robust [REST API](https://developer.woocommerce.com/docs/getting-started-with-the-woocommerce-rest-api/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing) and webhooks.
- Design and build custom content blocks with React. - Design and build custom content blocks with React.
- [Inspect and modify](https://woocommerce.com/documentation/plugins/woocommerce/woocommerce-codex/extending/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing) any aspect of the core plugin code. - [Inspect and modify](https://developer.woocommerce.com/docs/category/extension-development/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing) any aspect of the core plugin code.
- Speed up development with a lightning-fast [CLI](https://woocommerce.github.io/code-reference/classes/wc-cli-rest-command.html?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing). - Speed up development with a lightning-fast [CLI](https://woocommerce.github.io/code-reference/classes/wc-cli-rest-command.html?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing).
The core platform is tested rigorously and often, supported by a dedicated development team working across time zones. Comprehensive documentation is updated with each release, empowering you to build exactly the store required. The core platform is tested rigorously and often, supported by a dedicated development team working across time zones. Comprehensive documentation is updated with each release, empowering you to build exactly the store required.
@ -84,7 +84,7 @@ WooCommerce is translated into multiple languages, including Danish, Ukrainian,
For help setting up and configuring WooCommerce, please refer to [Getting Started](https://woocommerce.com/documentation/plugins/woocommerce/getting-started/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing) and the [New WooCommerce Store Owner Guide](https://woocommerce.com/guides/new-store/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing). For help setting up and configuring WooCommerce, please refer to [Getting Started](https://woocommerce.com/documentation/plugins/woocommerce/getting-started/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing) and the [New WooCommerce Store Owner Guide](https://woocommerce.com/guides/new-store/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing).
For extending or theming WooCommerce, see our [codex](https://woocommerce.com/documentation/plugins/woocommerce/woocommerce-codex/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing), as well as the [Plugin Developer Handbook](https://woocommerce.com/document/create-a-plugin/?utm_medium=referral&utm_source=wordpress.org&utm_campaign=wp_org_repo_listing). For extending or theming WooCommerce, see our [documentation](https://github.com/woocommerce/woocommerce/tree/trunk/docs), as well as the [Plugin Developer Best Practices](https://github.com/woocommerce/woocommerce/blob/trunk/docs/extension-development/extension-development-best-practices.md).
= Where can I get help or talk to other users about WooCommerce Core? = = Where can I get help or talk to other users about WooCommerce Core? =

2
tools/release-posts/commands/release-post/release-post-beta.ts
View File

@ -199,7 +199,7 @@ const program = new Command()
finalReleaseDate, finalReleaseDate,
lastReleasePostUrl: lastReleasePostUrl:
lastReleasePost?.URL || lastReleasePost?.URL ||
'https://developer.woocommerce.com/category/woocommerce-core-release-notes/', 'https://developer.woocommerce.com/category/release-posts/',
} ); } );
if ( isOutputOnly ) { if ( isOutputOnly ) {

2
tools/release-posts/commands/release-post/release-post-rc.ts
View File

@ -193,7 +193,7 @@ const program = new Command()
finalReleaseDate, finalReleaseDate,
lastReleasePostUrl: lastReleasePostUrl:
lastReleasePost?.URL || lastReleasePost?.URL ||
'https://developer.woocommerce.com/category/woocommerce-core-release-notes/', 'https://developer.woocommerce.com/category/release-posts/',
} ); } );
if ( isOutputOnly ) { if ( isOutputOnly ) {