Enable linting rule MD032 (blank lines around lists) (#5415)

* Fixed .github files * Fixed README * Fixed README * Fixed includes * Fixed UI component guide topics * Fixed test topic * Fixed rest topics * Fixed soap topics * Fixed release notes * Fixed performance topics * Fixed architecture topics * Fixed comp mgr topics * Fixed contributor guide topics * Fixed migration topics * Fixed install topics * Fixed pattern library topics * Fixed pattern library topics * Fixed marketplace topic * Fixed howdoi topics * Fixed inventory topics * Fixed get started topics * Fixed design style guide topics * Fixed code standard topics * Fixed config guide topics * Fixed extension dev guide topics * Fixed frontend dev guide topics * Fixed JS dev topics * Fixed graphql topics * Fixed cloud topics * Fixed mtf topics * Fixed multi-line note format in config guide * Turn rule off
magento · Sep 18, 2019 · 7030371 · 7030371
1 parent e4df946
commit 7030371
Show file tree

Hide file tree

Showing 163 changed files with 2,920 additions and 255 deletions.
diff --git a/.github/ISSUE_TEMPLATE/COMMUNITY_ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/COMMUNITY_ISSUE_TEMPLATE.md
@@ -8,6 +8,7 @@ about: Create an issue related to a community engineering effort
 <!-- (REQUIRED) Provide information for the doc request including any Community code issues or PRs, Magento versions, or devdoc pages. -->
 
 Type of Doc:
+
 - [ ] New topic
 - [ ] Topic Update, Devdoc link:
 - [ ] Other
@@ -17,13 +18,15 @@ Magento 2 GitHub Issue: https://github.com/magento/devdocs/issues/link
 Magento 2 GitHub PR: https://github.com/magento/devdocs/pull/link
 
 Magento 2 version:
+
 - [ ] 2.1.X
 - [ ] 2.2.X
 - [ ] 2.3.X
 - [ ] back port
 - [ ] forward port
 
 Notifications of Changes:
+
 - [ ] Changes to Admin interface?
 - [ ] New software requirements?
 - [ ] New REST endpoints or updated GraphQL query syntax?

diff --git a/README.md b/README.md
@@ -111,7 +111,8 @@ If rake fails on your environment, generate the preview [using jekyll](#using-je
 ### To minimize build time locally:
 
 1. Create a `_config.local.yml` file at the root of the project directory and exclude all versions except the one that you want to preview.
-The following example will generate Magento 2.2 documentation only.
+
+   The following example will generate Magento 2.2 documentation only.
 
    ```yaml
     exclude:
@@ -138,7 +139,9 @@ The following example will generate Magento 2.2 documentation only.
    ```
    $ rake preview
    ```
+
    This command:
+
    * Checks your environment according to the dependencies in `Gemfile.lock`.
    * Removes the `_site/` directory, which contains previously generated preview files.
    * Generates a new preview and opens the landing page in a web browser.

diff --git a/_includes/cache/page-cache-overview.md b/_includes/cache/page-cache-overview.md
@@ -35,4 +35,3 @@ Reverse proxies serve "public" or shared content to more than one user. However,
 -   **[Public]({{ page.baseurl }}/extension-dev-guide/cache/page-caching/public-content.html)** - Public content is stored server side in your reverse proxy cache storage (e.g., file system, database, Redis, or Varnish) and is available to multiple customers. Examples of public content include header, footer, and category listing.
 
 -   **[Private]({{ page.baseurl }}/extension-dev-guide/cache/page-caching/private-content.html)** - Private content is stored client side (e.g., browser) and is specific to an individual customer. Examples of private content include wishlist, shopping cart, customer name, and address. You should limit stored private content to a small portion of the page's total content.
-</div>
diff --git a/_includes/cloud/enable-ssh.md b/_includes/cloud/enable-ssh.md
@@ -28,6 +28,7 @@ If you have SSH keys, a directory listing is displayed similar to the following:
 If you do not have SSH keys, you need to generate the keys for adding to your Magento ECE account and GitHub account. See [Create a new SSH key pair](#ssh-create-new-key-pair).
 
 If you already have SSH keys, continue to:
+
 * [Add a public SSH key to your Magento account](#ssh-add-to-account) section
 * [Add your SSH key to your GitHub account](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/)
 

diff --git a/_includes/config/es-elasticsearch-magento.md b/_includes/config/es-elasticsearch-magento.md
@@ -30,6 +30,7 @@ Unless you changed Elasticsearch server settings, the defaults should work. Skip
 |**Enable Elasticsearch HTTP Auth**|Click **Yes** only if you enabled authentication for your Elasticsearch server. If so, provide a username and password in the provided fields.|
 
 {:start="4"}
+
 1. Click **Test Connection**.
 
 You will see either:
@@ -49,11 +50,11 @@ If so, try the following:
 
 * Make sure the Elasticsearch server is running.
 * If the Elasticsearch server is on a different host from Magento, log in to the Magento server and ping the Elasticsearch host. Resolve network connectivity issues and test the connection again.
-* Examine the command window in which you started Elasticsearch for stack traces and exceptions. You must resolve those before you continue.
-In particular, make sure you started Elasticsearch as a user with `root` privileges.
+* Examine the command window in which you started Elasticsearch for stack traces and exceptions. You must resolve those before you continue. In particular, make sure you started Elasticsearch as a user with `root` privileges.
 * Make sure that [UNIX firewall and SELinux]({{ page.baseurl }}/config-guide/elasticsearch/es-overview.html#firewall-selinux) are both disabled, or set up rules to enable Elasticsearch and Magento to communicate with each other.
 * Verify the value of the **Elasticsearch Server Hostname** field. Make sure the server is available. You can try the server's IP address instead.
 * Use the command `netstat -an | grep **listen-port**` command to verify that the port specified in the **Elasticsearch Server Port** field is not being used by another process.
+
   For example, to see if Elasticsearch is running on its default port, use the following command:
 
   ```bash

diff --git a/_includes/config/multi-site_verify.md b/_includes/config/multi-site_verify.md
@@ -14,6 +14,7 @@ Unless you have DNS set up for your stores' URLs, you must add a static route to
 You're done!
 
 {:.bs-callout .bs-callout-info}
+
 * Additional tasks might be required to deploy multiple websites in a hosted environment; check with your hosting provider for more information.
 * Additional tasks are required to set up {{site.data.var.ece}}; for more information, see [Set up multiple Cloud websites or stores]({{ page.baseurl }}/cloud/project/project-multi-sites.html)
 

diff --git a/_includes/config/setup-cron.md b/_includes/config/setup-cron.md
@@ -5,11 +5,13 @@ Magento uses cron for two sets of tasks, and for each, cron can run with a diffe
 *	PHP command-line configuration: The general cron job that reindexes indexers, generates e-mails, generates the sitemap, and so on.
 
 	You can find the command-line configuration using the command `php --ini`.
+
 *	Web server PHP plug-in configuration: Two other cron jobs are used by the [Component Manager and System Upgrade utilities]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html).
 
 	You can find the web server plug-in configuration using [`phpinfo.php`]({{ page.baseurl }}/install-gde/prereq/optional.html#install-optional-phpinfo).
 
 {:.bs-callout .bs-callout-warning}
+
 *	To avoid issues during installation and upgrade, we strongly recommend you apply the same PHP settings to both the PHP command-line configuration and to the PHP web server plug-in's configuration. For more information, see [Required PHP settings]({{ page.baseurl }}/install-gde/prereq/php-settings.html).
 *	In a multi-node system, crontab can run on only one node. This applies to you only if you set up more than one webnode for reasons related to performance or scalability.
 

diff --git a/_includes/config/setup-cron_2.2.md b/_includes/config/setup-cron_2.2.md
@@ -9,6 +9,7 @@ Magento uses cron for two sets of tasks, and for each, cron can run with a diffe
 *	Web server PHP plug-in configuration: Two other cron jobs are used by the [Component Manager and System Upgrade utilities]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html).
 
 {:.bs-callout .bs-callout-warning}
+
 *	To avoid issues during installation and upgrade, we strongly recommend you apply the same PHP settings to both the PHP command-line configuration and to the PHP web server plug-in's configuration. For more information, see [Required PHP settings]({{ page.baseurl }}/install-gde/prereq/php-settings.html).
 *	In a multi-node system, crontab can run on only one node. This applies to you only if you set up more than one webnode for reasons related to performance or scalability.
 

diff --git a/_includes/config/setup-cron_2.2_about.md b/_includes/config/setup-cron_2.2_about.md
@@ -9,5 +9,6 @@ Magento uses cron for two sets of tasks, and for each, cron can run with a diffe
 *	Web server PHP plug-in configuration: Two other cron jobs are used by the [Component Manager and System Upgrade utilities]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html).
 
 {:.bs-callout .bs-callout-warning}
