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

Commit a8fb0ec

Browse files
jeff-matthewsjeff-matthews
authored
Merge branch '2.4.2-develop' into 2-4-2-release-note-update-1221
2 parents bc220fe + e07752d commit a8fb0ec

File tree

59 files changed

+888
-277
lines changed

Some content is hidden

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

59 files changed

+888
-277
lines changed

‎.github/workflows/linter.yml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +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
18+
pull_request
2219

2320
###############
2421
# Set the Job #
@@ -50,4 +47,5 @@ jobs:
5047
VALIDATE_ALL_CODEBASE: false
5148
DEFAULT_BRANCH: master
5249
VALIDATE_HTML: false
50+
VALIDATE_OPENAPI: false
5351
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'

‎_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

‎src/_data/toc/configuration-guide.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -367,6 +367,9 @@ pages:
367367
- label: Set up optional database replication
368368
url: /config-guide/multi-master/multi-master_slavedb.html
369369

370+
- label: Revert from a split database to a single database
371+
url: /config-guide/revert-split-database.html
372+
370373
- label: Custom Logging
371374
url: /config-guide/log/log-intro.html
372375
children:

‎src/_data/toc/php-developer-guide.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,9 @@ pages:
265265
- label: Array Manager
266266
url: /extension-dev-guide/framework/array-manager.html
267267

268+
- label: URL Library
269+
url: /extension-dev-guide/framework/url-library.html
270+
268271
- label: Security
269272
children:
270273

‎src/_data/whats-new.yml

