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

Commit fc2bd3a

Browse files
atwixfirsteratwixfirster
committed
#5249: Markdown linting: Spaces after list markers (MD030)
1 parent c1d4bb6 commit fc2bd3a

15 files changed

+90
-91
lines changed

‎_includes/browsers/supported-browsers.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Storefront and Admin:
22

3-
* Internet Explorer 11 or later, Microsoft Edge, latest–1
4-
* Firefox latest, latest–1 (any operating system)
5-
* Chrome latest, latest–1 (any operating system)
6-
* Safari latest, latest–1 (Mac OS only)
7-
* Safari Mobile for iPad 2, iPad Mini, iPad with Retina Display (iOS 7 or later), for desktop storefront
8-
* Safari Mobile for iPhone 4 or later; iOS 7 or later, for mobile storefront
9-
* Chrome for mobile latest–1 (Android 4 or later) for mobile storefront
3+
* Internet Explorer 11 or later, Microsoft Edge, latest–1
4+
* Firefox latest, latest–1 (any operating system)
5+
* Chrome latest, latest–1 (any operating system)
6+
* Safari latest, latest–1 (Mac OS only)
7+
* Safari Mobile for iPad 2, iPad Mini, iPad with Retina Display (iOS 7 or later), for desktop storefront
8+
* Safari Mobile for iPhone 4 or later; iOS 7 or later, for mobile storefront
9+
* Chrome for mobile latest–1 (Android 4 or later) for mobile storefront
1010

1111
Here, _latest–1_ means one major version earlier than the latest released version.

‎_includes/cache/page-cache-checklists.md

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.

