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

Markdown linting: Fixed MD046 errors #6646

Merged
merged 23 commits into from
Feb 13, 2020
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
e0bdac4
Fixed errors in README
jeff-matthews Feb 10, 2020
0b7770b
Fixed errors in extensions/
jeff-matthews Feb 10, 2020
b8f9b65
Fixed errors in marketplace/
jeff-matthews Feb 10, 2020
95742d5
Fixed errors in recommendations/
jeff-matthews Feb 10, 2020
10721b2
Fixed errors in ui_comp_guide/
jeff-matthews Feb 10, 2020
9e277ae
Fixed errors in rest/
jeff-matthews Feb 10, 2020
36ead46
Fixed errors in install-gde/
jeff-matthews Feb 10, 2020
0e1e338
Merge pull request #6607 from magento/5253-md046
jeff-matthews Feb 11, 2020
e128ef7
Fixed several MD046 errors
jeff-matthews Feb 11, 2020
3abf14a
Applied suggestions from code review
jeff-matthews Feb 12, 2020
6adfe59
Merge pull request #6621 from magento/5253-md046-2
jeff-matthews Feb 12, 2020
a0efd5a
Fixed several MD046 errors
jeff-matthews Feb 12, 2020
3e27b94
Merge pull request #6634 from magento/5253-md046-3
jeff-matthews Feb 12, 2020
a0ae42e
Fixed several MD046 errors
jeff-matthews Feb 12, 2020
98faf93
Merge pull request #6636 from magento/5253-md046-4
jeff-matthews Feb 12, 2020
7721bf1
Fixed several MD046 errors
jeff-matthews Feb 13, 2020
06310d4
Update src/cloud/cdn/fastly-vcl-badreferer.md
jeff-matthews Feb 13, 2020
d088c11
Merge pull request #6642 from magento/5253-md046-5
jeff-matthews Feb 13, 2020
a94f26c
Update src/guides/v2.3/config-guide/memcache/memcache_centos.md
jeff-matthews Feb 13, 2020
e442f3a
Disable rule
jeff-matthews Feb 13, 2020
183d4bf
Fixed unordered list indentation
jeff-matthews Feb 13, 2020
6f8814c
Merge branch 'master' into 5253-integration
jeff-matthews Feb 13, 2020
433c8d0
Merge branch 'master' into 5253-integration
jeff-matthews Feb 13, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,25 +160,25 @@ To build v2.0 documentation:

1. Add an entry for 2.0 in the `Docfile.yml` file.

```yaml
-
directory: guides/v2.0
repository: magento/devdocs
branch: 2.0
filter: false
```
```yaml
-
directory: guides/v2.0
repository: magento/devdocs
branch: 2.0
filter: false
```

1. Initialize the `2.0` branch in your local devdocs repository.

```bash
rake init
```
```bash
rake init
```

1. Run the preview command.

```bash
rake preview
```
```bash
rake preview
```

### To build v2.1 documentation

Expand All @@ -192,25 +192,25 @@ To build v2.1 documentation:

1. Add an entry for 2.1 in the `Docfile.yml` file.

```yaml
-
directory: guides/v2.1
repository: magento/devdocs
branch: 2.1
filter: false
```
```yaml
-
directory: guides/v2.1
repository: magento/devdocs
branch: 2.1
filter: false
```

1. Initialize the `2.1` branch in your local devdocs repository.

```bash
rake init
```
```bash
rake init
```

1. Run the preview command.

```bash
rake preview
```
```bash
rake preview
```

## Build using Vagrant

Expand Down
54 changes: 27 additions & 27 deletions src/_includes/cloud/cli-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,54 +3,54 @@
1. Change to a directory to which the Magento file system owner has write access.
1. Enter the following command in a terminal to log in to your project:

```bash
magento-cloud login
```
```bash
magento-cloud login
```

1. List your projects. With the project ID, you can complete additional commands.

```bash
magento-cloud project:list
```
```bash
magento-cloud project:list
```

1. If necessary, clone the project to your local. You should have cloned when setting up your local development workspace.

```bash
magento-cloud project:get <project ID>
```
```bash
magento-cloud project:get <project ID>
```

1. Change to a project directory. For example, `cd /var/www/html/magento2`
1. List environments in the project. Every environment includes an active Git branch of your code, database, environment variables, configurations, and services.

```bash
magento-cloud environment:list
```
```bash
magento-cloud environment:list
```

{:.bs-callout-info}
`magento-cloud environment:list`—displays environment hierarchies whereas the `git branch` command does not.
{:.bs-callout-info}
`magento-cloud environment:list`—displays environment hierarchies whereas the `git branch` command does not.

1. Fetch origin branches to get the latest code:

```bash
git fetch origin
```
```bash
git fetch origin
```

1. Check out, or switch to, a specific branch and environment. Git commands only checkout the Git branch. The Magento Cloud command also switches to the active environment.

```bash
magento-cloud environment:checkout <environment ID>
```
```bash
magento-cloud environment:checkout <environment ID>
```

