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

Commit f85bf78

Browse files
Merge pull request #5707 from atwixfirster/MD030-includes-folder01
#5249: Markdown linting: Spaces after list markers (MD030). Part 01
2 parents c1d4bb6 + cceda4e commit f85bf78

16 files changed

+64
-65
lines changed
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
## Cacheable page checklist
22

3-
- Pages use GET requests
3+
- Pages use GET requests
44

5-
- Pages render only cacheable blocks
5+
- Pages render only cacheable blocks
66

7-
- Pages render without sensitive private data; session and customer DTO objects are empty
7+
- Pages render without sensitive private data; session and customer DTO objects are empty
88

9-
- Functionality specific to both current session (customer) and page should be written using JavaScript (e.g., related product listing should exclude items that are already in the shopping cart)
9+
- Functionality specific to both current session (customer) and page should be written using JavaScript (e.g., related product listing should exclude items that are already in the shopping cart)
1010

11-
- Model and block level should identify themselves for invalidation support
11+
- Model and block level should identify themselves for invalidation support
1212

13-
- Declare a custom [context variable]({{ page.baseurl }}/extension-dev-guide/cache/page-caching/public-content.html#configure-page-variations) if you plan to show different public content with the same URL
13+
- Declare a custom [context variable]({{ page.baseurl }}/extension-dev-guide/cache/page-caching/public-content.html#configure-page-variations) if you plan to show different public content with the same URL
1414

1515
## Non-cacheable page checklist
1616

17-
- Use POST requests to modify Magento state (e.g., adding to shopping cart, wishlist, etc.)
17+
- Use POST requests to modify Magento state (e.g., adding to shopping cart, wishlist, etc.)
1818

19-
- Blocks that can't be cached should be marked as non-cacheable in the layout. However, be aware that adding a non-cacheable block to a page prevents the full page cache from caching that page.
19+
- Blocks that can't be cached should be marked as non-cacheable in the layout. However, be aware that adding a non-cacheable block to a page prevents the full page cache from caching that page.
2020

21-
- Controllers that don't use layouts should set `no-cache` HTTP headers
21+
- Controllers that don't use layouts should set `no-cache` HTTP headers

_includes/cache/page-cache-overview.md

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

33
Caching is one of the most effective ways to improve website performance. Generally speaking, there are two methods of caching content:
44

5-
- Client-side (browser)
6-
- Server-side
5+
- Client-side (browser)
6+
- Server-side
77

88
Retrieving stored ([cached](https://glossary.magento.com/cache)) content from a previous request for the same client instead of requesting files from your server every time someone visits your site is a more efficient use of network bandwidth.
99

1010
The Magento page cache library contains a simple PHP reverse proxy that enables full page caching out of the box. A reverse proxy acts as an intermediary between visitors and your application and can reduce the load on your server.
1111

1212
We recommend using [Varnish]({{ page.baseurl }}/config-guide/varnish/config-varnish.html), but you can use Magento's default caching mechanism instead, which stores cache files in any of the following:
1313

14-
- File system (You don't need to do anything to use file-based caching.)
15-
- [Database]({{ page.baseurl }}/extension-dev-guide/cache/partial-caching/database-caching.html)
16-
- [Redis]({{ page.baseurl }}/config-guide/redis/redis-pg-cache.html)
14+
- File system (You don't need to do anything to use file-based caching.)
15+
- [Database]({{ page.baseurl }}/extension-dev-guide/cache/partial-caching/database-caching.html)
16+
- [Redis]({{ page.baseurl }}/config-guide/redis/redis-pg-cache.html)
1717

1818
## Cacheable and uncacheable pages {#cache-over-cacheable}
1919

@@ -32,6 +32,6 @@ Do not configure content pages (i.e., catalog, product, and CMS pages) to be unc
3232

3333
Reverse proxies serve "public" or shared content to more than one user. However, most Magento websites generate dynamic and personalized "private" content that should only be served to one user, which presents unique caching challenges. To address these challenges, Magento can distinguish between two types of content:
3434

35-
- **[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.
35+
- **[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.
3636

37-
- **[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.
37+
- **[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.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1. [Log in]({{ page.baseurl }}/cloud/onboarding/onboarding-tasks.html#admin) to the Magento Admin UI.
1+
1. [Log in]({{ page.baseurl }}/cloud/onboarding/onboarding-tasks.html#admin) to the Magento Admin UI.

_includes/cloud/cloud-fastly-manage-vcl-from-admin.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
1. After the upload completes, refresh the cache according to the notification at the top of the page.
1616

17-
{: .bs-callout .bs-callout-warning}
17+
{: .bs-callout-warning }
1818
The *Custom VCL snippets* UI option shows only the snippets added through the Admin UI. You must use the Fastly API to [manage custom snippets added through the API]({{ page.baseurl }}/cloud/cdn/cloud-vcl-custom-snippets.html#manage-custom-vcl-snippets-using-the-api).
1919

2020
## Delete the custom VCL snippet
@@ -27,8 +27,7 @@ You can delete custom VCL snippet code from your Fastly configuration by uploadi
2727
- Save the configuration.
2828
- Upload the VCL to Fastly to apply your changes.
2929

30-
- Use the Fastly API [Delete custom VCL snippet]({{ page.baseurl }}/cloud/cdn/cloud-vcl-custom-snippets.html#manage-vcl) operation
31-
to delete the snippet completely, or submit a Magento support ticket to request deletion.
30+
- Use the Fastly API [Delete custom VCL snippet]({{ page.baseurl }}/cloud/cdn/cloud-vcl-custom-snippets.html#manage-vcl) operation to delete the snippet completely, or submit a Magento support ticket to request deletion.
3231

3332
[Manage custom VCL snippets]: {{site.baseurl}}/common/images/cloud/cloud-fastly-manage-snippets.png
3433
{: width="650px"}

_includes/cloud/data-collection.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
To help export Production data as test data to use in Staging and Integration environments, [Run the support utilities]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-spt-util.html):
22

3-
* [CLI commands]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-spt-util.html#config-cli-spt-utils-db) (Recommended) to export a protected backup of customer and store data using your Magento encryption key
4-
* [Data Collection](http://docs.magento.com/m2/ee/user_guide/system/support-data-collector.html) tool for generating and exporting data
3+
* [CLI commands]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-spt-util.html#config-cli-spt-utils-db) (Recommended) to export a protected backup of customer and store data using your Magento encryption key
4+
* [Data Collection](http://docs.magento.com/m2/ee/user_guide/system/support-data-collector.html) tool for generating and exporting data
55

66
To migrate this data, see [Migrate and deploy static files and data]({{ page.baseurl }}/cloud/live/stage-prod-migrate.html).

_includes/cloud/enable-ssh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ To create an SSH key pair:
5151

5252
GitHub also uses the key length `-b 4096` in the command. Follow the prompts to complete the key.
5353

54-
1. When prompted to "Enter a file in which to save the key," press **Enter** to save the file to the default location. The prompt displays the location.
54+
1. When prompted to "Enter a file in which to save the key," press **Enter**to save the file to the default location. The prompt displays the location.
5555

5656
1. When prompted to enter a secure passphrase, enter a phrase to use like a password. Make note of this passphrase. You may be requested to enter it depending on tasks you complete using a terminal during development.
5757

_includes/cloud/patch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ This topic discusses how to test patches to your {{site.data.var.ece}} system lo
22

33
When you perform a {{site.data.var.ee}} upgrade, you automatically upgrade with patches and hotfixes through the `composer update` command. If you upgrade a Cloud patch without upgrading the full {{site.data.var.ee}} application, see [Upgrade a {{site.data.var.ee}} patch](#upgrade-patch). To upgrade and test a full {{site.data.var.ee}} version (including patches and hotfixes), see [Upgrade and test {{site.data.var.ee}}]({{ page.baseurl }}/cloud/project/project-upgrade.html).
44

5-
{: .bs-callout .bs-callout-info}
5+
{: .bs-callout-info }
66
We recommend installing full {{site.data.var.ee}} upgrades for important security updates. Full upgrades include all associated patches and hotfixes.
77

88
There are two types of patches:
@@ -19,7 +19,7 @@ There are two types of patches:
1919

2020
Copy custom patches to the `m2-hotfixes` directory and test them on your locally. After successfully testing them, push the patches to the remote server.
2121

22-
{: .bs-callout .bs-callout-warning}
22+
{: .bs-callout-warning }
2323
Always test a patch your local system. When complete, push the local Git branch to deploy your Integration environment. Resolve any issues before you deploy to Staging or Production.
2424

2525
For more information on Composer, see [Composer in Cloud]({{ page.baseurl }}/cloud/reference/cloud-composer.html).
Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
{:.procedure}
22
To create and transfer `config.local.php`:
33

4-
1. On your local workstation, find the integration server SSH URL.
4+
1. On your local workstation, find the integration server SSH URL.
55

6-
```bash
7-
magento-cloud environment:ssh --pipe
8-
```
6+
```bash
7+
magento-cloud environment:ssh --pipe
8+
```
99

10-
1. Create the `config.local.php` file on the integration server.
10+
1. Create the `config.local.php` file on the integration server.
1111

12-
```bash
13-
ssh [email protected] "php bin/magento magento-cloud:scd-dump"
14-
```
12+
```bash
13+
ssh [email protected] "php bin/magento magento-cloud:scd-dump"
14+
```
1515

16-
1. Change to the project root directory.
16+
1. Change to the project root directory.
1717

18-
1. Transfer the `config.local.php` file to your local workstation.
18+
1. Transfer the `config.local.php` file to your local workstation.
1919

20-
```bash
21-
rsync [email protected]:app/etc/config.local.php ./app/etc/config.local.php
22-
```
20+
```bash
21+
rsync [email protected]:app/etc/config.local.php ./app/etc/config.local.php
22+
```
2323

24-
1. Test to ensure a successful transfer by importing the configuration file to your local environment.
24+
1. Test to ensure a successful transfer by importing the configuration file to your local environment.
2525

26-
```bash
27-
php bin/magento app:config:import
28-
```
26+
```bash
27+
php bin/magento app:config:import
28+
```

_includes/comp-man/checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Before you continue, to avoid errors during your installation or update, make su
44
* Your [cron jobs](#magento-cron) are set up and running
55
* [File system permissions](#perms) are set properly
66

7-
{:.bs-callout .bs-callout-warning}
7+
{: .bs-callout-warning }
88
Do not continue without performing these checks. Failure to do so could result in errors.
99

1010
### Magento file system owner and group {#magento-owner-group}

_includes/comp-man/checklist_2.2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Before you continue, to avoid errors during your installation or update, make su
55
* [Set a value for DATA_CONVERTER_BATCH_SIZE](#batch-size)
66
* [File system permissions](#perms) are set properly
77

8-
{:.bs-callout .bs-callout-warning}
8+
{: .bs-callout-warning }
99
Do not continue without performing these checks. Failure to do so could result in errors.
1010

1111
### Set a value for DATA_CONVERTER_BATCH_SIZE {#batch-size}
@@ -37,7 +37,7 @@ After your upgrade completes, you can unset the variable as follows:
3737
unset DATA_CONVERTER_BATCH_SIZE
3838
```
3939

40-
{:.bs-callout .bs-callout-info}
40+
{: .bs-callout-info }
4141
`DATA_CONVERTER_BATCH_SIZE` requires memory; avoid setting it to a very large value (approximately 1GB) without testing it first.
4242

4343
### Magento file system owner and group {#magento-owner-group}

_includes/comp-man/dependency.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
We suggest you try the following solutions in the order shown:
66

7-
* [Conflicting dependencies](#trouble-depend-conflict)
8-
* [File system permissions issues](#trouble-depend-permission)
9-
* [The Component Dependency Check status never changes](#trouble-depend-state)
7+
* [Conflicting dependencies](#trouble-depend-conflict)
8+
* [File system permissions issues](#trouble-depend-permission)
9+
* [The Component Dependency Check status never changes](#trouble-depend-state)
1010

1111
### Conflicting dependencies {#trouble-depend-conflict}
1212

@@ -21,7 +21,7 @@ Following is a sample failure message:
2121
- magento/sample-data version 0.74.0-beta15. Please try to update it to one of the following package versions: 0.74.0-beta16, 0.74.0-beta14, 0.74.0-beta13, 0.74.0-beta12, 0.74.0-beta11, 0.74.0-beta10, 0.74.0-beta9, 0.74.0-beta8, 0.74.0-beta7
2222
```
2323

24-
{:.bs-callout .bs-callout-info}
24+
{: .bs-callout-info }
2525
The message you see will likely be different.
2626

2727
Typically, component dependency conflicts result from someone manually editing the Magento 2 `composer.json` file. It can also be caused by third-party modules that depend on earlier Magento components than the ones you have installed.

_includes/comp-man/readiness-check.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ After the readiness check completes, see one of the following:
55

66
### Readiness check success {#compman-readiness-success}
77

8-
The following figure shows an example of a successful readiness check. If all tests passed, click **Next** and continue with the next step.
8+
The following figure shows an example of a successful readiness check. If all tests passed, click **Next**and continue with the next step.
99

1010
![If all readiness checks pass, click Next and continue with the next step]({{ site.baseurl }}/common/images/extensman_readiness-success.png)
1111

_includes/config-guide/custom-logger-handler-examples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
You can use one of the following approaches for logging into a custom file:
22

3-
- Set up a custom log file in the `di.xml`
4-
- Set up a custom file in the custom logger handler class
3+
- Set up a custom log file in the `di.xml`
4+
- Set up a custom file in the custom logger handler class
55

66
## Set up a custom log file in the `di.xml`
77

_includes/config/es-elasticsearch-magento.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
This section discusses the minimum settings you must choose to test Elasticsearch with Magento 2.
22
For additional details about configuring Elasticsearch, see the [{{site.data.var.ee}} User Guide](http://docs.magento.com/m2/ee/user_guide/catalog/search-elasticsearch.html).
33

4-
{: .bs-callout .bs-callout-warning}
4+
{: .bs-callout-warning }
55
Magento 2.3.1 adds support for Elasticsearch 6.x, and it is enabled by default.
66
Magento still provides modules for Elasticsearch 2.x and 5.x, but these must be enabled in order to use these versions.
77
Elasticsearch 2.x is still available but strongly discouraged. Versions 2.x and 5.x are [End of Life](https://www.elastic.co/support/eol).
@@ -48,12 +48,12 @@ or you will see:
4848

4949
If so, try the following:
5050

51-
* Make sure the Elasticsearch server is running.
52-
* 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.
53-
* 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.
54-
* 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.
55-
* Verify the value of the **Elasticsearch Server Hostname** field. Make sure the server is available. You can try the server's IP address instead.
56-
* 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.
51+
* Make sure the Elasticsearch server is running.
52+
* 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.
53+
* 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.
54+
* 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.
55+
* Verify the value of the **Elasticsearch Server Hostname** field. Make sure the server is available. You can try the server's IP address instead.
56+
* 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.
5757

5858
For example, to see if Elasticsearch is running on its default port, use the following command:
5959

@@ -97,5 +97,5 @@ bin/magento indexer:reindex
9797

9898
1. Wait until reindexing completes.
9999

100-
{:.bs-callout .bs-callout-info}
100+
{: .bs-callout-info }
101101
Unlike the cache, indexers are updated by a cron job. Make sure [cron is enabled]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-cron.html) before you start using Elasticsearch.

_includes/config/install-java.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ If the message `java: command not found` displays, you must install the Java SDK
1010

1111
See one of the following sections:
1212

13-
* [Install the latest JDK on CentOS](#install-prereq-java-centos)
14-
* [Install the latest JDK on Ubuntu](#install-prereq-java-ubuntu)
13+
* [Install the latest JDK on CentOS](#install-prereq-java-centos)
14+
* [Install the latest JDK on Ubuntu](#install-prereq-java-ubuntu)
1515

1616
#### Install the JDK on CentOS {#install-prereq-java-centos}
1717

@@ -23,7 +23,7 @@ Be sure to install the JDK and *not* the JRE.
2323
yum -y install java-1.7.0-openjdk
2424
```
2525

26-
{:.bs-callout .bs-callout-info}
26+
{: .bs-callout-info }
2727
Java version 7 might not be available for all operating systems. For example, you can [search the list of available packages for Ubuntu](http://packages.ubuntu.com/).
2828

2929
#### Install the JDK on Ubuntu {#install-prereq-java-ubuntu}

_includes/config/install-java8.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ If the message `java: command not found` displays, you must install the Java SDK
1010

1111
See one of the following sections:
1212

13-
* [Install the latest JDK on CentOS](#install-prereq-java-centos)
14-
* [Install the latest JDK on Ubuntu](#install-prereq-java-ubuntu)
13+
* [Install the latest JDK on CentOS](#install-prereq-java-centos)
14+
* [Install the latest JDK on Ubuntu](#install-prereq-java-ubuntu)
1515

1616
#### Install the JDK on CentOS {#install-prereq-java-centos}
1717

0 commit comments

Comments
 (0)