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

Commit 8d0c3cd

Browse files
authored
Merge branch 'master' into createProductReview-mutation-errors-coverage
2 parents aa27be2 + 75ff5c2 commit 8d0c3cd

File tree

904 files changed

+7969
-149105
lines changed

Some content is hidden

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

904 files changed

+7969
-149105
lines changed

.github/ISSUE_TEMPLATE/NEW_FEATURE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,3 @@ Issues that do not comply with our Code of Conduct or do not contain enough info
3636
3737
Feel free to remove this section before creating this issue.
3838
-->
39-

.github/MAINTAINER_GUIDELINES.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ In general, the same [guidelines](https://devdocs.magento.com/contributor-guide/
44

55
## General expectations
66

7-
- Self assign issues/pull requests (mostly pull requests)
8-
- Review and approve or request changes
9-
- Enforce the use of the issue/pull requests template
10-
- Ask contributors to link to the code base to validate documentation updates when applicable
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
7+
- Self assign issues/pull requests (mostly pull requests). See the [Pull Request Process wiki topic](https://github.com/magento/devdocs/wiki/Pull-Request-Process) to learn more.
8+
- Review and approve, or request changes.
9+
- Enforce the use of the issue/pull request template.
10+
- Ask contributors to link to the code base to validate documentation updates when applicable.
11+
- Ask contributors not to contribute to unsupported versions of documentation when applicable.
12+
- Ask contributors to add a [`whatsnew`](https://github.com/magento/devdocs/wiki/Pull-Request-Process) to their `New Topic`, `Major Update`, or `Technical` labeled PRs.
13+
- If a DevDocs maintainer creates a pull request, it must be reviewed by another maintainer or DevDocs admin.
1314

1415
## Labels
1516

@@ -23,12 +24,21 @@ Here is a brief summary of the most important labels:
2324
- `Editorial`: Typos, grammatical inconsistencies, or minor rewrites
2425
- `small changes`: See [Small changes workflow](#small-changes-workflow)
2526

27+
PRs with the `Internal Dev` label were created by Magento/Adobe employees and will be handled by the Documentation team only.
28+
2629
We also use version labels when appropriate (for example, 2.3.x).
2730

2831
As a maintainer, we expect you to add or remove labels according to these guidelines.
2932

3033
See https://github.com/magento/devdocs/labels for all labels and their descriptions.
3134

35+
## Communicating internally and externally
36+
37+
There may be instances in which a maintainer has questions about a specific PR or issue. There are proper channels for communicating internally (Magento) and externally (contributors):
38+
39+
- Externally: Questions, revisions, or other conversation with the contributor must happen within the applicable PR or issue. Tag the contributor, if needed, to get their attention.
40+
- Internally: Questions for the Magento Documentation team about a PR or issue can happen as a comment in the applicable PR or issue or within the #devdocs_maintainers channel in Magento Community Engineering Slack. If your question pertains to a specific team member, you can tag their name to initiate the conversation.
41+
3242
## Testing
3343

3444
We use a private CI/CD stack and do not provide access to it.

.github/workflows/linter.yml

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,11 @@ name: Lint Code Base
1111
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
1212
#
1313

14-
#############################
15-
# Start the job on all push #
16-
#############################
14+
###################################
15+
# Start the job on a pull request #
16+
###################################
1717
on:
18-
pull_request:
19-
branches:
20-
- master
21-
- 2.*-develop
22-
paths-ignore:
23-
- '**.md'
24-
- '**.html'
25-
- '**.xml'
18+
pull_request
2619

2720
###############
2821
# Set the Job #
@@ -54,4 +47,5 @@ jobs:
5447
VALIDATE_ALL_CODEBASE: false
5548
DEFAULT_BRANCH: master
5649
VALIDATE_HTML: false
57-
VALIDATE_MARKDOWN: false
50+
VALIDATE_OPENAPI: false
51+
MARKDOWN_CONFIG_FILE: .markdownlint.json

.github/workflows/main.yml

Lines changed: 0 additions & 22 deletions
This file was deleted.

Docfile.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ content_map:
1313
-
1414
directory: src/mftf/v2
1515
repository: magento/magento2-functional-testing-framework
16-
branch: 2.6.5
16+
branch: 2.x-develop
1717
filter: true
1818
-
1919
directory: src/page-builder

Gemfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
GIT
22
remote: https://github.com/magento-devdocs/devdocs-theme.git
3-
revision: c96131acc7a0ed03629ab3401c8a64d819e7e610
3+
revision: 0bd45b1e1816f5c94233c2c36403bc3242a6551a
44
specs:
5-
devdocs (12)
5+
devdocs (14)
66
jekyll (>= 4.0)
77

88
GEM

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This site is built by [Jekyll](https://jekyllrb.com/), which is an open-source t
1515
You can build the site locally in the following ways:
1616

1717
- [Installing the project dependencies locally](#build-locally) (Mac, Linux)
18-
- [Using Docker (docker-compose)](#docker-docker-compose) (Mac, Linux, Windows)
18+
- [Using Docker (docker-compose)](https://github.com/magento/devdocs/wiki/Build-DevDocs-with-Docker) (Mac, Linux, Windows)
1919
- [Using a Vagrant virtual machine](https://github.com/magento-devdocs/vagrant-for-magento-devdocs) (Mac, Linux, Windows)
2020
- [Build DevDocs in Windows](https://github.com/magento/devdocs/wiki/Build-DevDocs-in-Windows) (Windows 7 & 10)
2121
- [Building older versions of the documentation](https://github.com/magento/devdocs/wiki/Build-DevDocs-with-Docker)

Rakefile

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,14 @@ task :whatsnew do
7878
print 'Generating data for the What\'s New digest: $ '.magenta
7979

8080
# Generate tmp/whats-new.yml
81-
if since.nil? || since.empty?
82-
sh 'bin/whatsup_github', 'since', last_update
83-
elsif since.is_a? String
84-
sh 'bin/whatsup_github', 'since', since
85-
else
86-
abort 'The "since" argument must be a string. Example: "jul 4"'
87-
end
81+
report =
82+
if since.nil? || since.empty?
83+
`bin/whatsup_github since '#{last_update}'`
84+
elsif since.is_a? String
85+
`bin/whatsup_github since #{since}`
86+
else
87+
abort 'The "since" argument must be a string. Example: "jul 4"'
88+
end
8889

8990
# Merge generated tmp/whats-new.yml with existing src/_data/whats-new.yml
9091
generated_data = YAML.load_file generated_file
@@ -94,6 +95,9 @@ task :whatsnew do
9495

9596
puts "Writing updates to #{current_file}"
9697
File.write current_file, current_data.to_yaml
98+
99+
abort report if report.include? 'MISSING whatsnew'
100+
puts report
97101
end
98102

99103
desc 'Generate index for Algolia'

_checks/html_check_hook.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
if url_ignore
3434
url_ignore.push(jekyll_excludes_as_regex).flatten!.uniq!
3535
else
36-
checks_config['html-proofer'].merge!(url_ignore: jekyll_excludes_as_regex)
36+
checks_config['html-proofer'][:url_ignore] = jekyll_excludes_as_regex
3737
end
3838

3939
# Read configuration options for html-proofer

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# For more details about available options and defaults, refer to https://jekyllrb.com/docs/configuration/
44
#
55
title: Magento 2 Developer Documentation
6-
logo: DevDocs
6+
logo: Magento DevDocs
77
description: Magento 2 Developer Documentation.
88

99
# the base protocol and domain

0 commit comments

Comments
 (0)