+
 *	To avoid issues during installation and upgrade, we strongly recommend you apply the same PHP settings to both the PHP command-line configuration and to the PHP web server plug-in's configuration. For more information, see [Required PHP settings]({{ page.baseurl }}/install-gde/prereq/php-settings.html).
 *	In a multi-node system, crontab can run on only one node. This applies to you only if you set up more than one webnode for reasons related to performance or scalability.
diff --git a/_includes/config/setup-cron_2.2_how-to.md b/_includes/config/setup-cron_2.2_how-to.md
@@ -15,6 +15,7 @@ To create the Magento crontab:
 Use `--force` to rewrite an existing Magento crontab.
 
 {:.bs-callout .bs-callout-info}
+
 *	`magento cron:install` does not rewrite an existing crontab inside `#~ MAGENTO START` and `#~ MAGENTO END` comments in your crontab.
 *	`magento cron:install --force` has no effect on any cron jobs outside the Magento comments.
 

diff --git a/_includes/config/split-deploy/split-deploy-overview.md b/_includes/config/split-deploy/split-deploy-overview.md
@@ -23,6 +23,7 @@ Staging system
 
 Production system
 : Your live store. You should make minimal configuration changes here and no changes to:
+
    - websites
    - stores
    - store views

diff --git a/_includes/install/enable-disable-modules.md b/_includes/install/enable-disable-modules.md
@@ -12,8 +12,7 @@ Examples:
 
 -   Module A conflicts with Module B. You can disable Module A and Module B, or you can disable either module but you *cannot* enable Module A and Module B at the same time.
 
