Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 51ce74f

Browse files
Merge pull request #5677 from magento/5248-ol-list-prefix-6
Fixed ordered list prefix (MD029) - Group 6
2 parents d6000b6 + b96c235 commit 51ce74f

15 files changed

+77
-78
lines changed

guides/v2.2/howdoi/checkout/checkout-add-custom-carrier.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ This topic describes how to add a custom shipping carrier.
1717
To add a new shipping carrier to the Magento checkout:
1818

1919
1. [Create a new module](#create-module)
20-
2. [Add the carrier configuration](#create-configuration)
21-
3. [Create the carrier model](#carrier-model)
22-
4. [Enable the module](#enable-module)
20+
1. [Add the carrier configuration](#create-configuration)
21+
1. [Create the carrier model](#carrier-model)
22+
1. [Enable the module](#enable-module)
2323

2424
## Step 1: Create a new module {#create-module}
2525

@@ -100,14 +100,14 @@ To add a module configuration use the following source code snippets.
100100

101101
The `system.xml` source code declares custom shipping module options:
102102

103-
- Enabled
104-
- Title
105-
- Method Name
106-
- Shipping Cost
107-
- Ship to Applicable Countries
108-
- Ship to Specific Countries
109-
- Show Method if Not Applicable
110-
- Sort Order
103+
- Enabled
104+
- Title
105+
- Method Name
106+
- Shipping Cost
107+
- Ship to Applicable Countries
108+
- Ship to Specific Countries
109+
- Show Method if Not Applicable
110+
- Sort Order
111111

112112
```xml
113113
<?xml version="1.0"?>

guides/v2.2/howdoi/checkout/checkout_address.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ This topic describes how to implement a custom shipping address renderer.
1414

1515
Out of the box, Magento [checkout](https://glossary.magento.com/checkout) consists of two steps:
1616

17-
- Shipping Information
18-
- Review and Payment Information
17+
- Shipping Information
18+
- Review and Payment Information
1919

2020
On the Shipping Information checkout step Magento renders all addresses previously saved by a shopper. The shopper can then select the one to be used for shipping by clicking it. The default address renderers cover the majority of use cases, but Magento provides way to register custom address renderer for a new address type.
2121

2222
To implement shipping address rendering in checkout, you need to take the following steps:
2323

2424
1. [Create the JS renderer component (shipping address renderer)](#create).
25-
2. [Create a template for the shipping address renderer.](#template)
26-
3. [Create the JS model for the shipping rate processor](#rate_processor).
27-
4. [Create the JS model for the shipping address saving processor](#save).
28-
5. [Create the JS component registering the processors](#register).
29-
6. [Declare the new components in the checkout page layout.](#layout).
30-
7. [Add the shipping address renderer to the "Ship-To" block (optional)](#ship_to).
25+
1. [Create a template for the shipping address renderer.](#template)
26+
1. [Create the JS model for the shipping rate processor](#rate_processor).
27+
1. [Create the JS model for the shipping address saving processor](#save).
28+
1. [Create the JS component registering the processors](#register).
29+
1. [Declare the new components in the checkout page layout.](#layout).
30+
1. [Add the shipping address renderer to the "Ship-To" block (optional)](#ship_to).
3131

3232
## Step 1: Create the JS renderer component (shipping address renderer) {#create}
3333

guides/v2.2/howdoi/checkout/checkout_carrier.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ This topic describes how to add shipping address validations for a custom [shipp
1515
To add new shipping carrier validations to the Magento checkout, do the following:
1616

1717
1. [Create validation rules](#rules).
18-
2. [Create validator](#validator).
19-
3. [Register validator and rules in the validators pool](#register).
20-
4. [Add the validators and rules to the checkout layout](#layout).
18+
1. [Create validator](#validator).
19+
1. [Register validator and rules in the validators pool](#register).
20+
1. [Add the validators and rules to the checkout layout](#layout).
2121

2222
{: .bs-callout-info }
2323
During checkout, when a customer fills the shipping address form, shipping carrier validations trigger the shipping rates request. That is why adding shipping carrier validations for your custom shipping method is mandatory.

guides/v2.2/howdoi/checkout/checkout_custom_checkbox.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Let's consider a case where you need to add a checkbox whose state (selected or
1717
To implement such a checkbox, take the following steps:
1818

1919
1. [Create a plugin for the process method](#create-plugin) of the `<Magento_Checkout_module_dir>/Block/Checkout/LayoutProcessor.php` class.
20-
2. [Declare the plugin in your module's `di.xml`](#declare-plugin).
21-
3. [Create a JS component for the checkbox with custom logic](#create-jscomponent).
20+
1. [Declare the plugin in your module's `di.xml`](#declare-plugin).
21+
1. [Create a JS component for the checkbox with custom logic](#create-jscomponent).
2222

2323
## Create a plugin for the `LayoutProcessor`'s process method {#create-plugin}
2424

guides/v2.2/howdoi/checkout/checkout_customize.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This topic contains the basic information about how to customize the view of an
1717
To change the `.js` implementation and template used for components rendering, you need to declare the new files in the checkout page [layout](https://glossary.magento.com/layout). To do this, take the following steps:
1818

1919
1. In your custom module directory, create the following new file: `<your_module_dir>/view/frontend/layout/checkout_index_index.xml`. (For your checkout customization to be applied correctly, your custom [module](https://glossary.magento.com/module) should depend on the Magento_Checkout module.)
20-
2. In this file, add the following:
20+
1. In this file, add the following:
2121

2222
```xml
2323
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
@@ -34,9 +34,9 @@ To change the `.js` implementation and template used for components rendering, y
3434
</page>
3535
```
3636

37-
3. In the `<Magento_Checkout_module_dir>/view/frontend/layout/checkout_index_index.xml` file, find the component that you need to customize. Copy the corresponding node and all parent nodes up to `<argument>`. There is no need to leave all the attributes and values of parent nodes, as you are not going to change them.
37+
1. In the `<Magento_Checkout_module_dir>/view/frontend/layout/checkout_index_index.xml` file, find the component that you need to customize. Copy the corresponding node and all parent nodes up to `<argument>`. There is no need to leave all the attributes and values of parent nodes, as you are not going to change them.
3838

39-
4. Change the path to the component's `.js` file, template or any other property.
39+
1. Change the path to the component's `.js` file, template or any other property.
4040

4141
Example:
4242

@@ -166,4 +166,4 @@ return $jsLayout;
166166
If you want to use this sample in your code, replace the `%path_to_target_node%` placeholder with real value.
167167

168168
{:.bs-callout .bs-callout-info}
169-
Disable vs remove a component: If you disable a component, it is loaded but not rendered. If you remove a component, it is removed and not loaded.
169+
Disable vs remove a component: If you disable a component, it is loaded but not rendered. If you remove a component, it is removed and not loaded.

guides/v2.2/howdoi/checkout/checkout_edit_form.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ The forms used on the Checkout page are implemented using Knockout JS.
1717
To change the template of the form field, do the following:
1818

1919
1. [Create a custom HTML template for knockout JS script that will render the form field](#template).
20-
2. [Specify the new template in the Checkout page layout](#layout).
21-
3. [Clear files after modification](#modify).
20+
1. [Specify the new template in the Checkout page layout](#layout).
21+
1. [Clear files after modification](#modify).
2222

2323
## Prerequisites
2424

@@ -108,4 +108,4 @@ In this file, add content similar to the following:
108108
If you modify your custom `.html` template after it was applied on the store pages, the changes will not apply until you do the following:
109109

110110
1. Delete all files in the `pub/static/frontend` and `var/view_preprocessed` directories.
111-
2. Reload the pages.
111+
1. Reload the pages.

guides/v2.2/howdoi/checkout/checkout_form.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Most of the elements, including the default forms on the Checkout page are imple
1717
Magento provides the ability to add a custom form to any of the checkout steps: Shipping Information, Review and Payment Information, or custom. In order to add a custom form that is a UI component, take the following steps:
1818

1919
1. [Create the JS implementation of the form UI component](#component).
20-
2. [Create the knockout.js HTML template for rendering the form](#template).
21-
3. [Declare the form in the checkout page layout](#layout).
20+
1. [Create the knockout.js HTML template for rendering the form](#template).
21+
1. [Declare the form in the checkout page layout](#layout).
2222

2323
## Prerequisites
2424

@@ -154,7 +154,7 @@ It should be similar to the following:
154154
If you modify your custom `.html` template after it was applied on the store pages, the changes will not apply until you do the following:
155155

156156
1. Delete all files in the `pub/static/frontend` and `var/view_preprocessed` directories.
157-
2. Reload the pages.
157+
1. Reload the pages.
158158

159159
### Static forms {#static_form}
160160

@@ -291,4 +291,3 @@ $textField = [
291291
If you use the code samples provided as examples in this topic, this would result in adding the following form to the Shipping Information step:
292292

293293
![The input form with four fields]({{ site.baseurl }}/common/images/how_checkout_form.png)
294-

guides/v2.2/howdoi/checkout/checkout_new_field.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ You can add new fields to default [checkout](https://glossary.magento.com/checko
1515
To add your custom field to the checkout address form and access its value on the client side:
1616

1717
1. [Add the field to layout](#add).
18-
2. [Add a JS mixin to modify data submission](#mixin).
19-
3. [Load your mixin](#load_mixin).
20-
4. [Add the field to address model](#field).
21-
5. [Access the value of the custom field on server side](#access).
18+
1. [Add a JS mixin to modify data submission](#mixin).
19+
1. [Load your mixin](#load_mixin).
20+
1. [Add the field to address model](#field).
21+
1. [Access the value of the custom field on server side](#access).
2222

2323
## Step 1: Add the field to layout {#add}
2424

@@ -200,6 +200,6 @@ class MyBlock extends Template {
200200
```
201201

202202
{:.ref-header}
203-
Related topics
203+
Related topic
204204

205-
- [EAV and extension attributes]({{ page.baseurl }}/extension-dev-guide/attributes.html)
205+
[EAV and extension attributes]({{ page.baseurl }}/extension-dev-guide/attributes.html)

guides/v2.2/howdoi/checkout/checkout_new_step.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ The default Magento [Checkout](https://glossary.magento.com/checkout) consists o
2020
You can add a custom checkout step, it should be implemented as a [UI component](https://glossary.magento.com/ui-component). For the sake of compatibility, upgradability and easy maintenance, do not edit the default Magento code, add your customizations in a separate [module](https://glossary.magento.com/module).
2121

2222
1. [Create the view part of the checkout step component](#create-view).
23-
2. [Add your step to the Checkout page layout](#checkout).
24-
3. [Create mixins for payment and shipping steps (optional)](#create-mixin).
23+
1. [Add your step to the Checkout page layout](#checkout).
24+
1. [Create mixins for payment and shipping steps (optional)](#create-mixin).
2525

2626
## Step 1: Create the view part of the checkout step component {#create-view}
2727

@@ -216,7 +216,7 @@ Create a mixin as follows:
216216
}
217217
```
218218

219-
2. Create the mixin. We'll use the same mixin for both payment and shipping:
219+
1. Create the mixin. We'll use the same mixin for both payment and shipping:
220220
221221
```js
222222
define(

guides/v2.2/howdoi/checkout/checkout_order.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ This topic describes how to add custom validations to be performed before the or
1515
To add custom validations before the order placement action, you must do the following:
1616

1717
1. [Create the validator](#validator).
18-
2. [Add validator to the validators pool](#pool).
19-
3. [Declare the validation in the checkout layout](#layout).
18+
1. [Add validator to the validators pool](#pool).
19+
1. [Declare the validation in the checkout layout](#layout).
2020

2121
## Step 1: Create the validator {#validator}
2222

guides/v2.2/howdoi/checkout/checkout_payment.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ functional_areas:
1212

1313
Out of the box, Magento [checkout](https://glossary.magento.com/checkout) consists of two steps:
1414

15-
- Shipping Information
16-
- Review and Payment Information
15+
- Shipping Information
16+
- Review and Payment Information
1717

1818
On the Review and Payment Information step the enabled payment methods are rendered. This topic describes how to add your custom [payment method](https://glossary.magento.com/payment-method) to this list.
1919

2020
To implement a payment method rendering in checkout, you need to take the following steps:
2121

2222
1. [Create the `.js` file implementing the component (payment method renderer).](#create)
23-
2. [Create the `.js` component registering the payment method renderer.](#register)
24-
3. [Create a template for the payment method renderer.](#template)
25-
4. [Declare the new payment in the checkout page layout.](#layout)
23+
1. [Create the `.js` component registering the payment method renderer.](#register)
24+
1. [Create a template for the payment method renderer.](#template)
25+
1. [Declare the new payment in the checkout page layout.](#layout)
2626

2727
## Step 1: Create the .js component file {#create}
2828

guides/v2.2/howdoi/checkout/checkout_shipping_methods.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@ This topic describes how to customize list of shipping methods displayed on the
1313
Let's consider a case where you need to add a collapsible text field with description for each shipping method in this list. To achieve this, you need to take the following steps:
1414

1515
1. [Create a new template for the shipping method item](#method-item).
16-
2. [Create a new template for the shipping method list](#method-list).
17-
3. [Override the shipping step configuration](#shipping).
16+
1. [Create a new template for the shipping method list](#method-list).
17+
1. [Override the shipping step configuration](#shipping).
1818

1919
## Step 1: Create new template for shipping method item {#method-item}
2020

2121
In your custom module directory, create a new file: `<your_module_dir>/view/frontend/web/template/custom-method-item-template.html`. In this file, add the following code.
2222

2323
It is copied from the `<Magento_Checkout_module_dir>/view/frontend/web/template/shipping-address/shipping-method-item.html` template, with the following modifications:
2424

25-
* A `<tr>` element added to contain the shipping method description
26-
* A column with trigger elements that provide the collapse/expand functionality added
27-
* The entire sample wrapped in `<tbody>` to provide the general collapsible context for rows
25+
* A `<tr>` element added to contain the shipping method description
26+
* A column with trigger elements that provide the collapse/expand functionality added
27+
* The entire sample wrapped in `<tbody>` to provide the general collapsible context for rows
2828

2929
```html
3030
<!-- Initialize collapsible binding -->
@@ -79,8 +79,8 @@ It is copied from the `<Magento_Checkout_module_dir>/view/frontend/web/template/
7979

8080
In your custom module directory, create a new file: `<your_module_dir>/view/frontend/web/template/custom-method-list-template.html`. In this file, add the following code. It uses the code from the `app/code/Magento/Checkout/view/frontend/web/template/shipping-address/shipping-method-list.html` template, with the following modifications:
8181

82-
* A column for triggers added in `<thead>`
83-
* `tbody` moved to the item template for collapsible context
82+
* A column for triggers added in `<thead>`
83+
* `tbody` moved to the item template for collapsible context
8484

8585
```html
8686
<div id="checkout-shipping-method-load">

guides/v2.2/howdoi/customize-form-configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ To customize the product creation form, take the following steps:
1515

1616
1. In your custom module, add an empty `product_form.xml` in the `<your_module_dir>/view/adminhtml/ui_component/` directory.
1717

18-
2. In this file, add content similar to the following:
18+
1. In this file, add content similar to the following:
1919

2020
```xml
2121
<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
@@ -78,6 +78,6 @@ To delete an existing field, or field set, in your `product_form.xml` use the fo
7878

7979
For reference, view the product form configuration files of the Magento modules:
8080

81-
* `<Magento_Catalog_module_dir>/view/adminhtml/ui_component/product_form.xml`
82-
* `<Magento_CatalogInventory_module_dir>/view/adminhtml/ui_component/product_form.xml`
83-
* `<Magento_ConfigurableProduct_module_dir>/view/adminhtml/ui_component/product_form.xml`
81+
* `<Magento_Catalog_module_dir>/view/adminhtml/ui_component/product_form.xml`
82+
* `<Magento_CatalogInventory_module_dir>/view/adminhtml/ui_component/product_form.xml`
83+
* `<Magento_ConfigurableProduct_module_dir>/view/adminhtml/ui_component/product_form.xml`

guides/v2.2/howdoi/customize-modifier-class.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The `Magento\Catalog\Ui\DataProvider\Product\Form\ProductDataProvider` data prov
1818
To add your custom modifier, you need to do the following:
1919

2020
1. [Add the modifier code.](#modifier)
21-
2. [Add it to the modifiers' pool in `di.xml`](#pool)
21+
1. [Add it to the modifiers' pool in `di.xml`](#pool)
2222

2323
## Add your modifier {#modifier}
2424

@@ -119,9 +119,9 @@ To access product model within your modifier, it's recommended to use an instanc
119119

120120
For reference, view the modifier classes in the Magento modules, for example:
121121

122-
- [`Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AdvancedPricing`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AdvancedPricing.php)
123-
- [`Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AttributeSet`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AttributeSet.php)
124-
- [`Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Eav`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Eav.php)
125-
- [`Magento/ConfigurableProduct/Ui/DataProvider/Product/Form/Modifier/Data/AssociatedProducts`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/ConfigurableProduct/Ui/DataProvider/Product/Form/Modifier/Data/AssociatedProducts.php)
122+
- [`Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AdvancedPricing`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AdvancedPricing.php)
123+
- [`Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AttributeSet`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AttributeSet.php)
124+
- [`Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Eav`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Eav.php)
125+
- [`Magento/ConfigurableProduct/Ui/DataProvider/Product/Form/Modifier/Data/AssociatedProducts`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/ConfigurableProduct/Ui/DataProvider/Product/Form/Modifier/Data/AssociatedProducts.php)
126126

127127
For reference about setting conditions for displaying certain elements for certain product types, view `<Magento_Catalog_module_dir>/Ui/DataProvider/Product/Form/Modifier/Eav.php#L476`.

guides/v2.3/howdoi/checkout/checkout-add-custom-carrier.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ This topic describes how to add a custom shipping carrier.
1717
To add a new shipping carrier to the Magento checkout:
1818

1919
1. [Create a new module](#create-module)
20-
2. [Add the carrier configuration](#create-configuration)
21-
3. [Create the carrier model](#carrier-model)
22-
4. [Enable the module](#enable-module)
20+
1. [Add the carrier configuration](#create-configuration)
21+
1. [Create the carrier model](#carrier-model)
22+
1. [Enable the module](#enable-module)
2323

2424
## Step 1: Create a new module {#create-module}
2525

@@ -100,14 +100,14 @@ To add a module configuration use the following source code snippets.
100100

101101
The `system.xml` source code declares custom shipping module options:
102102

103-
- Enabled
104-
- Title
105-
- Method Name
106-
- Shipping Cost
107-
- Ship to Applicable Countries
108-
- Ship to Specific Countries
109-
- Show Method if Not Applicable
110-
- Sort Order
103+
- Enabled
104+
- Title
105+
- Method Name
106+
- Shipping Cost
107+
- Ship to Applicable Countries
108+
- Ship to Specific Countries
109+
- Show Method if Not Applicable
110+
- Sort Order
111111

112112
```xml
113113
<?xml version="1.0"?>

0 commit comments

Comments
 (0)