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

Commit a74c595

Browse files
authored
Merge branch 'master' into ds_rm-obsolete-page
2 parents 6fe19de + 368b813 commit a74c595

File tree

736 files changed

+9185
-9184
lines changed

Some content is hidden

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

736 files changed

+9185
-9184
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ religion, or sexual identity and orientation.
1414
Examples of behavior that contributes to creating a positive environment
1515
include:
1616

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
2222

2323
Examples of unacceptable behavior by participants include:
2424

25-
* Using sexualized language or imagery and unwelcome sexual attention or
25+
* Using sexualized language or imagery and unwelcome sexual attention or
2626
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
3030
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
31+
* Other conduct which could reasonably be considered inappropriate in a
3232
professional setting
3333

3434
## Our Responsibilities

.github/ISSUE_TEMPLATE/COMMUNITY_ISSUE_TEMPLATE.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,28 @@ about: Create an issue related to a community engineering effort
99

1010
Type of Doc:
1111

12-
- [ ] New topic
13-
- [ ] Topic Update, Devdoc link:
14-
- [ ] Other
12+
- [ ] New topic
13+
- [ ] Topic Update, Devdoc link:
14+
- [ ] Other
1515

1616
Magento 2 GitHub Issue: https://github.com/magento/devdocs/issues/link
1717

1818
Magento 2 GitHub PR: https://github.com/magento/devdocs/pull/link
1919

2020
Magento 2 version:
2121

22-
- [ ] 2.1.X
23-
- [ ] 2.2.X
24-
- [ ] 2.3.X
25-
- [ ] back port
26-
- [ ] forward port
22+
- [ ] 2.1.X
23+
- [ ] 2.2.X
24+
- [ ] 2.3.X
25+
- [ ] back port
26+
- [ ] forward port
2727

2828
Notifications of Changes:
2929

30-
- [ ] Changes to Admin interface?
31-
- [ ] New software requirements?
32-
- [ ] New REST endpoints or updated GraphQL query syntax?
33-
- [ ] New command line option?
30+
- [ ] Changes to Admin interface?
31+
- [ ] New software requirements?
32+
- [ ] New REST endpoints or updated GraphQL query syntax?
33+
- [ ] New command line option?
3434

3535
## Content
3636

.github/ISSUE_TEMPLATE/NEW_TOPIC.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ about: Create a request to add missing information to devdocs
1515

1616
<!-- Use the following checklist template as a starting point -->
1717

18-
- [ ] The topic provides an explanation of how ____ works.
19-
- [ ] The topic provides steps for ____.
20-
- [ ] The topic contains code samples that shows ____.
21-
- [ ] Other (please specify)
18+
- [ ] The topic provides an explanation of how ____ works.
19+
- [ ] The topic provides steps for ____.
20+
- [ ] The topic contains code samples that shows ____.
21+
- [ ] Other (please specify)
2222

2323
## Additional information/resources
2424

.github/MAINTAINER_GUIDELINES.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ Labels are important because they help us identify pull requests and ensure that
1717

1818
Here is a brief summary of the most important labels:
1919

20-
- `New Topic`: Entirely new documents
21-
- `Major Update`: Significant new info: new section in existing topic, etc.
22-
- `Technical`: Changes to technical content/code/processes/naming conventions (any change to technical content)
23-
- `Editorial`: Typos, grammatical inconsistencies, or minor rewrites
24-
- `small changes`: See [Small changes workflow](#small-changes-workflow)
20+
- `New Topic`: Entirely new documents
21+
- `Major Update`: Significant new info: new section in existing topic, etc.
22+
- `Technical`: Changes to technical content/code/processes/naming conventions (any change to technical content)
23+
- `Editorial`: Typos, grammatical inconsistencies, or minor rewrites
24+
- `small changes`: See [Small changes workflow](#small-changes-workflow)
2525

2626
We also use version labels when appropriate.
2727

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ This pull request (PR) ...
66

77
<!-- REQUIRED List the affected pages on devdocs.magento.com (URLs). Not needed for large numbers of files. -->
88

9-
- ...
9+
- ...
1010

1111
## Links to Magento source code
1212

1313
<!-- OPTIONAL - REMOVE THIS SECTION IF NOT USED. If this pull request references a file in a Magento codebase repository, add it here. -->
1414

15-
- ...
15+
- ...
1616

1717
<!--
1818
If you are fixing a GitHub issue, note it using GitHub keyword format (https://help.github.com/en/articles/closing-issues-using-keywords#closing-an-issue-in-a-different-repository) to close the issue when this pull request is merged. Example: `Fixes #1234`

_checks/styles/style-rules-prod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ exclude_rule 'MD026'
2323
exclude_rule 'MD027'
2424
exclude_rule 'MD028'
2525
rule 'MD029'
26-
exclude_rule 'MD030'
26+
rule 'MD030', :ul_single => 2, :ol_single => 1, :ul_multi => 2, :ol_multi => 1
2727
exclude_rule 'MD031'
2828
exclude_rule 'MD032'
2929
exclude_rule 'MD033'
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"}

0 commit comments

Comments
 (0)