--   Dependencies are declared in the `require` field in Magento's `composer.json` file for each module. Conflicts are declared in the `conflict` field in modules' `composer.json` files. We use that information to build a dependency graph:
-`A->B` means module A depends on module B.
+-   Dependencies are declared in the `require` field in Magento's `composer.json` file for each module. Conflicts are declared in the `conflict` field in modules' `composer.json` files. We use that information to build a dependency graph: `A->B` means module A depends on module B.
 
 -   A *dependency chain* is the path from a module to another one. For example, if module A depends on module B and module B depends on module C, then the dependency chain is `A->B->C`.
 

diff --git a/_includes/install/file-system-umask.md b/_includes/install/file-system-umask.md
@@ -20,13 +20,17 @@ To set `magento_umask`:
 
 1. In a command line terminal, log in to your Magento server as a [Magento file system owner][].
 2. Navigate to the Magento install directory:
-```bash
- cd <Magento install directory>
-```
+
+   ```bash
+   cd <Magento install directory>
+   ```
+
 3. Use the following command to create a file named `magento_umask` and write the `umask` value to it.
+
    ```bash
    echo <desired umask number> > magento_umask
    ```
+
    You should now have a file named `magento_umask` in the `<Magento install dir>` with the only content being the `umask` number.
 
 4. Log out and log back in as the [Magento file system owner][] to apply the changes.

