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

Commit a68c1e2

Browse files
Markdown linting: Enable rule MD029 (#5698)
* Fixed errors in rest, test, and ui comps * Fix errors in release notes * Fixed errors in pattern-library and payment integrations * Fixed errors in marketplace, migration, mrg, and mtf * Fixed errors in install, js-dev, and inventory * Applied peer review edits * Applied peer review edits * Removed forced numbering class * Fixed errors in howdoi * Fixed errors in get-started, graphql * Fixed errors in frontend-dev-guide * Fixed errors in ext-dev * Fixed some errors in config * Fixed some errors in config * Applied edits from peer review * Removed redundant TOC * Fixed errors in config * Fixed errors in coding standards, comp-mgr, contributor * Disable rule * Fixed errors in _vidoes, reporting, arch * Fixed errors in includes (not cloud) * Enable rule * Fixed errors in cloud includes * Fixed errors in cloud
1 parent 17a22b5 commit a68c1e2

File tree

258 files changed

+4093
-3760
lines changed

Some content is hidden

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

258 files changed

+4093
-3760
lines changed

.github/ISSUE_TEMPLATE/BUG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ about: Create an issue about a bug on the devdocs website
1414
<!-- (OPTIONAL) What needs to be done to replicate this issue? (provide Gist if needed) -->
1515

1616
1. First Step
17-
2. Second Step
18-
3. Etc.
17+
1. Second Step
18+
1. Etc.
1919

2020
## Expected result
2121

_checks/styles/style-rules-prod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ rule 'MD025'
2222
exclude_rule 'MD026'
2323
exclude_rule 'MD027'
2424
exclude_rule 'MD028'
25-
exclude_rule 'MD029'
25+
rule 'MD029'
2626
exclude_rule 'MD030'
2727
exclude_rule 'MD031'
2828
exclude_rule 'MD032'

_includes/cloud/backup-db.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,33 @@ We recommend creating a backup of your project before an upgrade. Use the follow
33
{:.procedure}
44
To back up your Integration environment database and code:
55

6-
1. Create a local backup of the remote database.
6+
1. Create a local backup of the remote database.
77

8-
```bash
9-
magento-cloud db:dump
10-
```
8+
```bash
9+
magento-cloud db:dump
10+
```
1111

12-
{: .bs-callout-info }
13-
The `magento-cloud db:dump` command runs the [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) command with the `--single-transaction` flag, which allows you to back up your database without locking the tables.
12+
{: .bs-callout-info }
13+
The `magento-cloud db:dump` command runs the [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) command with the `--single-transaction` flag, which allows you to back up your database without locking the tables.
1414

15-
1. Back up code and media.
15+
1. Back up code and media.
1616

17-
```bash
18-
php bin/magento setup:backup --code [--media]
19-
```
17+
```bash
18+
php bin/magento setup:backup --code [--media]
19+
```
2020

21-
Optionally, you can omit `[--media]` if you have a large number of static files that are already in source control.
21+
Optionally, you can omit `[--media]` if you have a large number of static files that are already in source control.
2222

2323
{:.procedure}
2424
To back up your Staging or Production environment database before deploying:
2525

26-
1. Use SSH to log in to the remote server.
26+
1. Use SSH to log in to the remote server.
2727

28-
2. Create a database dump.
28+
1. Create a database dump.
2929

30-
```bash
31-
vendor/bin/ece-tools db-dump
32-
```
30+
```bash
31+
vendor/bin/ece-tools db-dump
32+
```
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/enable-ssh.md

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ 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

@@ -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

@@ -43,70 +43,70 @@ Use the `ssh-keygen` command to create an SSH key pair. `ssh-keygen` is typicall
4343
{:.procedure}
4444
To create an SSH key pair:
4545

46-
1. The command syntax follows, entering the email used for your GitHub account:
46+
1. The command syntax follows, entering the email used for your GitHub account:
4747

48-
```bash
49-
ssh-keygen -t rsa
50-
```
48+
```bash
49+
ssh-keygen -t rsa
50+
```
5151

52-
GitHub also uses the key length `-b 4096` in the command. Follow the prompts to complete the key.
52+
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

56-
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.
56+
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

58-
1. After creating the SSH key pair, start the ssh-agent:
58+
1. After creating the SSH key pair, start the ssh-agent:
5959

60-
For Mac or Linux:
60+
For Mac or Linux:
6161

62-
```bash
63-
eval "$(ssh-agent -s)"
64-
```
62+
```bash
63+
eval "$(ssh-agent -s)"
64+
```
6565

66-
For Mac, you can edit the `~/.ssh/config` file to automatically load keys into the ssh-agent and store passphrases in your keychain.
66+
For Mac, you can edit the `~/.ssh/config` file to automatically load keys into the ssh-agent and store passphrases in your keychain.
6767

68-
```conf
69-
Host *
70-
AddKeysToAgent yes
71-
UseKeychain yes
72-
IdentityFile ~/.ssh/id_rsa
73-
```
68+
```conf
69+
Host *
70+
AddKeysToAgent yes
71+
UseKeychain yes
72+
IdentityFile ~/.ssh/id_rsa
73+
```
7474

7575
For Windows:
7676

7777
```shell
7878
eval $(ssh-agent -s)
7979
```
8080

81-
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.
81+
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.
8282

83-
For Mac:
83+
For Mac:
8484

85-
```bash
86-
ssh-add -K ~/.ssh/id_rsa
87-
```
85+
```bash
86+
ssh-add -K ~/.ssh/id_rsa
87+
```
8888

89-
For Windows or Linux:
89+
For Windows or Linux:
9090

91-
```shell
92-
ssh-add ~/.ssh/id_rsa
93-
```
91+
```shell
92+
ssh-add ~/.ssh/id_rsa
93+
```
9494

95-
1. [Add your SSH key to your GitHub account.](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/) The instructions include Mac, Windows, and Linux.
95+
1. [Add your SSH key to your GitHub account.](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/) The instructions include Mac, Windows, and Linux.
9696

9797
### Test the SSH keys {#test}
9898

9999
After adding the SSH keys, test the SSH connection to GitHub:
100100

101101
1. In the terminal, enter the following command:
102102

103-
```bash
104-
105-
```
103+
```bash
104+
105+
```
106106

107-
2. You may see a warning that the authenticity of the host can't be established followed by an RSA fingerprint. Enter `yes` to continue.
107+
1. You may see a warning that the authenticity of the host can't be established followed by an RSA fingerprint. Enter `yes` to continue.
108108
109-
3. If successful, you should receive a success message. If you receive a permission denied error, see [Error: Permission denied (publickey)](https://help.github.com/articles/error-permission-denied-publickey) troubleshooting on GitHub.
109+
1. If successful, you should receive a success message. If you receive a permission denied error, see [Error: Permission denied (publickey)](https://help.github.com/articles/error-permission-denied-publickey) troubleshooting on GitHub.
110110
111111
## Add a public SSH key to your Magento account {#ssh-add-to-account}
112112
@@ -120,43 +120,43 @@ You can add SSH keys to your account in any of the following ways:
120120
To add an SSH key using the CLI:
121121
122122
1. Open a terminal application on your local.
123-
2. If you haven't done so already, log in (or switch to) the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html) to the server on which your SSH keys are located.
123+
1. If you haven't done so already, log in (or switch to) the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html) to the server on which your SSH keys are located.
124124

125-
3. Log in to your project:
125+
1. Log in to your project:
126126

127-
```bash
128-
magento-cloud login
129-
```
127+
```bash
128+
magento-cloud login
129+
```
130130

131-
3. Add the key:
131+
1. Add the key:
132132

133-
```bash
134-
magento-cloud ssh-key:add ~/.ssh/id_rsa.pub
135-
```
133+
```bash
134+
magento-cloud ssh-key:add ~/.ssh/id_rsa.pub
135+
```
136136

137137
#### Add a key using the Project Web Interface {#add-key-web}
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

146146
1. Copy your SSH public key to the clipboard.
147147

148148
If you do not already have SSH keys on that machine, see [GitHub documentation](https://help.github.com/articles/generating-an-ssh-key) to create them.
149149

150-
2. Login and access your project through the [Project Web Interface](https://accounts.magento.cloud).
151-
3. In your selected branch, an icon displays if you do not have an SSH key added.
150+
1. Login and access your project through the [Project Web Interface](https://accounts.magento.cloud).
151+
1. In your selected branch, an icon displays if you do not have an SSH key added.
152152

153153
![No SSH key]({{ site.baseurl }}/common/images/cloud_ssh-key-install.png)
154154

155-
4. Copy and paste the content of your public SSH key in the screen.
155+
1. Copy and paste the content of your public SSH key in the screen.
156156

157157
![Add SSH key]({{ site.baseurl }}/common/images/cloud_ssh-key-add.png)
158158

159-
5. Follow the prompts on your screen to complete the task.
159+
1. Follow the prompts on your screen to complete the task.
160160

161161
## Set global Git variables
162162

_includes/cloud/log-in-db.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
11
The following steps provide an example of accessing a database:
22

3-
1. SSH to the integration environment.
4-
5-
```bash
6-
magento-cloud ssh
7-
```
8-
9-
1. Find the database login information:
10-
11-
```bash
12-
php -r 'print_r(json_decode(base64_decode($_ENV["MAGENTO_CLOUD_RELATIONSHIPS"]))->database);'
13-
```
14-
15-
Sample output follows:
16-
17-
```php
18-
Array
19-
(
20-
[0] => stdClass Object
21-
(
22-
[username] => user
23-
[password] =>
24-
[ip] => 192.0.2.60
25-
[host] => database.internal
26-
[query] => stdClass Object
27-
(
28-
[is_master] => 1
29-
)
30-
[path] => main
31-
[scheme] => mysql
32-
[port] => 3306
33-
)
34-
)
35-
```
36-
37-
3. Use the following command to connect to the database:
38-
39-
```bash
40-
mysql --host=<host> --user='<database username>' --password='<user password>' --port='<port>' --database='<path>'
41-
```
3+
1. SSH to the integration environment.
4+
5+
```bash
6+
magento-cloud ssh
7+
```
8+
9+
1. Find the database login information:
10+
11+
```bash
12+
php -r 'print_r(json_decode(base64_decode($_ENV["MAGENTO_CLOUD_RELATIONSHIPS"]))->database);'
13+
```
14+
15+
Sample output follows:
16+
17+
```php
18+
Array
19+
(
20+
[0] => stdClass Object
21+
(
22+
[username] => user
23+
[password] =>
24+
[ip] => 192.0.2.60
25+
[host] => database.internal
26+
[query] => stdClass Object
27+
(
28+
[is_master] => 1
29+
)
30+
[path] => main
31+
[scheme] => mysql
32+
[port] => 3306
33+
)
34+
)
35+
```
36+
37+
1. Use the following command to connect to the database:
38+
39+
```bash
40+
mysql --host=<host> --user='<database username>' --password='<user password>' --port='<port>' --database='<path>'
41+
```
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
1. Access your account. You can open the email you received from Magento Cloud ([email protected]) and click the _Access your project now_ link. Or you can log in to [your {{site.data.var.ee}} account](https://accounts.magento.cloud).
2-
2. Click the _This project has no code yet_ link next to the Project name.
2+
1. Click the _This project has no code yet_ link next to the Project name.
33

44
![Project without code]({{ site.baseurl }}/common/images/cloud_project_empty.png)
55

6-
3. Enter a name for the project.
6+
1. Enter a name for the project.
77

88
![Project name]({{ site.baseurl }}/common/images/cloud_project_name.png)
99

10-
4. Click **Create a blank site from a template** and click **Continue**. We recommend starting with the Magento template as your initial project option. If you have an existing Magento deployment, you can later import code, extensions, themes, and data after fully deploying this base Magento code.
10+
1. Click **Create a blank site from a template** and click **Continue**. We recommend starting with the Magento template as your initial project option. If you have an existing Magento deployment, you can later import code, extensions, themes, and data after fully deploying this base Magento code.
1111

1212
![Create a site using the sample Magento project]({{ site.baseurl }}/common/images/cloud_project_template.png){:width="650px"}
1313

14-
5. When prompted, enter your {{site.data.var.ee}} [Magento authentication keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html) in the provided fields. You created these keys earlier in the Magento Marketplace. Enter the private and public keys and click **Finish**.
14+
1. When prompted, enter your {{site.data.var.ee}} [Magento authentication keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html) in the provided fields. You created these keys earlier in the Magento Marketplace. Enter the private and public keys and click **Finish**.
1515

1616
![Enter your authentication keys]({{ site.baseurl }}/common/images/cloud-project-magento-auth-creds.png){:width="650px"}
1717

1818
The keys are added to the `auth.json` file in the repository `master` branch, required for all created branches and deployments.
1919

20-
6. Wait a few minutes while the project deploys. A status of _Pending_ displays until completed, similar to the following:
20+
1. Wait a few minutes while the project deploys. A status of _Pending_ displays until completed, similar to the following:
2121

2222
![Your sample Magento project]({{ site.baseurl }}/common/images/cloud_project_template2.png){:width="650px"}
2323

24-
7. After the project deploys, **Success** displays next to the name of your project.
24+
1. After the project deploys, **Success** displays next to the name of your project.

0 commit comments

Comments
 (0)