Lines changed: 113 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,118 @@ description: This page contains recent changes that we think you'd like to know
44
We exclude from this list proofreading, spelling checks, and all minor updates.
55
link: "/whats-new.html"
66
thread: "/whatsnew-feed.xml"
7-
updated: Tue Nov 17 05:06:39 2020
7+
updated: Wed Dec 16 16:19:47 2020
88
entries:
9+
- description: Added an [example](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/requirejs.html)
10+
of overwriting a Knockout JS .html template file in the `requirejs-config.js`
11+
file.
12+
versions: 2.3.x, 2.4.x
13+
type: Major Update
14+
date: December 14, 2020
15+
link: https://github.com/magento/devdocs/pull/8367
16+
contributor: sathiyaaa
17+
profile: https://github.com/sathiyaaa
18+
- description: Added [descriptions](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/framework/serializer.html)
19+
for the JsonHexTag, Base64Json, and FormData serializer implementations.
20+
versions: 2.3.x, 2.4.x
21+
type: Major Update
22+
date: December 14, 2020
23+
link: https://github.com/magento/devdocs/pull/8382
24+
contributor: drpayyne
25+
profile: https://github.com/drpayyne
26+
- description: Added a new topic describing the [URL Library](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/framework/url-library.html).
27+
versions: 2.4.x
28+
type: New Topic
29+
date: December 14, 2020
30+
link: https://github.com/magento/devdocs/pull/8384
31+
contributor: drpayyne
32+
profile: https://github.com/drpayyne
33+
- description: Published [release notes](https://devdocs.magento.com/quality-patches/release-notes.html)
34+
for the 1.0.13 Magento Quality Patch (MQP) package release.
35+
versions: 2.3.x, 2.4.x
36+
type: Major Update
37+
date: December 10, 2020
38+
link: https://github.com/magento/devdocs/pull/8375
39+
contributor: Rykh
40+
profile: https://github.com/Rykh
41+
- description: Added an [explanation and example](http://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/requirejs.html)
42+
of passing parameters to JavaScript using the `data-mage-init` HTML attribute.
43+
versions: 2.3.x, 2.4.x
44+
type: Major Update
45+
date: December 9, 2020
46+
link: https://github.com/magento/devdocs/pull/8311
47+
contributor: sathiyaaa
48+
profile: https://github.com/sathiyaaa
49+
- description: Added a new topic describing how to [customize the Magento Admin design](https://devdocs.magento.com/guides/v2.4/howdoi/admin/customize_admin.html).
50+
versions: 2.3.x, 2.4.x
51+
type: New Topic
52+
date: December 8, 2020
53+
link: https://github.com/magento/devdocs/pull/8351
54+
contributor: BarnyShergold
55+
profile: https://github.com/BarnyShergold
56+
- description: Added an [explanation and example](https://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli-subcommands-maint.html)
57+
of using the `$_GET['skin']` parameter to set a different layout and localized
58+
content for each store in a multistore setup.
59+
versions: 2.3.x, 2.4.x
60+
type: Major Update
61+
date: December 7, 2020
62+
link: https://github.com/magento/devdocs/pull/8247
63+
contributor: dineshvb
64+
profile: https://github.com/dineshvb
65+
- description: Instructions on how to remove plugins from the [Elasticsearch service](https://devdocs.magento.com/cloud/project/services-elastic.html#additional-search-configuration).
66+
versions: 2.4.x
67+
type: Technical
68+
date: December 4, 2020
69+
link: https://github.com/magento/devdocs/pull/8336
70+
contributor: bdenham
71+
profile: https://github.com/bdenham
72+
- description: Added detailed examples to [Define the GraphQL schema for a module](https://devdocs.magento.com/guides/v2.4/graphql/develop/create-graphqls-file.html).
73+
versions: 2.3.x, 2.4.x
74+
type: Major Update
75+
date: November 30, 2020
76+
link: https://github.com/magento/devdocs/pull/8232
77+
contributor: sathiyaaa
78+
profile: https://github.com/sathiyaaa
79+
- description: Published [release notes](https://devdocs.magento.com/quality-patches/release-notes.html)
80+
for the 1.0.12 Magento Quality Patch (MQP) package release.
81+
versions: 2.3.x, 2.4.x
82+
type: Major Update
83+
date: November 26, 2020
84+
link: https://github.com/magento/devdocs/pull/8271
85+
contributor: ilima-ebay
86+
profile: https://github.com/ilima-ebay
87+
- description: Updated Composer package versions to correct 2.4.x [sample data upgrade
88+
instructions](https://devdocs.magento.com/guides/v2.4/comp-mgr/cli/cli-rc1-samp.html).
89+
versions: 2.4.x
90+
type: Technical
91+
date: November 24, 2020
92+
link: https://github.com/magento/devdocs/pull/8259
93+
contributor: jeff-matthews
94+
profile: https://github.com/jeff-matthews
95+
- description: Simplified and updated the [GraphQL tutorial](https://devdocs.magento.com/guides/v2.4/graphql/tutorials/checkout/index.html).
96+
versions: 2.3.x, 2.4.x
97+
type: Major Update
98+
date: November 23, 2020
99+
link: https://github.com/magento/devdocs/pull/8046
100+
contributor: dobooth
101+
profile: https://github.com/dobooth
102+
- description: Published [ece-tools 2002.1.4 package release notes](https://devdocs.magento.com/cloud/release-notes/cloud-tools.html).
103+
This release fixes search engine and database validation issues that can cause
104+
deployment failure.
105+
versions: 2.x
106+
type: Technical
107+
date: November 19, 2020
108+
link: https://github.com/magento/devdocs/pull/8249
109+
contributor: meker12
110+
profile: https://github.com/meker12
111+
- description: Published [release notes](https://devdocs.magento.com/quality-patches/release-notes.html)
112+
for the 1.0.10 Magento Quality Patch (MQP) package release.
113+
versions: 2.3.x, 2.4.x
114+
type: Major Update
115+
date: November 19, 2020
116+
link: https://github.com/magento/devdocs/pull/8252
117+
contributor: viktym
118+
profile: https://github.com/viktym
9119
- description: Published [release notes](https://devdocs.magento.com/quality-patches/release-notes.html)
10120
for the 1.0.10 Magento Quality Patch (MQP) package release.
11121
versions: ''
@@ -74,8 +184,8 @@ entries:
74184
link: https://github.com/magento/devdocs/pull/8187
75185
contributor: jeff-matthews
76186
profile: https://github.com/jeff-matthews
77-
- description: Reorganized the [system requirements](https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements.html) pages in the Magento Installation
78-
Guide to to make it more coherent.
187+
- description: Reorganized the [system requirements](https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements.html)
188+
pages in the Magento Installation Guide to to make it more coherent.
79189
versions: 2.3.x, 2.4.x
80190
type: Major Update
81191
date: November 5, 2020

0 commit comments

Comments
 (0)