Skip to content

Commit 86ebfb4

Browse files
doboothdobooth
authored
Merge branch 'master' into db_arch_img
2 parents 2079187 + 0de6794 commit 86ebfb4

File tree

63 files changed

+819
-342
lines changed

Some content is hidden

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

63 files changed

+819
-342
lines changed

‎Docfile.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ content_map:
1212
-
1313
directory: mftf
1414
repository: magento/magento2-functional-testing-framework
15-
branch: develop
15+
branch: master
1616
filter: true
1717
-
1818
directory: page-builder

‎Rakefile

+3-5
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,10 @@ require 'html-proofer'
1010
require 'kramdown'
1111
require 'launchy'
1212
require 'colorator'
13+
require 'erb'
1314

14-
# Load ruby files with helper methods from the 'rakelib/' directory
15-
require_relative 'rakelib/lib/link-checker.rb'
16-
require_relative 'rakelib/lib/converter.rb'
17-
require_relative 'rakelib/lib/double-slash-check.rb'
18-
require_relative 'rakelib/lib/doc-config.rb'
15+
# Require helper methods from the 'rakelib/lib' directory
16+
Dir.glob('rakelib/lib/**/*.rb') { |file| require_relative(file) }
1917

2018
desc "Same as 'rake', 'rake preview'"
2119
task default: %w[preview]

‎_config.checks.yml

+10-4
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,32 @@
44
#
55
html-proofer:
66

7-
# Do not check external links.
7+
# Do not check external links.
88
:disable_external: true
99

1010
# Report only errors that fall within the 4xx status code range.
1111
:only_4xx: true
1212

1313
# Ignores images with empty alt tags.
1414
:empty_alt_ignore: true
15-
15+
1616
# Sort errors by description in the report
1717
:error_sort: :desc
1818

1919
# Use up to 3 parallel processes to speed up internal file checks.
2020
:parallel:
2121
:in_processes: 3
22+
23+
:cache:
24+
:timeframe: 2w
2225

2326
# Ignore entirely the files which pathname matches a specified pattern
2427
:file_ignore:
25-
- !ruby/regexp /page-builder/
26-
- !ruby/regexp /mrg/
28+
- !ruby/regexp /page-builder/
29+
- !ruby/regexp /guides\/v2\.3\/mrg/
30+
31+
:internal_domains:
32+
- devdocs.magento.com
2733

2834
# Ignore any link that includes a specified pattern
2935
# :url_ignore:

‎_data/toc/extension-best-practices.yml

+3
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,6 @@ pages:
6060

6161
- label: Creating a dynamic row system config
6262
url: /ext-best-practices/tutorials/dynamic-row-system-config.html
63+
64+
- label: Creating a custom import entity
65+
url: /ext-best-practices/tutorials/custom-import-entity.html

‎_data/toc/rest-api.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ pages:
88

99
- label: REST Endpoints (Swagger)
1010
include_versions: ["2.2"]
11-
url: http://devdocs.magento.com/swagger/index_22.html
11+
url: https://devdocs.magento.com/swagger/index_22.html
1212

1313
- label: REST Endpoints (ReDoc)
1414
include_versions: ["2.3"]

‎_data/whats-new.yml

+66-84
Large diffs are not rendered by default.

