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

Commit 07d0be5

Browse files
authored
Merge pull request #1 from magento/master
merge from master
2 parents b37272c + e8dcc29 commit 07d0be5

File tree

2,726 files changed

+93961
-287256
lines changed

Some content is hidden

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

2,726 files changed

+93961
-287256
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ If you write and contribute a full topic, we will add your name (or your company
1515

1616
## Get started
1717

18-
> We no longer accept contributions to files in the `src/guides/v2.2/` directory.
19-
2018
![Get started workflow](https://devdocs.magento.com/common/images/contribute-prerequisites.png)
2119

2220
1. Make sure you have a [GitHub account](https://github.com/signup/free).
@@ -54,7 +52,7 @@ The following diagram shows the contribution workflow:
5452

5553
**We will close your pull request if you do not respond to feedback in two weeks.**
5654

57-
**Note:** If you have not signed the [Magento Contributor Agreement](https://magento.com/content/magento-contributor-agreement), the pull request provides a link. Magento requires a signed form and agreement to the terms for contribution.
55+
**Note:** If you have not signed the [Adobe Contributor License Agreement](https://opensource.adobe.com/cla.html), the pull request provides a link. You must sign the CLA before we can accept your contribution.
5856

5957
## Contribution guidelines
6058

@@ -69,7 +67,7 @@ The following guidelines may answer most of your questions and help you get star
6967

7068
- If you need to update the site navigation, ask for help in Slack ([#devdocs](https://magentocommeng.slack.com/messages/CAN932A3H)).
7169

72-
- Ensure that you update the correct version(s) of documentation (v2.2, v2.3). If you are not sure what directory to put your content in, just do your best. We can help re-locate it (if necessary) during the review process.
70+
- Ensure that you update the correct version(s) of documentation (v2.3). If you are not sure what directory to put your content in, just do your best. We can help re-locate it (if necessary) during the review process.
7371
- Review your work for basic typos, formatting errors, or ambiguous sentences before opening a pull request.
7472
- Revise pull requests according to review feedback. We will close pull requests that require an inordinate amount of time to review and process (especially for minor changes) if you fail to make revisions according to review feedback.
7573
- Do not directly contact DevDocs team members or maintainers on Slack to review your pull request unless it has been open for more than five days. We have a process and queue for pull requests that everyone must follow.

.github/ISSUE_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Thank you for taking the time to report this issue!
1717
GitHub Issues should only be created for problems/topics related to this project's codebase.
1818
1919
Before submitting this issue, please make sure you are complying with our Code of Conduct:
20-
https://github.com/magento/devdocs/blob/develop/.github/CODE_OF_CONDUCT.md
20+
https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md
2121
2222
Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
2323

.github/ISSUE_TEMPLATE/BUG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Thank you for taking the time to report this issue!
3434
GitHub Issues should only be created for problems/topics related to this project's codebase.
3535
3636
Before submitting this issue, please make sure you are complying with our Code of Conduct:
37-
https://github.com/magento/devdocs/blob/develop/.github/CODE_OF_CONDUCT.md
37+
https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md
3838
3939
Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
4040

.github/ISSUE_TEMPLATE/COMMUNITY_ISSUE_TEMPLATE.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@ 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.3
2723

2824
Notifications of Changes:
2925

@@ -45,7 +41,7 @@ Thank you for taking the time to request updates for your Community Engineering
4541
GitHub Issues should only be created for problems/topics related to this project's codebase.
4642
4743
Before submitting this issue, please make sure you are complying with our Code of Conduct:
48-
https://github.com/magento/devdocs/blob/develop/.github/CODE_OF_CONDUCT.md
44+
https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md
4945
5046
Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
5147

.github/ISSUE_TEMPLATE/NEW_FEATURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Thank you for taking the time to report this issue!
3030
GitHub Issues should only be created for problems/topics related to this project's codebase.
3131
3232
Before submitting this issue, please make sure you are complying with our Code of Conduct:
33-
https://github.com/magento/devdocs/blob/develop/.github/CODE_OF_CONDUCT.md
33+
https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md
3434
3535
Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
3636

.github/ISSUE_TEMPLATE/NEW_TOPIC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Thank you for taking the time to report this issue!
2929
GitHub Issues should only be created for problems/topics related to this project's codebase.
3030
3131
Before submitting this issue, please make sure you are complying with our Code of Conduct:
32-
https://github.com/magento/devdocs/blob/develop/.github/CODE_OF_CONDUCT.md
32+
https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md
3333
3434
Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
3535

.github/ISSUE_TEMPLATE/TOPIC_CLARIFICATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Thank you for taking the time to report this issue!
2626
GitHub Issues should only be created for problems/topics related to this project's codebase.
2727
2828
Before submitting this issue, please make sure you are complying with our Code of Conduct:
29-
https://github.com/magento/devdocs/blob/develop/.github/CODE_OF_CONDUCT.md
29+
https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md
3030
3131
Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
3232

.github/MAINTAINER_GUIDELINES.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,39 @@
11
# DevDocs maintainer guidelines
22

3-
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 specific to devdocs that will help you as a maintainer.
3+
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 specific to DevDocs that will help you as a maintainer.
44

55
## General expectations
66

77
- Self assign issues/pull requests (mostly pull requests)
88
- Review and approve or request changes
99
- Enforce the use of the issue/pull requests template
1010
- Ask contributors to link to the code base to validate documentation updates when applicable
11-
- Ask contributors not to contribute to v2.0 docs
12-
- If a maintainer creates a pull request, it should be reviewed by another maintainer or DevDocs staff member
11+
- Ask contributors not to contribute to unsupported versions of documentation when applicable
12+
- If a DevDocs maintainer creates a pull request, it must be reviewed by another maintainer or DevDocs admin
1313

1414
## Labels
1515

16-
Labels are important because they help us identify pull requests and ensure that contributors receive points and recognition. See [devdocs awards and points](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#devdocs-awards-and-points).
16+
Labels are important because they help us identify pull requests by type and ensure that contributors receive points and recognition. See [DevDocs awards and points](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#devdocs-awards-and-points).
1717

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

2020
- `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)
21+
- `Major Update`: Significant new info (for example, a new section in an existing topic)
22+
- `Technical`: Minor changes to technical content, code, processes, naming conventions
2323
- `Editorial`: Typos, grammatical inconsistencies, or minor rewrites
2424
- `small changes`: See [Small changes workflow](#small-changes-workflow)
2525

26-
We also use version labels when appropriate.
26+
We also use version labels when appropriate (for example, 2.3.x).
2727

28-
As a maintainer, we expect you to add or remove labels when appropriate.
28+
As a maintainer, we expect you to add or remove labels according to these guidelines.
2929

3030
See https://github.com/magento/devdocs/labels for all labels and their descriptions.
3131

3232
## Testing
3333

34-
Currently, we only test internal links. In the future, we plan to expand tests to include external links, markdown linting, and spell checking.
34+
We use a private CI/CD stack and do not provide access to it.
3535

36-
We use private CI/CD stack and do not provide access to it.
37-
38-
Every pull request to the `master` branch must pass tests before it can be merged. When a pull request is ready for tests, a member of the [`devdocs-admins`](https://github.com/orgs/magento/teams/devdocs-admins) team must add the test trigger phrase to the pull request as a comment. The trigger phrase is "_running tests_". By approving a pull request, you are signalling an admin that the pull request is ready for tests.
36+
Every pull request to the `master` branch must pass tests before it can be merged. When a pull request is ready for tests, a member of the [`devdocs-admins`](https://github.com/orgs/magento/teams/devdocs-admins) team must add the test trigger phrase to the pull request as a comment. The trigger phrase is "_running tests_". By approving a pull request, you are signalling to an admin that the pull request is ready for tests.
3937

4038
## Projects
4139

@@ -49,21 +47,21 @@ We prefer Markdown over HTML (in most cases). You can use [kramdown](https://kra
4947

5048
## Small changes workflow
5149

52-
Before merging a pull request to the `master` branch, it must pass automated testing. Testing takes about 30 minutes to complete for each pull request, so we created a workflow to save time for small changes.
50+
Before merging a pull request to the `master` branch, it must pass automated testing. Testing takes about 10 minutes to complete for each pull request, so we created a workflow to save time for small changes.
5351

54-
- **Individual pull requests to `master`**—15 individual pull requests to `master` x 30 minutes per pull request = 7.5 hrs of testing time
55-
- **Multiple pull requests using `small_changes`**—1 `small_changes` pull request (containing 15 individual pull requests) to `master` x 30 minutes = 30 minutes of testing time
52+
- **Individual pull requests to `master`**—15 individual pull requests to `master` x 10 minutes per pull request = 2.5 hrs of testing time
53+
- **Multiple pull requests using `small_changes`**—1 `small_changes` pull request (containing 15 individual pull requests) to `master` x 10 minutes = 10 minutes of testing time
5654

5755
This workflow is for typos, formatting issues, and minor text additions or deletions. It is not for substantial new content, changes to tables, new files, or files that have been moved.
5856

59-
Periodically, we will create a pull request from `small_changes` to `master` and then run tests on that pull request to save time.
57+
Periodically, we will create a pull request from the `small_changes` branch to the `master` branch and then run tests on that pull request to save time.
6058

6159
### Process
6260

6361
1. Review the pull request and either approve it or request changes.
64-
1. Apply the `Small changes` label if one of the following labels should also be applied:
62+
1. Apply the `small changes` label if one of the following labels should also be applied:
6563

6664
- `Editorial`
6765
- `Technical`
6866

69-
1. That's it! A devdocs-admin will run tests and merge.
67+
1. That's it! A DevDocs admin will run tests and merge.

.github/workflows/main.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Markdown linting test
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- master
7+
- 2.*-develop
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
- name: Set up Ruby
16+
uses: actions/setup-ruby@v1
17+
with:
18+
ruby-version: 2.6
19+
- name: Install mdl gem
20+
run: gem install mdl -v '0.7.0'
21+
- name: Run mdl
22+
run: mdl --style=_checks/styles/style-rules-prod --ignore-front-matter --git-recurse -- .

.ruby-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ruby-2.6.5

COPYING.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Copyright © 2013-present Magento, Inc.
2+
3+
Each Magento source file included in this distribution is licensed under OSL 3.0 or the Magento Enterprise Edition (MEE) license
4+
5+
http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
6+
Please see LICENSE.txt for the full text of the OSL 3.0 license or contact [email protected] for a copy.
7+
8+
Subject to Licensee's payment of fees and compliance with the terms and conditions of the MEE License, the MEE License supersedes the OSL 3.0 license for each source file.
9+
Please see LICENSE_EE.txt for the full text of the MEE License or visit http://magento.com/legal/terms/enterprise.

Docfile.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ content_map:
1717
-
1818
directory: src/page-builder
1919
repository: magento/magento2-page-builder
20-
branch: 1.1-develop
20+
branch: develop
2121
filter: true
2222
-
2323
directory: src/page-builder-migration
2424
repository: magento/magento2-page-builder-data-migration
2525
branch: 1.0.0-release
2626
filter: true
27-
27+

Gemfile.lock

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
GIT
22
remote: https://github.com/magento-devdocs/devdocs-theme.git
3-
revision: e1a4ff6880d5047cb8e14ac44849aca8ffaecf2a
3+
revision: d72768697309f7f13af8a37073af776420f6c3a7
44
specs:
55
devdocs (7)
66
jekyll (>= 4.0)
@@ -17,43 +17,43 @@ GEM
1717
httpclient (~> 2.8, >= 2.8.3)
1818
json (>= 1.5.1)
1919
colorator (1.1.0)
20-
concurrent-ruby (1.1.5)
20+
concurrent-ruby (1.1.6)
2121
em-websocket (0.5.1)
2222
eventmachine (>= 0.12.9)
2323
http_parser.rb (~> 0.6.0)
2424
ethon (0.12.0)
2525
ffi (>= 1.3.0)
2626
eventmachine (1.2.7)
2727
exifr (1.3.6)
28-
faraday (0.17.1)
28+
faraday (1.0.1)
2929
multipart-post (>= 1.2, < 3)
30-
ffi (1.11.3)
30+
ffi (1.12.2)
3131
filesize (0.2.0)
3232
forwardable-extended (2.6.0)
3333
fspath (3.1.2)
34-
html-proofer (3.14.1)
34+
html-proofer (3.15.2)
3535
addressable (~> 2.3)
3636
mercenary (~> 0.3)
37-
nokogiri (~> 1.10)
37+
nokogumbo (~> 2.0)
3838
parallel (~> 1.3)
3939
rainbow (~> 3.0)
4040
typhoeus (~> 1.3)
4141
yell (~> 2.0)
4242
http_parser.rb (0.6.0)
4343
httpclient (2.8.3)
44-
i18n (1.7.0)
44+
i18n (1.8.2)
4545
concurrent-ruby (~> 1.0)
4646
image_optim (0.26.5)
4747
exifr (~> 1.2, >= 1.2.2)
4848
fspath (~> 3.0)
4949
image_size (>= 1.5, < 3)
5050
in_threads (~> 1.3)
5151
progress (~> 3.0, >= 3.0.1)
52-
image_optim_pack (0.6.0.20191208)
52+
image_optim_pack (0.6.0.20200215)
5353
fspath (>= 2.1, < 4)
5454
image_optim (~> 0.19)
5555
image_size (2.0.2)
56-
in_threads (1.5.3)
56+
in_threads (1.5.4)
5757
jekyll (4.0.0)
5858
addressable (~> 2.4)
5959
colorator (~> 1.0)
@@ -80,24 +80,24 @@ GEM
8080
verbal_expressions (~> 0.1.5)
8181
jekyll-optional-front-matter (0.3.2)
8282
jekyll (>= 3.0, < 5.0)
83-
jekyll-redirect-from (0.15.0)
83+
jekyll-redirect-from (0.16.0)
8484
jekyll (>= 3.3, < 5.0)
8585
jekyll-relative-links (0.6.1)
8686
jekyll (>= 3.3, < 5.0)
87-
jekyll-sass-converter (2.0.1)
87+
jekyll-sass-converter (2.1.0)
8888
sassc (> 2.0.1, < 3.0)
8989
jekyll-sitemap (1.4.0)
9090
jekyll (>= 3.7, < 5.0)
9191
jekyll-titles-from-headings (0.5.3)
9292
jekyll (>= 3.3, < 5.0)
9393
jekyll-watch (2.2.1)
9494
listen (~> 3.0)
95-
json (2.2.0)
95+
json (2.3.0)
9696
kramdown (2.1.0)
9797
kramdown-parser-gfm (1.1.0)
9898
kramdown (~> 2.0)
99-
launchy (2.4.3)
100-
addressable (~> 2.3)
99+
launchy (2.5.0)
100+
addressable (~> 2.7)
101101
liquid (4.0.3)
102102
listen (3.2.1)
103103
rb-fsevent (~> 0.10, >= 0.10.3)
@@ -109,27 +109,30 @@ GEM
109109
mixlib-config (>= 2.2.1, < 4)
110110
mercenary (0.3.6)
111111
mini_portile2 (2.4.0)
112-
mixlib-cli (2.1.1)
113-
mixlib-config (3.0.5)
112+
mixlib-cli (2.1.6)
113+
mixlib-config (3.0.6)
114114
tomlrb
115115
multipart-post (2.1.1)
116116
netrc (0.11.0)
117-
nokogiri (1.10.7)
117+
nokogiri (1.10.9)
118118
mini_portile2 (~> 2.4.0)
119-
octokit (4.14.0)
119+
nokogumbo (2.0.2)
120+
nokogiri (~> 1.8, >= 1.8.4)
121+
octokit (4.18.0)
122+
faraday (>= 0.9)
120123
sawyer (~> 0.8.0, >= 0.5.3)
121124
parallel (1.19.1)
122125
pathutil (0.16.2)
123126
forwardable-extended (~> 2.6)
124127
progress (3.5.2)
125128
progressbar (1.10.1)
126-
public_suffix (4.0.1)
129+
public_suffix (4.0.4)
127130
rainbow (3.0.0)
128131
rake (13.0.1)
129132
rb-fsevent (0.10.3)
130-
rb-inotify (0.10.0)
133+
rb-inotify (0.10.1)
131134
ffi (~> 1.0)
132-
rouge (3.13.0)
135+
rouge (3.17.0)
133136
safe_yaml (1.0.5)
134137
sassc (2.2.1)
135138
ffi (~> 1.9)
@@ -139,17 +142,17 @@ GEM
139142
terminal-table (1.8.0)
140143
unicode-display_width (~> 1.1, >= 1.1.1)
141144
thor (0.20.3)
142-
tomlrb (1.2.9)
145+
tomlrb (1.3.0)
143146
typhoeus (1.3.1)
144147
ethon (>= 0.9.0)
145-
unicode-display_width (1.6.0)
148+
unicode-display_width (1.7.0)
146149
verbal_expressions (0.1.5)
147150
wdm (0.1.1)
148-
whatsup_github (0.0.1)
151+
whatsup_github (0.1.1)
149152
netrc (~> 0.10)
150153
octokit (~> 4.14)
151154
thor (~> 0.20)
152-
yell (2.2.0)
155+
yell (2.2.2)
153156

154157
PLATFORMS
155158
ruby

0 commit comments

Comments
 (0)