To create a new environment, use `magento-cloud environment:branch <environment name> <parent environment ID>`
To create a new environment, use `magento-cloud environment:branch <environment name> <parent environment ID>`

1. Pull any updated code to your local for the environment ID (which is the Git branch):

```bash
git pull origin <environment ID>
```
```bash
git pull origin <environment ID>
```

1. Create a [snapshot]({{ site.baseurl }}/cloud/project/project-webint-snap.html) of the environment as a backup:

```bash
magento-cloud snapshot:create -e <environment ID>
```
```bash
magento-cloud snapshot:create -e <environment ID>
```
8 changes: 4 additions & 4 deletions src/_includes/cloud/composer-name.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ To get the module's Composer name from Magento Marketplace:
1. In **Technical Details** on the My Purchases page, click **Copy** to copy the version to the clipboard.
1. Append the version number to the component name after the colon.

A sample follows:
A sample follows:

```text
pixlee/magento2:1.0.1
```
```text
pixlee/magento2:1.0.1
```
8 changes: 4 additions & 4 deletions src/_includes/cloud/enable-ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@ To create an SSH key pair:
IdentityFile ~/.ssh/id_rsa
```

For Windows:
For Windows:

```shell
eval $(ssh-agent -s)
```
```shell
eval $(ssh-agent -s)
```

1. Add the SSH key to the ssh-agent. If you used a different name for the key file name, replace `id_rsa` with that file name.

Expand Down
4 changes: 3 additions & 1 deletion src/_includes/install/file-system-perms-before_22.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,6 @@ After you've performed the other tasks in this topic, enter one of the following

For example,

su magento_user
```bash
su magento_user
```
22 changes: 11 additions & 11 deletions src/_includes/install/file-system-perms-oneuser.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@ To set permissions before you install the Magento software:

1. If you have command-line access, enter the following commands in the order shown:

```bash
cd <magento_root>
```
```bash
cd <magento_root>
```

```bash
find var vendor pub/static pub/media app/etc -type f -exec chmod u+w {} +
```bash
find var vendor pub/static pub/media app/etc -type f -exec chmod u+w {} +
```

```bash
find var vendor pub/static pub/media app/etc -type d -exec chmod u+w {} +
```
```bash
find var vendor pub/static pub/media app/etc -type d -exec chmod u+w {} +
```

```bash
chmod u+x bin/magento
```
```bash
chmod u+x bin/magento
```

1. To optionally enter all commands on one line, enter the following, assuming Magento is installed in `/var/www/html/magento2`:

Expand Down
44 changes: 22 additions & 22 deletions src/_includes/install/file-system-perms-twouser.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ To find the web server user's group:

* CentOS:

```bash
grep -E -i '^user|^group' /etc/httpd/conf/httpd.conf
```
```bash
grep -E -i '^user|^group' /etc/httpd/conf/httpd.conf
```

or
or

```bash
grep -Ei '^user|^group' /etc/httpd/conf/httpd.conf
```
```bash
grep -Ei '^user|^group' /etc/httpd/conf/httpd.conf
```

Typically, the user and group name are both `apache`.

Expand Down Expand Up @@ -123,25 +123,25 @@ To set ownership and permissions before you install the Magento software:
1. Log in to your Magento server as, or switch to, the Magento file system owner.
1. Enter the following commands in the order shown:

```bash
cd <magento_root>
```
```bash
cd <magento_root>
```

```bash
find var vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
```
```bash
find var vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
```

```bash
find var vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
```
```bash
find var vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
```

```bash
sudo chown -R :<web server group> .
```
```bash
sudo chown -R :<web server group> .
```

```bash
chmod u+x bin/magento
```
```bash
chmod u+x bin/magento
```

{% include install/file-system-perms-twouser_cmds-only.md %}

Expand Down
44 changes: 22 additions & 22 deletions src/_includes/install/file-system-perms-twouser_22.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ To find the web server user's group:

* CentOS:

```bash
grep -E -i '^user|^group' /etc/httpd/conf/httpd.conf
```
```bash
grep -E -i '^user|^group' /etc/httpd/conf/httpd.conf
```

or
or

```bash
grep -Ei '^user|^group' /etc/httpd/conf/httpd.conf
```
```bash
grep -Ei '^user|^group' /etc/httpd/conf/httpd.conf
```

Typically, the user and group name are both `apache`.

Expand Down Expand Up @@ -123,25 +123,25 @@ To set ownership and permissions before you install the Magento software:
1. Log in to your Magento server as, or switch to, the Magento file system owner.
1. Enter the following commands in the order shown:

```bash
cd <magento_root>
```
```bash
cd <magento_root>
```

```bash
find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
```
```bash
find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
```

```bash
find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
```
```bash
find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
```

```bash
chown -R :<web server group> .
```
```bash
chown -R :<web server group> .
```

```bash
chmod u+x bin/magento
```
```bash
chmod u+x bin/magento
```

{% include install/file-system-perms-twouser_cmds-only_22.md %}

Expand Down
Loading