diff --git a/_includes/install/first-steps-cli.md b/_includes/install/first-steps-cli.md
@@ -24,6 +24,7 @@ export PATH=$PATH:/var/www/html/magento2/bin
 
 {:.bs-callout .bs-callout-info}
 You can also run the commands in the following ways:
+
 - `cd <magento_root>/bin` and run them as `./magento <command name>`
 - `<magento_root>/bin/magento <command name>`
 - `<magento_root>` is a subdirectory of your web server's docroot. [Need help locating the docroot?]({{ page.baseurl }}/install-gde/basics/basics_docroot.html)
diff --git a/_includes/install/fully-secure.md b/_includes/install/fully-secure.md
@@ -5,6 +5,5 @@ To use Secure Sockets Layer (SSL), also referred to as HTTPS, for both the Magen
 *	`--use-secure`: Set to `1`
 *	`--base-url-secure`: Set to a secure URL (that is, starting with `https://`)
 *	`--use-secure-admin` Set to `1`
-<!-- *	`--base-url`: Set to a secure URL (that is, starting with `https://`) -->
 
 More details about these parameters can be found later in this topic.
diff --git a/_includes/install/php-versions-template.md b/_includes/install/php-versions-template.md
@@ -1,5 +1,7 @@
 Supported PHP versions:
 
 {% for version in supported_php_versions %}
+
 * {{ version }}
-{% endfor %}
+
+{% endfor %}
diff --git a/_includes/install/releasenotes/21_release-notes-links.md b/_includes/install/releasenotes/21_release-notes-links.md
@@ -1,5 +1,6 @@
 
 {% collapsibleh2 Magento Open Source 2.1 Release Notes %}
+
 *	[Version 2.1.12]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.12CE.html){:target="_blank"}
 *	[Version 2.1.11]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.11CE.html){:target="_blank"}
 *	[Version 2.1.10]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.10CE.html){:target="_blank"}
@@ -17,6 +18,7 @@
 {% endcollapsibleh2 %}
 
 {% collapsibleh2 Magento Commerce 2.1 Release Notes %}
+
 *	[Version 2.1.12]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.12EE.html){:target="_blank"}
 *	[Version 2.1.11]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.11EE.html){:target="_blank"}
 *	[Version 2.1.10]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.10EE.html){:target="_blank"}

