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

Commit 695e184

Browse files
authored
Merge branch '2.4.2-develop' into kh_company-schema-edits
2 parents e556cd6 + 43a70d1 commit 695e184

File tree

235 files changed

+11146
-2284
lines changed

Some content is hidden

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

235 files changed

+11146
-2284
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/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.

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

_plugins/debug/site_post_render.rb

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# frozen_string_literal: true
2+
3+
# Copyright © Magento, Inc. All rights reserved.
4+
# See COPYING.txt for license details.
5+
6+
# To enable this plugin, add to your '_config.local.yml' the following:
7+
#
8+
# debug: site_post_render
9+
#
10+
# This plugin runs an IRB session (https://github.com/ruby/irb) of a Jekyll application in a serving mode when it's at a state after rendering the whole site, but before writing any files.
11+
# See the ":site, :post_render" hook: https://jekyllrb.com/docs/plugins/hooks/
12+
# Available objects to explore are 'site' and 'payload'.
13+
#
14+
# Several helpful methods (to use a method, chain to an object such as 'site.methods', 'payload.keys'):
15+
# - '.methods.sort'
16+
# - '.instance_variables.sort'
17+
# - '.keys.sort'
18+
#
19+
# Examples:
20+
#
21+
# To view available configuration data of the site
22+
# > payload.site.keys
23+
#
24+
# To view the number of pages:
25+
# > payload.site.pages.count
26+
#
27+
# To find a page by path and view its data:
28+
# > page = payload.site.pages.select { |page| page.path == 'cloud/env/variables-build.md' }[0]
29+
# > page.data
30+
#
31+
# To exit from the IRB session:
32+
# > exit!
33+
#
34+
Jekyll::Hooks.register :site, :post_render do |site, payload|
35+
next unless site.config['serving']
36+
37+
# rubocop:disable Lint/Debugger
38+
binding.irb if site.config['debug'] == 'site_post_render'
39+
# rubocop:enable Lint/Debugger
40+
end

_plugins/debug/site_pre_render.rb

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# frozen_string_literal: true
2+
3+
# Copyright © Magento, Inc. All rights reserved.
4+
# See COPYING.txt for license details.
5+
6+
# To enable this plugin, add to your '_config.local.yml' the following:
7+
#
8+
# debug: site_pre_render
9+
#
10+
# This plugin runs an IRB session (https://github.com/ruby/irb) of a Jekyll application in a serving mode when it's at a state just before rendering the whole site.
11+
# See the ":site, :pre_render" hook: https://jekyllrb.com/docs/plugins/hooks/
12+
# Available objects to explore are 'site' and 'payload'.
13+
#
14+
# Several helpful methods (to use a method, chain to an object such as 'site.methods', 'payload.keys'):
15+
# - '.methods.sort'
16+
# - '.instance_variables.sort'
17+
# - '.keys.sort'
18+
#
19+
# Examples:
20+
#
21+
# To view available configuration data of the site
22+
# > payload.site.keys
23+
#
24+
# To view the number of pages:
25+
# > payload.site.pages.count
26+
#
27+
# To find a page by path and view its data:
28+
# > page = payload.site.pages.select { |page| page.path == 'cloud/env/variables-build.md' }[0]
29+
# > page.data
30+
#
31+
# To exit from the IRB session:
32+
# > exit!
33+
#
34+
Jekyll::Hooks.register :site, :pre_render do |site, payload|
35+
next unless site.config['serving']
36+
37+
# rubocop:disable Lint/Debugger
38+
binding.irb if site.config['debug'] == 'site_pre_render'
39+
# rubocop:enable Lint/Debugger
40+
end

docker-compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: '3.6'
22

33
services:
44
jekyll:
5-
image: jekyll/jekyll:latest
5+
image: jekyll/jekyll:3.8.6
66
command: jekyll serve --watch --incremental --open-url --livereload
77
ports:
88
- 4000:4000

0 commit comments

Comments
 (0)