‎_includes/cloud/admin-ui-login-step.md

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/backup-db.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,5 @@ To back up your Staging or Production environment database before deploying:
3131
vendor/bin/ece-tools db-dump
3232
```
3333

34-
- We recommend setting the application in maintenance mode before doing a database dump in Production environments.
35-
- This creates an `dump-<timestamp>.sql.gz` archive file in your local project directory. See [Snapshot and backup management]({{ site.baseurl }}/guides/v2.2/cloud/project/project-webint-snap.html#db-dump).
34+
- We recommend setting the application in maintenance mode before doing a database dump in Production environments.
35+
- This creates an `dump-<timestamp>.sql.gz` archive file in your local project directory. See [Snapshot and backup management]({{ site.baseurl }}/guides/v2.2/cloud/project/project-webint-snap.html#db-dump).

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,20 @@
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
2121

2222
You can delete custom VCL snippet code from your Fastly configuration by uploading an empty version of the snippet from the Magento Admin UI, or delete it completely using the Fastly API.
2323

24-
- Upload an empty version of the snippet file to Fastly to remove the VCL logic from the active VCL version:
24+
- Upload an empty version of the snippet file to Fastly to remove the VCL logic from the active VCL version:
2525

26-
- Edit the snippet and delete the **VCL** snippet content.
27-
- Save the configuration.
28-
- Upload the VCL to Fastly to apply your changes.
26+
- Edit the snippet and delete the **VCL** snippet content.
27+
- Save the configuration.
28+
- 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/customize-build-deploy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
For more information about customizing the build and deploy process:
22

3-
- [Manage build and deploy actions]({{ page.baseurl }}/cloud/project/magento-env-yaml.html)
4-
- [Deployment process]({{ page.baseurl }}/cloud/deploy/cloud-deployment-process.html)
3+
- [Manage build and deploy actions]({{ page.baseurl }}/cloud/project/magento-env-yaml.html)
4+
- [Deployment process]({{ page.baseurl }}/cloud/deploy/cloud-deployment-process.html)

‎_includes/cloud/enable-ssh.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ You must create an SSH key pair on every machine and workspace you and your team
22

33
The SSH keys require the following:
44

5-
* Set up SSH keys as the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html).
6-
* Create the keys using the email address used for the GitHub account.
5+
* Set up SSH keys as the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html).
6+
* Create the keys using the email address used for the GitHub account.
77

88
For more information on SSH keys, see the following:
99

10-
* [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
11-
* [Manually generating your SSH key in Windows](https://docs.joyent.com/public-cloud/getting-started/ssh-keys/generating-an-ssh-key-manually/manually-generating-your-ssh-key-in-windows)
12-
* [ssh-keygen man page](http://linux.die.net/man/1/ssh-keygen)
10+
* [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
11+
* [Manually generating your SSH key in Windows](https://docs.joyent.com/public-cloud/getting-started/ssh-keys/generating-an-ssh-key-manually/manually-generating-your-ssh-key-in-windows)
12+
* [ssh-keygen man page](http://linux.die.net/man/1/ssh-keygen)
1313

1414
## Locate an existing SSH key pair {#existing}
1515

@@ -33,8 +33,8 @@ If you do not have SSH keys, you need to generate the keys for adding to your Ma
3333

3434
If you already have SSH keys, continue to:
3535

36-
* [Add a public SSH key to your Magento account](#ssh-add-to-account) section
37-
* [Add your SSH key to your GitHub account](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/)
36+
* [Add a public SSH key to your Magento account](#ssh-add-to-account) section
37+
* [Add your SSH key to your GitHub account](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/)
3838

3939
## Create a new SSH key pair {#ssh-create-new-key-pair}
4040

@@ -112,8 +112,8 @@ After adding the SSH keys, test the SSH connection to GitHub:
112112
113113
You can add SSH keys to your account in any of the following ways:
114114
115-
* Using the [{{site.data.var.ece}} CLI](#add-key-cli)
116-
* Using the [{{site.data.var.ece}} Web Interface](#add-key-web)
115+
* Using the [{{site.data.var.ece}} CLI](#add-key-cli)
116+
* Using the [{{site.data.var.ece}} Web Interface](#add-key-web)
117117
118118
### Add a key using the CLI {#add-key-cli}
119119
@@ -138,8 +138,8 @@ To add an SSH key using the CLI:
138138

139139
You will select and add your SSH public key to each environment in your account.
140140

141-
* Starter: Add to Master (Production) and any environments you create by branching from Master
142-
* Pro: Add to Master Integration environment. After your Staging and Production environments are provisioned, you can add the SSH keys to those environments.
141+
* Starter: Add to Master (Production) and any environments you create by branching from Master
142+
* Pro: Add to Master Integration environment. After your Staging and Production environments are provisioned, you can add the SSH keys to those environments.
143143

144144
To add an SSH key using the Project Web Interface:
145145

‎_includes/cloud/merge-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ By default, the deployment process overwrites all settings in the `env.php` file
22

33
Set the `_merge` option to one of the following:
44

5-
- `true`—**Merge** the configured service values with the environment variable values.
6-
- `false`—**Overwrite** the configured service values with the environment variable values.
5+
- `true`—**Merge** the configured service values with the environment variable values.
6+
- `false`—**Overwrite** the configured service values with the environment variable values.

‎_includes/cloud/patch.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ We recommend installing full {{site.data.var.ee}} upgrades for important securit
77

88
There are two types of patches:
99

10-
* [General patches](#cloud-patch-gen)
10+
* [General patches](#cloud-patch-gen)
1111

1212
These patches are provided for all {{site.data.var.ee}} customers in a GitHub repository that's referenced in your `composer.json`. We apply these patches automatically during the build phase.
1313

1414
To install general patches, use `composer update`, test your system, and push the patches to the remote server.
1515

16-
* [Custom patches](#cloud-patch-custom)
16+
* [Custom patches](#cloud-patch-custom)
1717

1818
Custom patches can be provided by Magento to address a specific issue you raised in a Support ticket. Third-party module / extension developers can also provide a custom patch.
1919

@@ -169,8 +169,8 @@ After you've successfully tested a patch locally and on your integration environ
169169

170170
1. Open an SSH connection to your staging or production server:
171171

172-
* Staging: `ssh -A <project ID>_stg@<project ID>.ent.magento.cloud`
173-
* Production: `ssh -A <project ID>@<project ID>.ent.magento.cloud`
172+
* Staging: `ssh -A <project ID>_stg@<project ID>.ent.magento.cloud`
173+
* Production: `ssh -A <project ID>@<project ID>.ent.magento.cloud`
174174

175175
1. Enter the following commands:
176176

@@ -268,8 +268,8 @@ After you've successfully tested a custom patch locally and on your integration
268268

269269
1. Open an SSH connection to your staging or production server:
270270

271-
* Staging: `ssh -A <project ID>_stg@<project ID>.ent.magento.cloud`
272-
* Production: `ssh -A <project ID>@<project ID>.ent.magento.cloud`
271+
* Staging: `ssh -A <project ID>_stg@<project ID>.ent.magento.cloud`
272+
* Production: `ssh -A <project ID>@<project ID>.ent.magento.cloud`
273273

274274
1. On your staging or production system, enter the following command if you haven't done so already:
275275

‎_includes/cloud/sens-data-create-config-local.md

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/backup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
After you pass all readiness checks, you can back up:
22

3-
* The Magento 2 file system (excluding `var` and `pub/static` directories)
4-
* The `pub/media` directory
5-
* The Magento 2 database
3+
* The Magento 2 file system (excluding `var` and `pub/static` directories)
4+
* The `pub/media` directory
5+
* The Magento 2 database
66

77
Backups are stored in the `var/backups` directory and can be restored at any time using the [`magento setup:rollback`]({{ page.baseurl }}/install-gde/install/cli/install-cli-uninstall-mods.html#instgde-cli-uninst-mod-roll) or using the Magento Admin.
88

‎_includes/comp-man/checklist.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Before you continue, to avoid errors during your installation or update, make sure you verify *all* of the following:
22

3-
* You set up a [Magento file system owner](#magento-owner-group) and shared that owner's group with the web server user group
4-
* Your [cron jobs](#magento-cron) are set up and running
5-
* [File system permissions](#perms) are set properly
3+
* You set up a [Magento file system owner](#magento-owner-group) and shared that owner's group with the web server user group
4+
* Your [cron jobs](#magento-cron) are set up and running
5+
* [File system permissions](#perms) are set properly
66

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

‎_includes/comp-man/checklist_2.2.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Before you continue, to avoid errors during your installation or update, make sure you verify *all* of the following:
22

3-
* You set up a [Magento file system owner](#magento-owner-group) and shared that owner's group with the web server user group
4-
* Your [cron jobs](#magento-cron) are set up and running
5-
* [Set a value for DATA_CONVERTER_BATCH_SIZE](#batch-size)
6-
* [File system permissions](#perms) are set properly
3+
* You set up a [Magento file system owner](#magento-owner-group) and shared that owner's group with the web server user group
4+
* Your [cron jobs](#magento-cron) are set up and running
5+
* [Set a value for DATA_CONVERTER_BATCH_SIZE](#batch-size)
6+
* [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}

0 commit comments

Comments
 (0)