Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 604812b

Browse files
dshevtsovdshevtsov
committed
Added blank line after headings if missed
1 parent 6d6ddc2 commit 604812b

File tree

1,088 files changed

+4010
-14
lines changed

Some content is hidden

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

1,088 files changed

+4010
-14
lines changed

‎.github/CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ If you write and contribute a full topic, we will add your name (or your company
2828
**Tip![:]()** If you are not sure where to start contributing, check out our GitHub issues labeled [help wanted](https://github.com/magento/devdocs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [good first issue](https://github.com/magento/devdocs/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
2929

3030
## Contribution guidelines
31+
3132
We use [Markdown](http://daringfireball.net/projects/markdown/) to write our documentation, which is a simple markup language that we convert to HTML using [Kramdown](http://kramdown.gettalong.org/syntax.html).
3233

3334
You can update, or add content to, existing topics in their respective versioned directories (for 2.0, 2.1, 2.2, and onward).
@@ -69,6 +70,7 @@ Edit and add content to existing pages. For new topics, we provide templates to
6970
- Final step topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.1/contributor-guide/templates/tutorial-template-last.md) | [HTML](https://devdocs.magento.com/guides/v2.2/contributor-guide/templates/tutorial-template-last.html): Use for the last step of the tutorial.
7071

7172
### Edit metadata
73+
7274
The Markdown (.md) file's metadata is a set of YAML key-value pairs. The metadata section is located at the top of each file.
7375

7476
```yaml
@@ -91,6 +93,7 @@ GitHub_link: install-gde/continue.md
9193
| `github_link` | Specifies the name and location of the source file in the GitHub repository. |
9294

9395
## Report an issue
96+
9497
If you find a typo or erroneous information in Magento DevDocs, you can either fix it with a pull request (as described above) or you can report it by creating an issue in the DevDocs GitHub repository.
9598
GitHub issues use templates for requested information. Enter as much information as you can including content corrections, steps to reproduce, command or code updates, or questions for clarifications.
9699

‎README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,18 +156,22 @@ To use Docker and Docker Compose, first download and install Docker for the appr
156156
- Refer [here](https://docs.docker.com/docker-for-mac/install/) for the official installation instructions.
157157

158158
### Docker for Windows
159+
159160
- Refer [here](https://docs.docker.com/docker-for-windows/install/) for the official installation instructions.
160161

161162
### Docker Compose
163+
162164
- Refer [here](https://docs.docker.com/compose/install/) for the official installation instructions.
163165

164166
### Execution Steps
167+
165168
1. Using [git](https://git-scm.com/), [clone](https://help.github.com/articles/cloning-a-repository/) this repository.
166169
2. Navigate to the resulting directory.
167170
3. Run `docker-compose up` to initialize the build process. Refer [here](https://docs.docker.com/compose/gettingstarted/#step-build-and-run-your-app-with-compose) for more details on the use of `docker-compose`.
168171
4. Visit `http://localhost:4000/` in a web browser, and you should be presented with a local copy of the Magento DevDocs. The configuration for the local port (`4000` by default) is found in the [docker-compose.yml](https://github.com/magento/devdocs/blob/develop/docker-compose.yml) file. If another port is desired, please refer [here](https://docs.docker.com/compose/compose-file/compose-file-v2/#ports) for further details regarding Docker Compose port mapping.
169172

170173
### Addressing Problems With Docker Build
174+
171175
1. Verify that the Docker engine is installed for the appropriate operating system.
172176
2. Verify that Docker Compose is installed.
173177
3. Verify that this repository has been cloned.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
## Cacheable page checklist
2+
23
- Pages use GET requests
34

45
- Pages render only cacheable blocks
@@ -12,6 +13,7 @@
1213
- 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
1314

1415
## Non-cacheable page checklist
16+
1517
- Use POST requests to modify Magento state (e.g., adding to shopping cart, wishlist, etc.)
1618

1719
- 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.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ We recommend using [Varnish]({{ page.baseurl }}/config-guide/varnish/config-varn
1616
- [Redis]({{ page.baseurl }}/config-guide/redis/redis-pg-cache.html)
1717

1818
## Cacheable and uncacheable pages {#cache-over-cacheable}
19+
1920
*Cacheable* and *uncacheable* are terms we use to indicate whether or not a page should be cached at all. (By default, all pages are cacheable.) If any block in a {% glossarytooltip 73ab5daa-5857-4039-97df-11269b626134 %}layout{% endglossarytooltip %} is designated as uncacheable, the entire page is uncacheable.
2021

2122
To create an uncacheable page, mark any block on that page as uncacheable in the layout using `cacheable="false"`.
@@ -29,6 +30,7 @@ Do not configure content pages (i.e., catalog, product, and CMS pages) to be unc
2930
</div>
3031

3132
## Public and private content
33+
3234
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:
3335

3436
- **[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.

‎_includes/cloud/enable-ssh.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ For more information on SSH keys, see the following:
1212
* [ssh-keygen man page](http://linux.die.net/man/1/ssh-keygen){:target="_blank"}
1313

1414
## Locate an existing SSH key pair {#existing}
15+
1516
An existing SSH key pair is typically located in the `.ssh` subdirectory of the user's home directory. This folder is hidden and may not display in the file manager or finder unless configured to display hidden files and folders.
1617

1718
You can quickly verify if you have SSH keys by entering commands using terminal access.
@@ -31,6 +32,7 @@ If you already have SSH keys, continue to:
3132
* [Add your SSH key to your GitHub account](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/)
3233

3334
## Create a new SSH key pair {#ssh-create-new-key-pair}
35+
3436
Use the `ssh-keygen` command to create an SSH key pair. `ssh-keygen` is typically installed on Linux systems.
3537

3638
To create an SSH key pair:
@@ -88,12 +90,14 @@ After adding the SSH keys, test the SSH connection to GitHub:
8890

8991

9092
## Add a public SSH key to your Magento account {#ssh-add-to-account}
93+
9194
You can add SSH keys to your account in any of the following ways:
9295

9396
* Using the [{{site.data.var.ece}} CLI](#add-key-cli)
9497
* Using the [{{site.data.var.ece}} Web Interface](#add-key-web)
9598

9699
### Add a key using the CLI {#add-key-cli}
100+
97101
To add an SSH key using the CLI:
98102

99103
1. Open a terminal application on your local.
@@ -108,6 +112,7 @@ To add an SSH key using the CLI:
108112
magento-cloud ssh-key:add ~/.ssh/id_rsa.pub
109113

110114
#### Add a key using the Project Web Interface {#add-key-web}
115+
111116
You will select and add your SSH public key to each environment in your account.
112117

113118
* Starter: Add to Master (Production) and any environments you create by branching from Master
@@ -128,6 +133,7 @@ To add an SSH key using the Project Web Interface:
128133
5. Follow the prompts on your screen to complete the task.
129134

130135
## Set global Git variables
136+
131137
Set required global Git variables on the machine to commit or push to a Git branch. These variables set Git credentials for accessing your GitHub account.
132138

133139
To set variables, enter the following commands on every workspace:

‎_includes/cloud/patch.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@ Always test a patch your local system. When complete, push the local Git branch
2525
For more information on Composer, see [Composer in Cloud]({{ page.baseurl }}/cloud/reference/cloud-composer.html).
2626

2727
## Upgrade a Magento Commerce patch {#upgrade-patch}
28+
2829
When you perform a Magento Commerce upgrade, you automatically upgrade with patches and hotfixes through the `composer update` command.
2930

3031
### Back up the database
32+
3133
Back up your Integration environment database and code:
3234

3335
1. Enter the following command to make a local backup of the remote database:
@@ -51,6 +53,7 @@ Back up your Staging or Production environment database before deploying to thos
5153
mysqldump -h <database host> --user=<database username> --password=<password> --single-transaction <database name> | gzip - > /tmp/database.sql.gz
5254

5355
### Verify other changes
56+
5457
Verify other changes you're going to submit to source control before you start the upgrade:
5558

5659
1. If you haven't done so already, change to your project root directory.
@@ -80,11 +83,13 @@ Verify other changes you're going to submit to source control before you start t
8083
5. Wait for deployment to complete.
8184

8285
## Test general patches {#cloud-patch-gen}
86+
8387
*General patches* are provided for all Magento Commerce customers in a repository referenced in your `composer.json`. We apply patches automatically during the build phase when a patch is available. The procedure discussed in this section enables to you test a patch locally anytime you choose.
8488

8589
The procedure you use is slightly different, depending on the type of environment, see [Pro architecture]({{ page.baseurl }}/cloud/architecture/pro-architecture.html#cloud-arch-int).
8690

8791
### Get started {#gen-getstarted}
92+
8893
We recommend you test a patch in the `master` branch.
8994

9095
{% include cloud/cli-get-started.md %}
@@ -114,6 +119,7 @@ To test a general patch on your local system:
114119
git push origin <branch name>
115120

116121
### Push a general patch to the staging or production environment {#gen-pushpatch}
122+
117123
After you've successfully tested a patch locally and on your integration environment, you can push the patch to staging or production as follows:
118124

119125
1. Open an SSH connection to your staging or production server:
@@ -138,11 +144,13 @@ After you've successfully tested a patch locally and on your integration environ
138144
git push origin master
139145

140146
## Test custom patches {#cloud-patch-custom}
147+
141148
*Custom patches* are provided to specific customers in a Support ticket. Before you continue, make sure the patch file we provided you is available.
142149

143150
The procedure you use is slightly different, depending on the type of environment, see [Pro architecture]({{ page.baseurl }}/cloud/architecture/pro-architecture.html#cloud-arch-int).
144151

145152
### Get started {#custom-getstarted}
153+
146154
We recommend you test a patch locally in the `master` branch.
147155

148156
{% include cloud/cli-get-started.md %}

‎_includes/cloud/ssh-tunnel.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ To build a tunnel, you must know the name of the app to which to tunnel. Use the
1717
For information on the command, you can enter `magento-cloud apps --help`.
1818

1919
### Set up the SSH tunnel {#tunnel-setup}
20+
2021
Use the following command:
2122

2223
magento-cloud tunnel:open -e <environment ID> --app <app name>
@@ -37,11 +38,13 @@ Messages similar to the following display:
3738
Close tunnels with: magento-cloud tunnel:close
3839

3940
### Get tunnel information {#tunnel-info}
41+
4042
To display information about your tunnel, enter:
4143

4244
magento-cloud tunnel:info -e <environment ID>
4345

4446
### Connect to services {#tunnel-services}
47+
4548
Now you can connect to services as if they were running locally.
4649

4750
For example, to connect to the database, use the following command:

‎_includes/comp-man/checklist.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ Before you continue, to avoid errors during your installation or update, make su
1111
</div>
1212

1313
### Magento file system owner and group {#magento-owner-group}
14+
1415
The [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html) group must have write access to Magento directories and files.
1516

1617
### Cron jobs are running {#magento-cron}
18+
1719
Magento requires three cron jobs, all running as the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html).
1820

1921
To verify your cron jobs are set up properly, enter the following command as a user with `root` privileges:
@@ -41,6 +43,7 @@ To see the error, you might need to click **System Messages** at the top of the
4143
For details, see [Set up cron]({{ page.baseurl }}/install-gde/install/post-install-config.html#post-install-cron).
4244

4345
### File system permissions {#perms}
46+
4447
For security reasons, Magento requires certain permissions on the file system. Permissions are different from [*ownership*](#magento-owner-group). Ownership determines *who* can perform actions on the file system; permissions determine *what* the user can do.
4548

4649
Directories in the Magento file system must be writable by the [Magento file system owner's]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html) group.

‎_includes/comp-man/dependency.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
<div markdown="1">
22

33
## Resolve component dependency conflicts
4+
45
We suggest you try the following solutions in the order shown:
56

67
* [Conflicting dependencies](#trouble-depend-conflict)
78
* [File system permissions issues](#trouble-depend-permission)
89
* [The Component Dependency Check status never changes](#trouble-depend-state)
910

1011
### Conflicting dependencies {#trouble-depend-conflict}
12+
1113
The message `We found conflicting component dependencies` displays if Composer cannot determine which components to install or update. To resolve component dependency issues, you should be a technical person who thoroughly understands how Composer works.
1214

1315
Following is a sample failure message:
@@ -29,6 +31,7 @@ In the preceding example, the installed package `magento/sample-data version 0.7
2931
Edit `composer.json` to make any of these changes and try the readiness check again.
3032

3133
### File system permissions issues {#trouble-depend-permission}
34+
3235
If the Magento file system owner doesn't have permissions to write to directories on the Magento file system, a message similar to the following displays:
3336

3437
file_put_contents(/var/www/html/magento2ce/var/composer_home/cache/repo/https---
@@ -37,6 +40,7 @@ If the Magento file system owner doesn't have permissions to write to directorie
3740
Make sure you set file system permissions as discussed in [Overview of ownership and permissions]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html).
3841

3942
### The Component Dependency Check status never changes {#trouble-depend-state}
43+
4044
In some cases, the status of the Component Dependency Check doesn't change, even after you try to correct issues. In that case, you can either delete or rename files named `<your Magento install dir>/var/.update_cronjob_status` and `<your Magento install dir>/var/.setup_cronjob_status` and try running the Component Manager again.
4145

4246
Renaming or removing these files forces the Component Manager to run the checks again.

‎_includes/comp-man/readiness-check.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ After the readiness check completes, see one of the following:
66
* [Readiness check failure](#compman-readiness-fail)
77

88
### Readiness check success {#compman-readiness-success}
9+
910
The following figure shows an example of a successful readiness check. If all tests passed, click **Next** and continue with the next step.
1011

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

1314
### Readiness check failure {#compman-readiness-fail}
15+
1416
Messages similar to the following display if any readiness check fails.
1517

1618
![You must resolve all readiness check failures before you continue]({{ site.baseurl }}/common/images/cman_readiness-fail-ex.png)

‎_includes/config/config-reference-b2b.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
This reference contains unique configuration paths for the Magento Enterprise B2B Extension. The Magento Enterprise B2B Extension supports all configuration paths for {{site.data.var.ce}} (formerly Community Edition (CE) and {{site.data.var.ee}} (formerly Enterprise Edition (EE) as well.
44

55
## General category
6+
67
This section lists variable names and configuration paths available for options in the Admin under **Stores** > Settings > **Configuration** > **General**.
78

89
### B2B Features paths
10+
911
These configuration values are available in the Magento Admin in **Stores** > Settings > **Configuration** > **General** > **B2B Features**.
1012

1113
| Name | Config path | Encrypted? | System-specific? | Sensitive? |
@@ -19,9 +21,11 @@ These configuration values are available in the Magento Admin in **Stores** > Se
1921
| Payment Methods | `btob/default_b2b_payment_methods/available_payment_methods` | | | |
2022

2123
## Customers category
24+
2225
This section lists variable names and config paths available for options in the Admin under **Stores** > Settings > **Configuration** > **Customers**.
2326

2427
### Company configuration paths
28+
2529
These configuration values are available in the Magento Admin in **Stores** > Settings > **Configuration** > **Customers** > **Company Configuration**.
2630

2731
| Name | Config path | Encrypted? | System-specific? | Sensitive? |
@@ -59,16 +63,19 @@ These configuration values are available in the Magento Admin in **Stores** > Se
5963
| Reverted Email Template | `company/email/credit_reverted_email_template` | | | |
6064

6165
### Requisition lists paths
66+
6267
These configuration values are available in the Magento Admin in **Stores** > Settings > **Configuration** > **Customers** > **Requisition Lists**.
6368

6469
| Name | Config path | Encrypted? | System-specific? | Sensitive? |
6570
| -------------- | -------------- | -------------- | -------------- | -------------- |
6671
| Number of Requisition Lists | `requisitionlist/general/number_requisition_lists` | | | |
6772

6873
## Sales category
74+
6975
This section lists variable names and config paths available for options in the Admin under **Stores** > Settings > **Configuration** > **Sales**.
7076

7177
### Sales Emails paths
78+
7279
These configuration values are available in the Magento Admin in **Stores** > Settings > **Configuration** > **Sales** > **Sales Emails**.
7380

7481
| Name | Config path | Encrypted? | System-specific? | Sensitive? |
@@ -85,6 +92,7 @@ These configuration values are available in the Magento Admin in **Stores** > Se
8592
| Send Quote Email Copy Method | `sales_email/quote/copy_method` | | | |
8693

8794
### Quotes paths
95+
8896
These configuration values are available in the Magento Admin in **Stores** > Settings > **Configuration** > **Sales** > **Quotes**.
8997

9098
| Name | Config path | Encrypted? | System-specific? | Sensitive? |
@@ -101,6 +109,7 @@ These configuration values are available in the Magento Admin in **Stores** > Se
101109
| Maximum file size | `quote/attached_files/maximum_file_size` | | | |
102110

103111
## Payment method paths
112+
104113
These configuration values are available in the Magento Admin in **Stores** > Settings > **Configuration** > **Sales** > **Payment Methods**.
105114

106115
<div class="bs-callout bs-callout-info" id="info" markdown="1">

0 commit comments

Comments
 (0)