Skip to content

Commit eba6db1

Browse files
authored
Merge pull request #128 from commerce-docs/gendocs_2.4.6
Updated Module Reference Guide data for the 2.4.6 release
2 parents 35b2b45 + 73c4158 commit eba6db1

13 files changed

+106
-98
lines changed

src/data/navigation/sections/module_reference.js

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -739,11 +739,6 @@ module.exports = [
739739
path: "/module-reference/module-elasticsearch-7/"
740740
},
741741

742-
{
743-
title: "Elasticsearch8",
744-
path: "/module-reference/module-elasticsearch-8/"
745-
},
746-
747742
{
748743
title: "ElasticsearchCatalogPermissions",
749744
path: "/module-reference/module-elasticsearch-catalog-permissions/"
@@ -1784,6 +1779,16 @@ module.exports = [
17841779
path: "/module-reference/module-purchase-order-rule-graph-ql/"
17851780
},
17861781

1782+
{
1783+
title: "QuickCheckout",
1784+
path: "/module-reference/module-quick-checkout/"
1785+
},
1786+
1787+
{
1788+
title: "QuickCheckoutAdminPanel",
1789+
path: "/module-reference/module-quick-checkout-admin-panel/"
1790+
},
1791+
17871792
{
17881793
title: "QuickOrder",
17891794
path: "/module-reference/module-quick-order/"

src/pages/module-reference/module-admin-adobe-ims.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ By clicking on this button a popup opens with the AdobeIms Login, where the curr
244244
After successfully validate his identity, we are redirecting to the `Magento/AdminAdobeIms/Controller/Adminhtml/OAuth/ImsReauthCallback.php` Controller and update the `ims_verified` field.
245245

246246
When the form will be submitted, we verify the identity with the `Magento/AdminAdobeIms/Plugin/ReplaceVerifyIdentityWithImsPlugin.php` Plugin.
247-
Here the existence of the `AdobeAccessToken` and `AdobeReAuthToken` will be checked.
247+
Here the existens of the `AdobeAccessToken` and `AdobeReAuthToken` will be checked.
248248
The reauth_token will be used to call the AdobeIms validateToken Endpoint.
249249

250250
When this call is successful, the form will be submitted, otherwise we update the Message of the thrown `AuthenticationException` to return a matching error message, done by the `Magento/AdminAdobeIms/Plugin/PerformIdentityCheckMessagePlugin.php` Plugin.

src/pages/module-reference/module-adobe-io-events-client.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ This is a two-step process:
2525
- Enter a unique ID in the `Adobe Commerce Instance ID` field
2626
4. Run the following command to create an event provider
2727

28-
```bash
29-
bin/magento events:create-event-provider --label "<unique_provider_label>" --description "<provider description>"
30-
```
28+
```bash
29+
bin/magento events:create-event-provider --label "<unique_provider_label>" --description "<provider description>"
30+
````
3131

3232
5. Enter the Event Provider ID output by the command in the `Adobe I/O Event Provider ID` field
3333

src/pages/module-reference/module-catalog.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,59 +23,57 @@ Catalog module provides API filtering that allows to limit product selection wit
2323
This module observes the following events:
2424

2525
- `etc/events.xml`
26-
- `magento_catalog_api_data_productinterface_save_before` event in
26+
- `magento_catalog_api_data_productinterface_save_before` event in
2727
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
28-
- `magento_catalog_api_data_productinterface_save_after` event in
29-
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
30-
- `magento_catalog_api_data_productinterface_delete_before` event in
28+
- `magento_catalog_api_data_productinterface_save_after` event in
29+
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
30+
- `magento_catalog_api_data_productinterface_delete_before` event in
3131
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
32-
- `magento_catalog_api_data_productinterface_delete_after` event in
32+
- `magento_catalog_api_data_productinterface_delete_after` event in
3333
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
34-
- `magento_catalog_api_data_productinterface_load_after` event in
34+
- `magento_catalog_api_data_productinterface_load_after` event in
3535
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
36-
- `magento_catalog_api_data_categoryinterface_save_before` event in
36+
- `magento_catalog_api_data_categoryinterface_save_before` event in
3737
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
38-
- `magento_catalog_api_data_categoryinterface_save_after` event in
38+
- `magento_catalog_api_data_categoryinterface_save_after` event in
3939
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
40-
- `magento_catalog_api_data_categoryinterface_save_after` event in
40+
- `magento_catalog_api_data_categoryinterface_save_after` event in
4141
`Magento\Catalog\Observer\InvalidateCacheOnCategoryDesignChange` file.
42-
- `magento_catalog_api_data_categoryinterface_delete_before` event in
42+
- `magento_catalog_api_data_categoryinterface_delete_before` event in
4343
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
44-
- `magento_catalog_api_data_categoryinterface_delete_after` event in
44+
- `magento_catalog_api_data_categoryinterface_delete_after` event in
4545
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
46-
- `magento_catalog_api_data_categoryinterface_load_after` event in
46+
- `magento_catalog_api_data_categoryinterface_load_after` event in
4747
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
48-
- `magento_catalog_api_data_categorytreeinterface_save_before` event in
48+
- `magento_catalog_api_data_categorytreeinterface_save_before` event in
4949
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
50-
- `magento_catalog_api_data_categorytreeinterface_save_after` event in
50+
- `magento_catalog_api_data_categorytreeinterface_save_after` event in
5151
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
52-
- `magento_catalog_api_data_categorytreeinterface_delete_before` event in
52+
- `magento_catalog_api_data_categorytreeinterface_delete_before` event in
5353
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
54-
- `magento_catalog_api_data_categorytreeinterface_delete_after` event in
54+
- `magento_catalog_api_data_categorytreeinterface_delete_after` event in
5555
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
56-
- `magento_catalog_api_data_categorytreeinterface_load_after` event in
56+
- `magento_catalog_api_data_categorytreeinterface_load_after` event in
5757
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
58-
- `admin_system_config_changed_section_catalog` event in
58+
- `admin_system_config_changed_section_catalog` event in
5959
`Magento\Catalog\Observer\SwitchPriceAttributeScopeOnConfigChange` file.
60-
- `catalog_product_save_before` event in
60+
- `catalog_product_save_before` event in
6161
`Magento\Catalog\Observer\SetSpecialPriceStartDate` file.
62-
- `store_save_after` event in
62+
- `store_save_after` event in
6363
`Magento\Catalog\Observer\SynchronizeWebsiteAttributesOnStoreChange` file.
64-
- `catalog_product_save_commit_after` event in
64+
- `catalog_product_save_commit_after` event in
6565
`Magento\Catalog\Observer\ImageResizeAfterProductSave` file.
66-
- `catalog_category_prepare_save` event in
66+
- `catalog_category_prepare_save` event in
6767
`Magento\Catalog\Observer\CategoryDesignAuthorization` file.
68-
6968
- `/etc/frontend/events.xml`
70-
- `customer_login` event in
69+
- `customer_login` event in
7170
`Magento\Catalog\Observer\Compare\BindCustomerLoginObserver` file.
72-
- `customer_logout` event in
71+
- `customer_logout` event in
7372
`Magento\Catalog\Observer\Compare\BindCustomerLogoutObserver` file.
74-
7573
- `/etc/adminhtml/events.xml`
76-
- `cms_wysiwyg_images_static_urls_allowed` event in
74+
- `cms_wysiwyg_images_static_urls_allowed` event in
7775
`Magento\Catalog\Observer\CatalogCheckIsUsingStaticUrlsAllowedObserver` file.
78-
- `catalog_category_change_products` event in
76+
- `catalog_category_change_products` event in
7977
`Magento\Catalog\Observer\CategoryProductIndexer` file.
80-
- `category_move` event in
78+
- `category_move` event in
8179
`Magento\Catalog\Observer\FlushCategoryPagesCache`

src/pages/module-reference/module-elasticsearch-8.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

src/pages/module-reference/module-msrp.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -43,26 +43,26 @@ For information about a typical file structure of a module in Magento 2,
4343

4444
## Extensibility
4545

46-
Developers can pass custom `msrpPriceCalculators` for `Magento\Msrp\Pricing\MsrpPriceCalculator` using type configuration using `di.xml`.
47-
48-
For example:
49-
50-
```xml
51-
<type name="Magento\Msrp\Pricing\MsrpPriceCalculator">
52-
<arguments>
53-
<argument name="msrpPriceCalculators" xsi:type="array">
54-
<item name="configurable" xsi:type="array">
55-
<item name="productType" xsi:type="const">Magento\ConfigurableProduct\Model\Product\Type\Configurable::TYPE_CODE</item>
56-
<item name="priceCalculator" xsi:type="object">Magento\MsrpConfigurableProduct\Pricing\MsrpPriceCalculator</item>
57-
</item>
58-
</argument>
59-
</arguments>
60-
</type>
46+
Developers can pass custom `msrpPriceCalculators` for `Magento\Msrp\Pricing\MsrpPriceCalculator` using type configuration using `di.xml`.
47+
48+
For example:
49+
50+
```xml
51+
<type name="Magento\Msrp\Pricing\MsrpPriceCalculator">
52+
<arguments>
53+
<argument name="msrpPriceCalculators" xsi:type="array">
54+
<item name="configurable" xsi:type="array">
55+
<item name="productType" xsi:type="const">Magento\ConfigurableProduct\Model\Product\Type\Configurable::TYPE_CODE</item>
56+
<item name="priceCalculator" xsi:type="object">Magento\MsrpConfigurableProduct\Pricing\MsrpPriceCalculator</item>
57+
</item>
58+
</argument>
59+
</arguments>
60+
</type>
6161
```
6262

63-
More information about [type configuration](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/di-xml-file.html).
63+
More information about [type configuration](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/di-xml-file.html).
6464

65-
Extension developers can interact with the Magento_Msrp module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
65+
Extension developers can interact with the Magento_Msrp module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
6666

6767
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_Msrp module.
6868

@@ -119,7 +119,7 @@ This module introduces the following layouts and layout handles:
119119

120120
Module provides product admin form modifier:
121121

122-
`Magento\Msrp\Ui\DataProvider\Product\Form\Modifier\Msrp` - removes `msrp_display_actual_price_type` field from the form if config disabled else adds `validate-zero-or-greater` validation to the field.
122+
`Magento\Msrp\Ui\DataProvider\Product\Form\Modifier\Msrp` - removes `msrp_display_actual_price_type` field from the form if config disabled else adds `validate-zero-or-greater` validation to the fild.
123123

124124
## Additional information
125125

src/pages/module-reference/module-multishipping.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For information about a typical file structure of a module in Magento 2,
2222
Developers can interact with the module and change behaviour using type configuration feature.
2323

2424
Namely, we can change `paymentSpecification` for `Magento\Multishipping\Block\Checkout\Billing` and `Magento\Multishipping\Model\Checkout\Type\Multishipping` classes.
25-
As result, we will get changed behaviour, new logic or something what our business need.
25+
As result, we will get changed behavior, new logic or something what our business need.
2626

2727
For example:
2828

@@ -141,4 +141,4 @@ Module introduces the new pages:
141141

142142
More information about [layout types](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-types.html).
143143

144-
For information about significant changes in patch releases, see [2.3.x Release information](http://devdocs.magento.com/guides/v2.3/release-notes/bk-release-notes.html).
144+
For information about significant changes in patch releases, see [Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html).

src/pages/module-reference/module-mysql-mq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For information about a module installation in Magento 2, see [Enable or disable
2323

2424
## Additional information
2525

26-
For information about significant changes in patch releases, see [2.3.x Release information](http://devdocs.magento.com/guides/v2.3/release-notes/bk-release-notes.html).
26+
For information about significant changes in patch releases, see [Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html).
2727

2828
### cron options
2929

src/pages/module-reference/module-purchase-order-rule-graph-ql.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@ description: README.md contents of the module from the source code
55

66
# Magento_PurchaseOrderRuleGraphQl
77

8+
9+
810
## Overview
911

12+
1013
The PurchaseOrderRuleGraphQl module provides GraphQl API coverage for PurchaseOrderRule module functionality.
1114

1215
## Additional information
1316

17+
1418
Check the [B2B release notes](https://devdocs.magento.com/guides/v2.4/release-notes/b2b-release-notes.html) for more information on new changes.

src/pages/module-reference/module-purchase-order-rule.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,26 @@ description: README.md contents of the module from the source code
55

66
# Magento_PurchaseOrderRule
77

8+
9+
810
## Overview
911

12+
1013
The PurchaseOrderRule module contains functionality for creating and enforcing approval rules for purchase orders. Companies in a B2B environment can use these rules to enforce purchasing guidelines and limits.
1114
1215
With this module installed, you may create rules such as:
16+
1317

1418
- Purchase orders over $X require approvals from a manager.
1519
- Purchase orders containing more than $Y unique products require approval.
1620
- Purchase orders with shipping charges greater than $Z require approval.
21+
1722

1823
## Installation details
1924

20-
The PurchaseOrderRule module has dependencies on the following modules:​
25+
26+
The PurchaseOrderRule module has dependencies on the following modules:
27+
2128

2229
- Magento_Company
2330
- Magento_Customer
@@ -31,11 +38,15 @@ The PurchaseOrderRule module has dependencies on the following modules:​
3138
- Magento_Theme
3239
- Magento_Ui
3340
41+
3442
which must be installed and enabled first. This module does not create any backward incompatible changes. It can be uninstalled or deactivated at any time.
43+
3544

3645
## Structure
3746

47+
3848
[Learn about a typical file structure for a Magento 2 module](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html).
49+
3950

4051
## Extensibility
4152

@@ -51,11 +62,14 @@ This module introduces the following layouts and layout handles in the `view/fro
5162
- `purchaseorderrule_edit_index`
5263
- `purchaseorderrule_form`
5364
- `purchaseorderrule_index_index`
65+
5466

5567
### UI components
5668

69+
5770
You can extend the purchase order rule listings using the `purchase_order_rule_listing.xml` and `require_my_approval_purchaseorder_listing.xml` configuration files.
5871

5972
## Additional information
6073

74+
6175
Check the [B2B release notes](https://devdocs.magento.com/guides/v2.4/release-notes/b2b-release-notes.html) for more information on new changes.

0 commit comments

Comments
 (0)