diff --git a/guides/v2.2/architecture/archi_perspectives/present_layer.md b/guides/v2.2/architecture/archi_perspectives/present_layer.md
@@ -34,8 +34,7 @@ Magento generates the [HTML](https://glossary.magento.com/html) for a page to di
 
 View elements fall into two main categories: blocks and containers.
 
-* **Blocks** can generate [dynamic content](https://glossary.magento.com/dynamic-content) and can contain named child view elements that are similar to arguments being passed in.
-(The `as` attribute holds the child view element names for the parent block to reference them)
+* **Blocks** can generate [dynamic content](https://glossary.magento.com/dynamic-content) and can contain named child view elements that are similar to arguments being passed in. (The `as` attribute holds the child view element names for the parent block to reference them)
 
 * **Containers** collect an ordered group of children view elements.
 

diff --git a/guides/v2.2/architecture/archi_perspectives/service_layer.md b/guides/v2.2/architecture/archi_perspectives/service_layer.md
@@ -15,8 +15,7 @@ In general, the service layer:
 
 * Contains service contracts, which define how the implementation will behave.
 
-* Provides an easy way to access the REST/SOAP [API](https://glossary.magento.com/api) framework code (which also resides above the service contracts).
-You can bind service contracts to web service APIs in configuration files --- no coding required.
+* Provides an easy way to access the REST/SOAP [API](https://glossary.magento.com/api) framework code (which also resides above the service contracts). You can bind service contracts to web service APIs in configuration files --- no coding required.
 
 * Provides a stable API for other modules to call into.
 

diff --git a/guides/v2.2/architecture/security_intro.md b/guides/v2.2/architecture/security_intro.md
@@ -33,6 +33,7 @@ Magento safeguards your store from clickjacking attacks by using an X-Frame-Opti
 A simple [Magento Admin](https://glossary.magento.com/magento-admin) [URL](https://glossary.magento.com/url) (like `admin` or `backend`) makes it easy to target attacks on specific locations using automated password guessing. To prevent against this type of attack, Magento by default creates a random Admin URI when you install the product. The CLI command `bin/magento info:adminuri` is provided so that you can  see the URI if you forget it.
 
 You can change this Admin URI in three ways:
+
 - The `bin/magento setup:config:set --backend-frontname=<value>` command
 - The `env.php` file
 - The Admin panel

diff --git a/guides/v2.2/cloud/architecture/pro-architecture.md b/guides/v2.2/cloud/architecture/pro-architecture.md
@@ -167,6 +167,7 @@ The following figure shows the technologies used in the Production environment:
 ![Production technology stack]({{ site.baseurl }}/common/images/cloud_stack-diagram.png)
 
 {{site.data.var.ee}} can scale from the smallest Pro12 cluster to the largest Pro120 cluster.
+
 -   Pro12 offers a 12-CPU (4 x 3 nodes) and 48GB RAM (16 x 3 nodes)
 -   Pro120 offers 120 CPU (40 x 3 nodes) up to 480GB RAM (160 x 3 nodes)
 

diff --git a/guides/v2.2/cloud/before/before-workspace-file-sys-owner.md b/guides/v2.2/cloud/before/before-workspace-file-sys-owner.md
@@ -58,6 +58,7 @@ To find the web server user's group:
     ```
 
 Typically, the user and group name are both `apache`
+
 *	Ubuntu: `ps aux | grep apache` to find the apache user, then `groups <apache user>` to find the group
 
 	Typically, the username and the group name are both `www-data`

diff --git a/guides/v2.2/cloud/cdn/cloud-fastly.md b/guides/v2.2/cloud/cdn/cloud-fastly.md
@@ -153,8 +153,7 @@ see the Fastly [GeoIP documentation](https://github.com/fastly/fastly-magento2/b
 
 The installation and configuration process is:
 
-* Install the Fastly module in an Integration branch, without configuring
-settings or entering credentials.
+* Install the Fastly module in an Integration branch, without configuring settings or entering credentials.
 * Deploy the code to `integration` then to Staging and Production
 * Configure Fastly in Staging and Production, not in Integration or your local
 * Test Fastly for caching

diff --git a/guides/v2.2/cloud/cdn/configure-fastly.md b/guides/v2.2/cloud/cdn/configure-fastly.md
@@ -207,32 +207,18 @@ through the Cache Management page.
 
 The options include:
 
-* **Purge category**: Purges product category content (not product content) when
-you add and update a single product. You may want to keep this disabled and
-enable purge product, which purges products and product categories.
-
-* **Purge product**: Purges all product and product category content when
-saving a single modification to a product. Enabling purge product can be helpful
-to immediately get updates to customers when changing a price, adding a product
-option, and when product inventory is out-of-stock.
-* **Purge CMS page**: Purges page content when updating and adding pages to the
-Magento CMS. For example, you may want to purge when updating your Terms and
-Conditions or Return policy. If you rarely make these changes, you could disable
-automatic purging.
-* **Soft purge**: Sets changed content to stale and purges according to the
-stale timing. In combination with the stale timings your customers will be
-served stale content very fast while Fastly is updating the content in the
-background.
+* **Purge category**: Purges product category content (not product content) when you add and update a single product. You may want to keep this disabled and enable purge product, which purges products and product categories.
+* **Purge product**: Purges all product and product category content when saving a single modification to a product. Enabling purge product can be helpful to immediately get updates to customers when changing a price, adding a product option, and when product inventory is out-of-stock.
+* **Purge CMS page**: Purges page content when updating and adding pages to the Magento CMS. For example, you may want to purge when updating your Terms and Conditions or Return policy. If you rarely make these changes, you could disable automatic purging.
+* **Soft purge**: Sets changed content to stale and purges according to the stale timing. In combination with the stale timings your customers will be served stale content very fast while Fastly is updating the content in the background.
 
 ![Configure purge options]({{ site.baseurl }}/common/images/cloud_fastly-purgeoptions.png){:width="650px"}
 
 To configure Fastly purge options:
 
 1.  In the *Fastly Configuration* section, expand **Advanced**.
 
-1.  All purge options display. Select "Yes" per purge option to enable automatic
-purging. Select "No" to disable automatic purging, allowing you to manually
-purge caches through the Cache Management page.
+1.  All purge options display. Select "Yes" per purge option to enable automatic purging. Select "No" to disable automatic purging, allowing you to manually purge caches through the Cache Management page.
 
 1.  Click **Save Config** at the top of the page.
 

diff --git a/guides/v2.2/cloud/cdn/fastly-waf-service.md b/guides/v2.2/cloud/cdn/fastly-waf-service.md
@@ -9,6 +9,7 @@ functional_areas:
 Powered by Fastly, the Managed Cloud WAF is a web application firewall service that detects, logs, and blocks malicious request traffic before it can damage your sites or network.
 
 As a managed service, the Magento WAF provides the following benefits:
+
 - **PCI compliance**—WAF enablement ensures that {{ site.data.var.ee }} storefronts in production environments meet PCI DSS 6.6 security requirements.
 - **Default WAF policy**—The default WAF policy, configured and maintained by Fastly, provides a collection of security rules tailored to protect your {{ site.data.var.ee }} web applications from a wide range of attacks, including injection attacks, malicious inputs, cross-site scripting, data exfiltration, HTTP protocol violations, and other [OWASP Top Ten](https://www.owasp.org/index.php/Top_Ten) security threats.
 - **WAF onboarding and enablement**—Magento works with you to plan and schedule the WAF rollout to deploy the WAF, tune the default WAF policy in your environment, and enable the service.

diff --git a/guides/v2.2/cloud/cdn/trouble-fastly.md b/guides/v2.2/cloud/cdn/trouble-fastly.md
@@ -204,7 +204,7 @@ Verify that the returned response contains the following information:
 
 The following excerpt from the cURL command output shows the correct values for the `Pragma`, `X-Magento-Tags`, and `Fastly-Module-Enabled` headers:
 
-```json
+```terminal
 * STATE: INIT => CONNECT handle 0x600057800; line 1402 (connection #-5000)
 * Rebuilt URL to: https://www.mymagento.biz.c.sv7gVom4qrpek.ent.magento.cloud/
 * Added connection 0. The cache now contains 1 members
Original file line number	Diff line number	Diff line change
Expand Up		@@ -35,4 +35,3 @@ Reverse proxies serve "public" or shared content to more than one user. However,
		- [Public]({{ page.baseurl }}/extension-dev-guide/cache/page-caching/public-content.html) - Public content is stored server side in your reverse proxy cache storage (e.g., file system, database, Redis, or Varnish) and is available to multiple customers. Examples of public content include header, footer, and category listing.

		- [Private]({{ page.baseurl }}/extension-dev-guide/cache/page-caching/private-content.html) - Private content is stored client side (e.g., browser) and is specific to an individual customer. Examples of private content include wishlist, shopping cart, customer name, and address. You should limit stored private content to a small portion of the page's total content.
		</div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -58,6 +58,7 @@ To find the web server user's group: @@
         ```
     Typically, the user and group name are both `apache`
     *	Ubuntu: `ps aux | grep apache` to find the apache user, then `groups <apache user>` to find the group
     	Typically, the username and the group name are both `www-data`
@@ Expand Down @@