‎_includes/contributor/2-1-end.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{:.bs-callout .bs-callout-warning}
22
**v2.1 End of Contribution:**
3-
As of September 17, 2018, we no longer accept contributions to the v2.1 release line. Continue submitting contributions for the [v2.2](https://devdocs.magento.com/guides/v2.2/contributor-guide/contributing.html) and [v2.3](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html) release lines. We made this change to increase our focus on issue investigations and pull request approvals for v2.2 and v2.3 release lines.
3+
As of September 17, 2018, we no longer accept contributions to the v2.1 release line. Continue submitting contributions for the [v2.2]({{ site.baseurl }}/guides/v2.2/contributor-guide/contributing.html) and [v2.3]({{ site.baseurl }}/guides/v2.3/contributor-guide/contributing.html) release lines. We made this change to increase our focus on issue investigations and pull request approvals for v2.2 and v2.3 release lines.

‎_includes/layout/after-site-header.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
{% if page.group == "inventory" %}
22
<div class="message-banner">
3-
This page may include updates for <a href="https://devdocs.magento.com/guides/v2.3/inventory/release-notes.html" target="_blank">Inventory Management (MSI) 1.1.2 Beta</a>. Content is subject to change.
3+
This page may include updates for <a href="{{ site.baseurl }}/guides/v2.3/inventory/release-notes.html" target="_blank">Inventory Management (MSI) 1.1.2 Beta</a>. Content is subject to change.
44
</div>
55
{% endif %}
66

77
{% if page.title == "Inventory mass actions" %}
88
<div class="message-banner">
9-
This page may include updates for <a href="https://devdocs.magento.com/guides/v2.3/inventory/release-notes.html" target="_blank">Inventory Management (MSI) 1.1.2 Beta</a>. Content is subject to change.
9+
This page may include updates for <a href="{{ site.baseurl }}/guides/v2.3/inventory/release-notes.html" target="_blank">Inventory Management (MSI) 1.1.2 Beta</a>. Content is subject to change.
1010
</div>
1111
{% endif %}
1212

1313
{% if page.title == "Install Inventory Management" %}
1414
<div class="message-banner">
15-
This page may include updates for <a href="https://devdocs.magento.com/guides/v2.3/inventory/release-notes.html" target="_blank">Inventory Management (MSI) 1.1.2 Beta</a>. Content is subject to change.
15+
This page may include updates for <a href="{{ site.baseurl }}/guides/v2.3/inventory/release-notes.html" target="_blank">Inventory Management (MSI) 1.1.2 Beta</a>. Content is subject to change.
1616
</div>
1717
{% endif %}

‎_includes/layout/header-styles.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
<link rel="alternate" type="application/rss+xml" title="Magento DevDocs RSS" href="/feed.xml" />
33

44
{% if page.canonical_url != nil %}
5-
<link rel="canonical" href="{{ page.canonical_url }}" />
5+
<link rel="canonical" href="{{ page.canonical_url }}" data-proofer-ignore />
66
{% endif %}

‎_layouts/redirect.html

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US" data-proofer-ignore >
3+
<meta charset="utf-8">
4+
<title>Redirecting&hellip;</title>
5+
<link rel="canonical" href="{{ page.redirect.to }}">
6+
<script>location="{{ page.redirect.to }}"</script>
7+
<meta http-equiv="refresh" content="0; url={{ page.redirect.to }}">
8+
<meta name="robots" content="noindex">
9+
<h1>Redirecting&hellip;</h1>
10+
<a href="{{ page.redirect.to }}">Click here if you are not redirected.</a>
11+
</html>

‎common/images/ext-best-practices/import-entity.png

4.31 KB
Loading

‎community/resources/best-practices.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ They are available in DevDocs because the content has been well received within
2121

2222
The DevDocs and Magento teams verified and provide the following best practices and recommendations:
2323

24-
- [Best Practices and Benchmarking](https://devdocs.magento.com/guides/v2.3/migration/migration-overview-practices.html) for Migration
25-
- [Best Practices for Extension Development](https://devdocs.magento.com/guides/v2.3/ext-best-practices/bk-ext-best-practices.html)
24+
- [Best Practices and Benchmarking]({{ site.baseurl }}/guides/v2.3/migration/migration-overview-practices.html) for Migration
25+
- [Best Practices for Extension Development]({{ site.baseurl }}/guides/v2.3/ext-best-practices/bk-ext-best-practices.html)
2626

2727
We also recommend the [Magento Marketplace Help Center](https://marketplacesupport.magento.com/hc/en-us) for extension questions.
28-
- [Programming Best Practices](https://devdocs.magento.com/guides/v2.3/ext-best-practices/extension-coding/common-programming-bp.html)
29-
- [Observers Best Practices](https://devdocs.magento.com/guides/v2.3/ext-best-practices/extension-coding/observers-bp.html)
30-
- [Theme Development Best Practices](https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/theme-best-practice.html)
31-
- [Performance Best Practices](https://devdocs.magento.com/guides/v2.3/performance-best-practices/)
32-
- [Best Practices for Store Configuration](https://devdocs.magento.com/guides/v2.3/cloud/configure/configure-best-practices.html) for Commerce Cloud
33-
- [Deployment Process](https://devdocs.magento.com/guides/v2.3/cloud/reference/discover-deploy.html) for Commerce Cloud
28+
- [Programming Best Practices]({{ site.baseurl }}/guides/v2.3/ext-best-practices/extension-coding/common-programming-bp.html)
29+
- [Observers Best Practices]({{ site.baseurl }}/guides/v2.3/ext-best-practices/extension-coding/observers-bp.html)
30+
- [Theme Development Best Practices]({{ site.baseurl }}/guides/v2.3/frontend-dev-guide/theme-best-practice.html)
31+
- [Performance Best Practices]({{ site.baseurl }}/guides/v2.3/performance-best-practices/)
32+
- [Best Practices for Store Configuration]({{ site.baseurl }}/guides/v2.3/cloud/configure/configure-best-practices.html) for Commerce Cloud
33+
- [Deployment Process]({{ site.baseurl }}/guides/v2.3/cloud/reference/discover-deploy.html) for Commerce Cloud
3434

3535
## Want to contribute?
3636

‎community/resources/resources.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ We have [channels][] for each project, but the following channels are recommende
9595
- *Presentation* [Premium performance with PHP 7 and Varnish][15] by Miguel Balparda
9696

9797
[contribute]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md
98-
[technical guidelines]: https://devdocs.magento.com/guides/v2.3/coding-standards/technical-guidelines.html
99-
[coding standards]: https://devdocs.magento.com/guides/v2.3/coding-standards/bk-coding-standards.html
98+
[technical guidelines]: {{ site.baseurl }}/guides/v2.3/coding-standards/technical-guidelines.html
99+
[coding standards]: {{ site.baseurl }}/guides/v2.3/coding-standards/bk-coding-standards.html
100100
[Magento Community Engineering Slack]: https://magentocommeng.slack.com
101101
[self signup]: https://tinyurl.com/engcom-slack
102102
[general]: https://magentocommeng.slack.com/messages/C4YS78WE6

‎extensions/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ This section tracks and provides installation guides and release notes for Magen
1111

1212
## Additional information
1313

14-
* [Run the Module Manager](https://devdocs.magento.com/guides/v2.3/comp-mgr/module-man/compman-checklist.html)
15-
* [Run the Extension Manager](https://devdocs.magento.com/guides/v2.3/comp-mgr/extens-man/extensman-checklist.html)
14+
* [Run the Module Manager]({{ site.baseurl }}/guides/v2.3/comp-mgr/module-man/compman-checklist.html)
15+
* [Run the Extension Manager]({{ site.baseurl }}/guides/v2.3/comp-mgr/extens-man/extensman-checklist.html)
1616
* [Magento Marketplace Support](https://marketplacesupport.magento.com/hc/en-us)

‎guides/v2.2/architecture/archi_perspectives/persist_layer.md

-13
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
group: architecture-guide
33
title: Persistence layer
4-
menu_title: Persistence layer
54
---
65

76
Magento uses an active record pattern strategy for persistence. In this system, the model object contains a *resource model* that maps an object to one or more database rows. A resource model is responsible for performing functions such as:
@@ -20,19 +19,7 @@ Any model that uses an EAV resource has its attributes spread out over a number
2019

2120
The `Customer`, `Catalog` and `Order` resource models use EAV attributes.
2221

23-
## XML Declaritive schema
24-
25-
With Magento 2.3, we introduced Declaritive XML Schemas.
26-
These are XML files that are used to specify the final state of the database.
27-
These files replace PHP update scripts that were required when upgrading a module.
28-
These files allow you to skip the progressive upgrade scripts and jump right to the final state of the database.
29-
30-
Read more about writing [declarative XML schemas][].
31-
3222
## Related topics {#related}
3323

3424
[Architectural diagrams]({{page.baseurl}}/architecture/archi_perspectives/arch_diagrams.html)
3525
[Architectural layers overview]({{page.baseurl}}/architecture/archi_perspectives/ALayers_intro.html)
36-
37-
<!-- Link Definitions -->
38-
[declarative XML schemas]: https://devdocs.magento.com/guides/v2.3/extension-dev-guide/declarative-schema/db-schema.html

‎guides/v2.2/architecture/archi_perspectives/present_layer.md

-25
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
group: architecture-guide
33
title: Presentation Layer
4-
menu_title: Presentation layer
54
---
65

76
## What is the Magento Presentation layer?
@@ -29,20 +28,6 @@ Each [theme](https://glossary.magento.com/theme) resides in a unique directory a
2928

3029
For an extensive introduction to theme elements and an overview of how to extend and override the default Magento themes, see the [Frontend Developer Guide][].
3130

32-
## GraphQL
33-
34-
GraphQL is a data query language developed internally by Facebook in 2012 before being publicly released in 2015. Magento implements GraphQL to provide an alternative to REST and SOAP web APIs for frontend development.
35-
36-
GraphQL allows you to define the structure of the data that you need, and the server returns only the data you request. Each GraphQL-capable module contains a declarative schema that defines the syntax for queries that the module supports, as well as the attributes that can be returned. If you run a REST call such as GET /V1/products/:sku on a simple product, the system might fetch more than 100 lines of data. If all you need is the current price, the call has returned significantly more information than you need. With GraphQL, a query against the same SKU could return just the price.
37-
38-
More information can be found in the [GraphQL Developer Guide][]
39-
40-
## Progressive Web Apps
41-
42-
The Magento Progressive Web App (PWA) Studio project is a set of developer tools that allow you to develop, deploy, and maintain a PWA storefront on top of Magento 2.
43-
44-
You can read more about how PWA works with Magento in the [PWA Studio docs][]
45-
4631
## View model
4732

4833
Magento generates the [HTML](https://glossary.magento.com/html) for a page to display to a user from a tree of view elements.
@@ -66,13 +51,6 @@ For example, the [Admin](https://glossary.magento.com/admin) UI screens are ofte
6651

6752
The View layer calls code from the Model to get information about the state of the application (for example, the price of a product). Typically, the way it accesses the Model is through service contracts.
6853

69-
## Progressive web apps
70-
71-
Progressive Web Apps (PWA) is a way to present a Magento storefront via a set of React javascript components.
72-
Using Magento as a headless backend, you can use PWA components to make mobile friendly frontends.
73-
74-
Read more about [Magento PWA][].
75-
7654
## Presentation layer flow
7755

7856
Web users interact with components of the presentation layer to select actions that initiate calls to the underlying layers.
@@ -86,6 +64,3 @@ Presentation layer components make calls to the service layer, which in turn sen
8664

8765
<!-- Link definitions -->
8866
[Frontend Developer Guide]: {{page.baseurl}}/frontend-dev-guide/bk-frontend-dev-guide.html
89-
[GraphQL Developer Guide]: https://devdocs.magento.com/guides/v2.3/graphql/
90-
[Magento PWA]: https://magento.github.io/pwa-studio/technologies/overview/
91-
[PWA Studio docs]: https://magento.github.io/pwa-studio/

‎guides/v2.2/cloud/trouble/message-queues.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ Message queue consumers fail to restart after you deploy code to an environment.
1515

1616
## Solution
1717

18-
Use the [`CRON_CONSUMERS_RUNNER` environment variable](https://devdocs.magento.com/guides/v2.2/cloud/env/variables-deploy.html#cron_consumers_runner) to ensure that consumers are retrieving messages from the message queue.
18+
Use the [`CRON_CONSUMERS_RUNNER` environment variable]({{ page.baseurl }}/cloud/env/variables-deploy.html#cron_consumers_runner) to ensure that consumers are retrieving messages from the message queue.

‎guides/v2.2/comp-mgr/patching.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -136,10 +136,10 @@ To apply a custom patch using Composer:
136136

137137
[Magento Security Center]:https://magento.com/security/patches
138138
[-p1 instead of -p0]:http://man7.org/linux/man-pages/man1/patch.1.html
139-
[Back up and roll back the file system]:https://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli-backup.html
139+
[Back up and roll back the file system]:{{ page.baseurl }}/install-gde/install/cli/install-cli-backup.html
140140
[patch]:https://en.wikipedia.org/wiki/Patch_(Unix)
141141
[Magento Help Center]:https://support.magento.com/hc/en-us/articles/360005484154-Create-a-patch-for-a-Magento-2-Composer-installation-from-a-GitHub-commit
142-
[Magento Admin user]:https://devdocs.magento.com/guides/v2.3/config-guide/cli/config-cli.html#config-install-cli-first
142+
[Magento Admin user]:{{ page.baseurl }}/config-guide/cli/config-cli.html#config-install-cli-first
143143
[1]: https://github.com/cweagans/composer-patches/
144144
[2]: https://github.com/magento/magento2/commit/2d31571f1bacd11aa2ec795180abf682e0e9aede
145145
[3]: https://github.com/magento/magento2/issues/6474

‎guides/v2.2/contributor-guide/backward-compatible-development/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ The following is a list of prohibited Magento API changes:
264264
- Removing an @api annotation
265265
- Modifying the Magento tool command argument list
266266
- Modifying or removing the Magento tool command
267-
- [Topic names for message queue]({{ page.baseurl }}/extension-dev-guide/message-queues/config-mq.html), except automatically generated names (e.g. topic names generated by [Asynchronous Web API](https://devdocs.magento.com/guides/v2.3/rest/asynchronous-web-endpoints.html). Automatically generated topic names should be treated as private implementation and may be changed at any time if needed.
267+
- [Topic names for message queue]({{ page.baseurl }}/extension-dev-guide/message-queues/config-mq.html), except automatically generated names (e.g. topic names generated by [Asynchronous Web API]({{ page.baseurl }}/rest/asynchronous-web-endpoints.html). Automatically generated topic names should be treated as private implementation and may be changed at any time if needed.
268268

269269
### Translatable phrases
270270

‎guides/v2.2/contributor-guide/maintainers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ Maintainers take part in these main activities:
3131

3232
## Guidelines for DevDocs
3333

34-
In general, the same [guidelines](https://devdocs.magento.com/guides/v2.3/contributor-guide/maintainers.html) for [`magento/magento2`](https://github.com/magento/magento2) maintainers apply to DevDocs maintainers. However, there are some [additional guidelines](https://github.com/magento/devdocs/blob/master/.github/MAINTAINER_GUIDELINES.md) that apply to DevDocs.
34+
In general, the same [guidelines]({{ page.baseurl }}/contributor-guide/maintainers.html) for [`magento/magento2`](https://github.com/magento/magento2) maintainers apply to DevDocs maintainers. However, there are some [additional guidelines](https://github.com/magento/devdocs/blob/master/.github/MAINTAINER_GUIDELINES.md) that apply to DevDocs.

0 commit comments

Comments
 (0)