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

Commit 8539af4

Browse files
Markdown linting: Fix MD007 errors and enable rule (#5662)
* Fixed MD007 errors * Fixed MD007 errors * Fixed MD007 errors * Apply suggestions from code review Co-Authored-By: Kevin Harper <keharper@users.noreply.github.com> * Fixed trailing space * Fix final errors and enable rule
1 parent 0a9d400 commit 8539af4

63 files changed

Lines changed: 2381 additions & 2326 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

_checks/styles/style-rules-prod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ rule 'MD003', :style => :atx
44
rule 'MD004'
55
rule 'MD005'
66
rule 'MD006'
7-
exclude_rule 'MD007'
7+
rule 'MD007', :indent => 3
88
rule 'MD009'
99
rule 'MD010'
1010
exclude_rule 'MD011'

_includes/contributor/rewards.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ Due to the level of work required for developing and reviewing a PR, Contributor
1111

1212
See the following examples for calculated reward points:
1313

14-
- Contributor submits PR with complex code contributions: Improvement(base) 10 points + Complex(additional) 20 points = 30 points
15-
- Contributor submits PR with complex code and tests: Improvement(base) 10 points + Complex(additional) 20 points + Test coverage(additional) 10 points = 40 points
16-
- Contributor submits PR port of existing merged PR:
17-
- Original contributor: (Improvement(base) 10 points + Complex(additional) 20 points) + Author of Ported Issue 5 points = 35 points
18-
- Porting contributor: Port(base) 5 points
19-
- Maintainer reviews and approves PR with complex code and tests: Improvement(base) 10 points + Complex(additional) 20 points + Test coverage(additional) 10 points = 40 points
14+
- Contributor submits PR with complex code contributions: Improvement(base) 10 points + Complex(additional) 20 points = 30 points
15+
- Contributor submits PR with complex code and tests: Improvement(base) 10 points + Complex(additional) 20 points + Test coverage(additional) 10 points = 40 points
16+
- Contributor submits PR port of existing merged PR:
17+
- Original contributor: (Improvement(base) 10 points + Complex(additional) 20 points) + Author of Ported Issue 5 points = 35 points
18+
- Porting contributor: Port(base) 5 points
19+
- Maintainer reviews and approves PR with complex code and tests: Improvement(base) 10 points + Complex(additional) 20 points + Test coverage(additional) 10 points = 40 points
2020

2121
Earned achievements display as labels on GitHub PRs and for each Magento Contributor, Partner, and Maintainer on [magento.com](https://magento.com/magento-contributors).
2222

@@ -54,8 +54,8 @@ Contributors and Maintainers can also earn rewards for merged submissions to the
5454

5555
See the following examples for calculated reward points:
5656

57-
- Contributor submits PR with HTML formatting and typos fixes: Editorial(base) 1 point
58-
- Contributor submits PR with code sample update and new parameter descriptions: Improvement(base) 10 points + Major update(additional) 20 points = 30 points
57+
- Contributor submits PR with HTML formatting and typos fixes: Editorial(base) 1 point
58+
- Contributor submits PR with code sample update and new parameter descriptions: Improvement(base) 10 points + Major update(additional) 20 points = 30 points
5959

6060
### Base achievements
6161
{:.no_toc}

_includes/php-dev/component-root-2.3.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
A component's root directory matches the component's name and contains all its subdirectories and files. Based on how you installed Magento, you can put your component's root directory in one of two places:
44

5-
* `<Magento install directory>/app`: This is the *recommended* location for component development. You can set up this environment by [Cloning the Magento 2 GitHub repository]({{page.baseurl}}/install-gde/prereq/dev_install.html).
5+
* `<Magento install directory>/app`: This is the *recommended* location for component development. You can set up this environment by [Cloning the Magento 2 GitHub repository]({{page.baseurl}}/install-gde/prereq/dev_install.html).
66

7-
* For modules, use `app/code`.
8-
* For storefront themes, use `app/design/frontend`.
9-
* For Admin themes, use `app/design/adminhtml`.
10-
* For language packages, use `app/i18n`.
7+
* For modules, use `app/code`.
8+
* For storefront themes, use `app/design/frontend`.
9+
* For Admin themes, use `app/design/adminhtml`.
10+
* For language packages, use `app/i18n`.
1111

12-
* `<Magento install directory>/vendor`: You will find this location for installations that use the [`composer create-project`]({{page.baseurl}}/install-gde/composer.html) to install the Magento 2 metapackage (which downloads the CE or EE code). You will also find this location if you install Magento by extracting the [compressed Magento 2 archive]({{page.baseurl}}/install-gde/prereq/zip_install.html).
12+
* `<Magento install directory>/vendor`: You will find this location for installations that use the [`composer create-project`]({{page.baseurl}}/install-gde/composer.html) to install the Magento 2 metapackage (which downloads the CE or EE code). You will also find this location if you install Magento by extracting the [compressed Magento 2 archive]({{page.baseurl}}/install-gde/prereq/zip_install.html).
1313

1414
Magento installs third-party components in the `vendor` directory. But we recommend adding your components to the `app/code` directory. If you put your component in the `vendor` directory, Git will ignore it because Magento adds the `vendor` directory to the `.gitignore` file.
1515

_includes/php-dev/component-root.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
A component's root directory is the top-level directory for that component under which its folders and files are located. Depending on how your Magento development environment was installed, your component's root directory can be located in two places:
44

5-
* `<Magento install directory>/app`: This is the *recommended* location for component development. You can easily set up this type of environment by [Cloning the Magento 2 GitHub repository]({{ page.baseurl }}/install-gde/prereq/dev_install.html).
5+
* `<Magento install directory>/app`: This is the *recommended* location for component development. You can easily set up this type of environment by [Cloning the Magento 2 GitHub repository]({{ page.baseurl }}/install-gde/prereq/dev_install.html).
66

7-
* For modules, use `app/code`.
8-
* For storefront themes, use `app/design/frontend`.
9-
* For Admin themes, use `app/design/adminhtml`.
10-
* For language packages, use `app/i18n`.
7+
* For modules, use `app/code`.
8+
* For storefront themes, use `app/design/frontend`.
9+
* For Admin themes, use `app/design/adminhtml`.
10+
* For language packages, use `app/i18n`.
1111

12-
* `<Magento install directory>/vendor`: This location is found in the alternative setups where the {% if page.guide_version == "2.0" %} [`composer create-project`]({{page.baseurl}}/install-gde/prereq/integrator_install.html) {% else %} [`composer create-project`]({{page.baseurl}}/install-gde/composer.html). {% endif %} command was used to get a Magento 2 metapackage (which downloads the CE or EE code), or a [compressed Magento 2 archive]({{ page.baseurl }}/install-gde/prereq/zip_install.html) was extracted in order to install Magento.
12+
* `<Magento install directory>/vendor`: This location is found in the alternative setups where the {% if page.guide_version == "2.0" %} [`composer create-project`]({{page.baseurl}}/install-gde/prereq/integrator_install.html) {% else %} [`composer create-project`]({{page.baseurl}}/install-gde/composer.html). {% endif %} command was used to get a Magento 2 metapackage (which downloads the CE or EE code), or a [compressed Magento 2 archive]({{ page.baseurl }}/install-gde/prereq/zip_install.html) was extracted in order to install Magento.
1313

1414
Any third party components (and the Magento application itself) are downloaded and stored under the `vendor` directory. If you are using Git to manage project, this directory is typically added to the `.gitignore` file. Therefore, we recommend you do your customization work in `app/code`, not `vendor`.
1515

_includes/vendor/types-def.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
where
22

3-
* `<your component base dir>` is the base directory in which your component is located. Typical values are `app/code` or `vendor` relative to the Magento installation directory.
4-
* `<vendorname>` is the component's vendor name; for example, Magento's vendor name is `magento`.
5-
* `<component-type>` is one of the following:
3+
* `<your component base dir>` is the base directory in which your component is located. Typical values are `app/code` or `vendor` relative to the Magento installation directory.
4+
* `<vendorname>` is the component's vendor name; for example, Magento's vendor name is `magento`.
5+
* `<component-type>` is one of the following:
66

7-
* `module-`: An extension or module.
8-
* `theme-`: Theme.
9-
* `language-`: Language package.
7+
* `module-`: An extension or module.
8+
* `theme-`: Theme.
9+
* `language-`: Language package.
1010

1111
{:.bs-callout .bs-callout-info}
1212
Currently, themes are located under `<magento_root>/app/design/frontend` or `<magento_root>/app/design/adminhtml`.

_videos/fundamentals/add-new-product-attribute.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -179,16 +179,16 @@ To see all the mappings, you should look at the `\Magento\Catalog\Model\Resource
179179

180180
For now, we’ll just quickly go through most important ones:
181181

182-
* **group:** Means that we add an attribute to the attribute group “General”, which is present in all attribute sets.
183-
* **type:** varchar means that the values will be stored in the catalog_eav_varchar table.
184-
* **label:** A label of the attribute (that is, how it will be rendered in the backend and on the frontend).
185-
* **source/frontend/backend:** Special classes associated with the attribute:
186-
* **source model:** provides a list of options
187-
* **frontend:** defines how it should be rendered on the frontend
188-
* **backend:** allows you to perform certain actions when an attribute is loaded or saved. In our example, it will be validation.
189-
* **Global:** defines the scope of its values (global, website, or store)
190-
* **visible_on_front:** A flag that defines whether an attribute should be shown on the “More Information” tab on the frontend
191-
* **is_html_allowed_on_front:** Defines whether an attribute value may contain HTML
182+
* **group:** Means that we add an attribute to the attribute group “General”, which is present in all attribute sets.
183+
* **type:** varchar means that the values will be stored in the catalog_eav_varchar table.
184+
* **label:** A label of the attribute (that is, how it will be rendered in the backend and on the frontend).
185+
* **source/frontend/backend:** Special classes associated with the attribute:
186+
* **source model:** provides a list of options
187+
* **frontend:** defines how it should be rendered on the frontend
188+
* **backend:** allows you to perform certain actions when an attribute is loaded or saved. In our example, it will be validation.
189+
* **Global:** defines the scope of its values (global, website, or store)
190+
* **visible_on_front:** A flag that defines whether an attribute should be shown on the “More Information” tab on the frontend
191+
* **is_html_allowed_on_front:** Defines whether an attribute value may contain HTML
192192

193193
## Step 3: Add a source model
194194

community/resources/multi-repo-docs.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ This is the first of many new options for expanding documentation for developers
1414

1515
You get to:
1616

17-
- Keep your doc files in the same repo as your code.
18-
- Manage doc updates by following the same GitHub processes you use for your code.
17+
- Keep your doc files in the same repo as your code.
18+
- Manage doc updates by following the same GitHub processes you use for your code.
1919

2020
The DevDocs team :
2121

22-
- Reviews, edits, and formats your docs.
23-
- Automates content publishing using our CI/CD process, without moving your files.
22+
- Reviews, edits, and formats your docs.
23+
- Automates content publishing using our CI/CD process, without moving your files.
2424

2525
## How does it work?
2626

@@ -29,10 +29,10 @@ The DevDocs team :
2929
1. Create a `docs` directory in the root of your public repository. If you have images, add an `images` sudirectory.
3030
1. Write simple markdown (`.md`) files using [kramdown](https://kramdown.gettalong.org/syntax.html).
3131
1. Contact [Lori Krell](mailto:lkrell@adobe.com) in Community Engineering with the following details:
32-
- Project name or feature
33-
- GitHub Repository link
34-
- Contact for your project
35-
- Any additional information such as type of content, labels used for doc issues, if you need diagrams, and so on
32+
- Project name or feature
33+
- GitHub Repository link
34+
- Contact for your project
35+
- Any additional information such as type of content, labels used for doc issues, if you need diagrams, and so on
3636

3737
## What happens next?
3838

@@ -53,4 +53,4 @@ To ensure quality documentation, your content must pass a quality review and acc
5353

5454
Use any IDE to write content. All IDEs support markdown files (.md), including extensions that check formatting as you write. We recommend using [Kramdown](https://kramdown.gettalong.org/syntax.html), which includes markdown formatting.
5555

56-
We will add more technical information as we release Multi-Repo Doc support and features.
56+
We will add more technical information as we release Multi-Repo Doc support and features.

extensions/amazon-sales/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ Amazon Sales Channel install is a `.zip` file available from the Magento Marketp
2424
1. Export the contents to your Magento root.
2525
1. Follow all instructions for Extension [Installation]({{ site.baseurl }}/extensions/install/).
2626
1. Update the services connector entry in your `composer.json` file
27-
- Add the extension’s name and version to your composer.json file:
28-
- Navigate to your Magento project directory and update your composer.json file.
27+
- Add the extension’s name and version to your composer.json file:
28+
- Navigate to your Magento project directory and update your composer.json file.
2929

3030
```bash
3131
composer require magento/services-connector:~1.0.3
3232
```
3333

34-
- Enter your [authentication keys]({{ site.baseurl }}/guides/v{{ site.version }}/install-gde/prereq/connect-auth.html). Your public key is your username; your private key is your password.
35-
- Wait for Composer to finish updating your project dependencies and make sure there aren’t any errors.
34+
- Enter your [authentication keys]({{ site.baseurl }}/guides/v{{ site.version }}/install-gde/prereq/connect-auth.html). Your public key is your username; your private key is your password.
35+
- Wait for Composer to finish updating your project dependencies and make sure there aren’t any errors.
3636
1. After installing, enter an [API Key](https://docs.magento.com/m2/ce/user_guide/sales-channels/amazon/amazon-verify-api-key.html) to complete configuration.
3737

3838
## Add the Amazon Sales Channel API key
@@ -43,23 +43,23 @@ To add the Amazon Sales Channel API key:
4343

4444
1. On the Admin sidebar, click **Marketing**. Then under **Channels**, click **Amazon**.
4545

46-
If you need an API Key, the following screen displays.
46+
If you need an API Key, the following screen displays.
4747

48-
![Onboarding API Key Verification](images/amazon-api-key.png)
48+
![Onboarding API Key Verification](images/amazon-api-key.png)
4949

5050
1. Click **Sign in** to access your Magento web account. The [Magento Accounts](https://account.magento.com/customer/account/login) page loads, displaying the **API Portal** tab.
5151

52-
You may need to login with your Magento web account credentials. If you need to create an account, visit [here](https://account.magento.com/customer/account/login) and register.
52+
You may need to login with your Magento web account credentials. If you need to create an account, visit [here](https://account.magento.com/customer/account/login) and register.
5353

5454
1. API keys are available through the **API Portal** tab. Copy the key.
5555

56-
If you need to create a new key, enter a description like "Amazon Sales Channel" and click **Add**. Copy this new key.
56+
If you need to create a new key, enter a description like "Amazon Sales Channel" and click **Add**. Copy this new key.
5757

58-
![Copy or generate an API Key](images/config-api-portal.png)
58+
![Copy or generate an API Key](images/config-api-portal.png)
5959

6060
1. Return to the Magento Admin tab and click **Add the key** on the Amazon welcome screen.
6161

62-
A store configuration page opens to **Stores** > **Configuration** > **Services** > **Magento Services**.
62+
A store configuration page opens to **Stores** > **Configuration** > **Services** > **Magento Services**.
6363

6464
1. On the Api Keys screen, paste the key you copied for **Production API Key**.
6565

guides/v2.2/architecture/archi_perspectives/domain_layer.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ menu_title: Domain layer
88

99
The [domain](https://glossary.magento.com/domain) layer holds the business logic layer of a Magento [module](https://glossary.magento.com/module). It typically does not contain resource-specific or database-specific information. Its primary functions include:
1010

11-
* Defining the generic Magento data objects, or models, that contain business logic. This logic defines which operations can be performed on particular types of data, such as a Customer object. These models contain generic information only. Applications can also use SOAP or RESTful endpoints to request data from models.
11+
* Defining the generic Magento data objects, or models, that contain business logic. This logic defines which operations can be performed on particular types of data, such as a Customer object. These models contain generic information only. Applications can also use SOAP or RESTful endpoints to request data from models.
1212

13-
* (Optionally) Including the implementation of service contracts, although not their definition.
13+
* (Optionally) Including the implementation of service contracts, although not their definition.
1414

1515
{:.bs-callout .bs-callout-tip}
1616
**Best practice:** Use service contracts to communicate with the domain layer by passing data types through strongly typed objects. This helps you avoid the need to replace presentation layer code when replacing business layer logic.
@@ -23,17 +23,17 @@ Each domain-layer model contains a reference to a resource model, which it uses
2323

2424
There are three primary ways of accessing a module's domain-layer code:
2525

26-
* Service contracts are the recommended way for one module to access another module's domain-level code. This loosely coupled solution is the optimal way for most modules to access another module.
26+
* Service contracts are the recommended way for one module to access another module's domain-level code. This loosely coupled solution is the optimal way for most modules to access another module.
2727

28-
* A module can directly call into another module. This tightly coupled solution is not recommended for most situations, but is sometimes unavoidable.
28+
* A module can directly call into another module. This tightly coupled solution is not recommended for most situations, but is sometimes unavoidable.
2929

30-
* Domain layer code in one module can also plug itself into another module by:
30+
* Domain layer code in one module can also plug itself into another module by:
3131

32-
* event hooks
32+
* event hooks
3333

34-
* plugins
34+
* plugins
3535

36-
* `di.xml` files (with an SPI contract)
36+
* `di.xml` files (with an SPI contract)
3737

3838
Your strategy for calling another module's domain-layer code is highly dependent upon the unique configuration and needs of your system.
3939

0 commit comments

Comments
 (0)