Sync 2.4.2-develop

.github/workflows/linter.yml

@@ -11,14 +11,11 @@ name: Lint Code Base
 # https://help.github.com/en/articles/workflow-syntax-for-github-actions
 #
 
-#############################
-# Start the job on all push #
-#############################
+###################################
+# Start the job on a pull request #
+###################################
 on:
-  pull_request:
-    branches:
-      - master
-      - 2.*-develop
+  pull_request
 
 ###############
 # Set the Job #
@@ -50,4 +47,5 @@ jobs:
           VALIDATE_ALL_CODEBASE: false
           DEFAULT_BRANCH: master
           VALIDATE_HTML: false
+          VALIDATE_OPENAPI: false
           MARKDOWN_CONFIG_FILE: .markdownlint.json

README.md

@@ -15,7 +15,7 @@ This site is built by [Jekyll](https://jekyllrb.com/), which is an open-source t
 You can build the site locally in the following ways:
 
 -  [Installing the project dependencies locally](#build-locally) (Mac, Linux)
--  [Using Docker (docker-compose)](#docker-docker-compose) (Mac, Linux, Windows)
+-  [Using Docker (docker-compose)](https://github.com/magento/devdocs/wiki/Build-DevDocs-with-Docker) (Mac, Linux, Windows)
 -  [Using a Vagrant virtual machine](https://github.com/magento-devdocs/vagrant-for-magento-devdocs) (Mac, Linux, Windows)
 -  [Build DevDocs in Windows](https://github.com/magento/devdocs/wiki/Build-DevDocs-in-Windows) (Windows 7 & 10)
 -  [Building older versions of the documentation](https://github.com/magento/devdocs/wiki/Build-DevDocs-with-Docker)

Rakefile

@@ -78,13 +78,14 @@ task :whatsnew do
   print 'Generating data for the What\'s New digest: $ '.magenta
 
   # Generate tmp/whats-new.yml
-  if since.nil? || since.empty?
-    sh 'bin/whatsup_github', 'since', last_update
-  elsif since.is_a? String
-    sh 'bin/whatsup_github', 'since', since
-  else
-    abort 'The "since" argument must be a string. Example: "jul 4"'
-  end
+  report =
+    if since.nil? || since.empty?
+      `bin/whatsup_github since '#{last_update}'`
+    elsif since.is_a? String
+      `bin/whatsup_github since #{since}`
+    else
+      abort 'The "since" argument must be a string. Example: "jul 4"'
+    end
 
   # Merge generated tmp/whats-new.yml with existing src/_data/whats-new.yml
   generated_data = YAML.load_file generated_file
@@ -94,6 +95,9 @@ task :whatsnew do
 
   puts "Writing updates to #{current_file}"
   File.write current_file, current_data.to_yaml
+
+  abort report if report.include? 'MISSING whatsnew'
+  puts report
 end
 
 desc 'Generate index for Algolia'

_plugins/debug/site_post_render.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright © Magento, Inc. All rights reserved.
+# See COPYING.txt for license details.
+
+# To enable this plugin, add to your '_config.local.yml' the following:
+#
+# debug: site_post_render
+#
+# 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.
+# See the ":site, :post_render" hook: https://jekyllrb.com/docs/plugins/hooks/
+# Available objects to explore are 'site' and 'payload'.
+#
+# Several helpful methods (to use a method, chain to an object such as 'site.methods', 'payload.keys'):
+# - '.methods.sort'
+# - '.instance_variables.sort'
+# - '.keys.sort'
+#
+# Examples:
+#
+# To view available configuration data of the site
+# > payload.site.keys
+#
+# To view the number of pages:
+# > payload.site.pages.count
+#
+# To find a page by path and view its data:
+# > page = payload.site.pages.select { |page| page.path == 'cloud/env/variables-build.md' }[0]
+# > page.data
+#
+# To exit from the IRB session:
+# > exit!
+#
+Jekyll::Hooks.register :site, :post_render do |site, payload|
+  next unless site.config['serving']
+
+  # rubocop:disable Lint/Debugger
+  binding.irb if site.config['debug'] == 'site_post_render'
+  # rubocop:enable Lint/Debugger
+end

_plugins/debug/site_pre_render.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright © Magento, Inc. All rights reserved.
+# See COPYING.txt for license details.
+
+# To enable this plugin, add to your '_config.local.yml' the following:
+#
+# debug: site_pre_render
+#
+# 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.
+# See the ":site, :pre_render" hook: https://jekyllrb.com/docs/plugins/hooks/
+# Available objects to explore are 'site' and 'payload'.
+#
+# Several helpful methods (to use a method, chain to an object such as 'site.methods', 'payload.keys'):
+# - '.methods.sort'
+# - '.instance_variables.sort'
+# - '.keys.sort'
+#
+# Examples:
+#
+# To view available configuration data of the site
+# > payload.site.keys
+#
+# To view the number of pages:
+# > payload.site.pages.count
+#
+# To find a page by path and view its data:
+# > page = payload.site.pages.select { |page| page.path == 'cloud/env/variables-build.md' }[0]
+# > page.data
+#
+# To exit from the IRB session:
+# > exit!
+#
+Jekyll::Hooks.register :site, :pre_render do |site, payload|
+  next unless site.config['serving']
+
+  # rubocop:disable Lint/Debugger
+  binding.irb if site.config['debug'] == 'site_pre_render'
+  # rubocop:enable Lint/Debugger
+end

docker-compose.yaml

@@ -2,7 +2,7 @@ version: '3.6'
 
 services:
   jekyll:
-    image: jekyll/jekyll:latest
+    image: jekyll/jekyll:3.8.6
     command: jekyll serve --watch --incremental --open-url --livereload
     ports:
       - 4000:4000

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

@@ -265,6 +265,9 @@ pages:
         - label: Array Manager
           url: /extension-dev-guide/framework/array-manager.html
 
+        - label: URL Library
+          url: /extension-dev-guide/framework/url-library.html
+
     - label: Security
       children:
 

src/_data/whats-new.yml

@@ -4,8 +4,118 @@ description: This page contains recent changes that we think you'd like to know
   We exclude from this list proofreading, spelling checks, and all minor updates.
 link: "/whats-new.html"
 thread: "/whatsnew-feed.xml"
-updated: Tue Nov 17 05:06:39 2020
+updated: Wed Dec 16 16:19:47 2020
 entries:
+- description: Added an [example](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/requirejs.html)
+    of overwriting a Knockout JS .html template file in the `requirejs-config.js`
+    file.
+  versions: 2.3.x, 2.4.x
+  type: Major Update
+  date: December 14, 2020
+  link: https://github.com/magento/devdocs/pull/8367
+  contributor: sathiyaaa
+  profile: https://github.com/sathiyaaa
+- description: Added [descriptions](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/framework/serializer.html)
+    for the JsonHexTag, Base64Json, and FormData serializer implementations.
+  versions: 2.3.x, 2.4.x
+  type: Major Update
+  date: December 14, 2020
+  link: https://github.com/magento/devdocs/pull/8382
+  contributor: drpayyne
+  profile: https://github.com/drpayyne
+- description: Added a new topic describing the [URL Library](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/framework/url-library.html).
+  versions: 2.4.x
+  type: New Topic
+  date: December 14, 2020
+  link: https://github.com/magento/devdocs/pull/8384
+  contributor: drpayyne
+  profile: https://github.com/drpayyne
+- description: Published [release notes](https://devdocs.magento.com/quality-patches/release-notes.html)
+    for the 1.0.13 Magento Quality Patch (MQP) package release.
+  versions: 2.3.x, 2.4.x
+  type: Major Update
+  date: December 10, 2020
+  link: https://github.com/magento/devdocs/pull/8375
+  contributor: Rykh
+  profile: https://github.com/Rykh
+- description: Added an [explanation and example](http://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/requirejs.html)
+    of passing parameters to JavaScript using the `data-mage-init` HTML attribute.
+  versions: 2.3.x, 2.4.x
+  type: Major Update
+  date: December 9, 2020
+  link: https://github.com/magento/devdocs/pull/8311
+  contributor: sathiyaaa
+  profile: https://github.com/sathiyaaa
+- 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).
+  versions: 2.3.x, 2.4.x
+  type: New Topic
+  date: December 8, 2020
+  link: https://github.com/magento/devdocs/pull/8351
+  contributor: BarnyShergold
+  profile: https://github.com/BarnyShergold
+- description: Added an [explanation and example](https://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli-subcommands-maint.html)
+    of using the `$_GET['skin']` parameter to set a different layout and localized
+    content for each store in a multistore setup.
+  versions: 2.3.x, 2.4.x
+  type: Major Update
+  date: December 7, 2020
+  link: https://github.com/magento/devdocs/pull/8247
+  contributor: dineshvb
+  profile: https://github.com/dineshvb
+- description: Instructions on how to remove plugins from the [Elasticsearch service](https://devdocs.magento.com/cloud/project/services-elastic.html#additional-search-configuration).
+  versions: 2.4.x
+  type: Technical
+  date: December 4, 2020
+  link: https://github.com/magento/devdocs/pull/8336
+  contributor: bdenham
+  profile: https://github.com/bdenham
+- 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).
+  versions: 2.3.x, 2.4.x
+  type: Major Update
+  date: November 30, 2020
+  link: https://github.com/magento/devdocs/pull/8232
+  contributor: sathiyaaa
+  profile: https://github.com/sathiyaaa
+- description: Published [release notes](https://devdocs.magento.com/quality-patches/release-notes.html)
+    for the 1.0.12 Magento Quality Patch (MQP) package release.
+  versions: 2.3.x, 2.4.x
+  type: Major Update
+  date: November 26, 2020
+  link: https://github.com/magento/devdocs/pull/8271
+  contributor: ilima-ebay
+  profile: https://github.com/ilima-ebay
+- description: Updated Composer package versions to correct 2.4.x [sample data upgrade
+    instructions](https://devdocs.magento.com/guides/v2.4/comp-mgr/cli/cli-rc1-samp.html).
+  versions: 2.4.x
+  type: Technical
+  date: November 24, 2020
+  link: https://github.com/magento/devdocs/pull/8259
+  contributor: jeff-matthews
+  profile: https://github.com/jeff-matthews
+- description: Simplified and updated the [GraphQL tutorial](https://devdocs.magento.com/guides/v2.4/graphql/tutorials/checkout/index.html).
+  versions: 2.3.x, 2.4.x
+  type: Major Update
+  date: November 23, 2020
+  link: https://github.com/magento/devdocs/pull/8046
+  contributor: dobooth
+  profile: https://github.com/dobooth
+- description: Published [ece-tools 2002.1.4 package release notes](https://devdocs.magento.com/cloud/release-notes/cloud-tools.html).
+    This release fixes search engine and database validation issues that can cause
+    deployment failure.
+  versions: 2.x
+  type: Technical
+  date: November 19, 2020
+  link: https://github.com/magento/devdocs/pull/8249
+  contributor: meker12
+  profile: https://github.com/meker12
+- description: Published [release notes](https://devdocs.magento.com/quality-patches/release-notes.html)
+    for the 1.0.10 Magento Quality Patch (MQP) package release.
+  versions: 2.3.x, 2.4.x
+  type: Major Update
+  date: November 19, 2020
+  link: https://github.com/magento/devdocs/pull/8252
+  contributor: viktym
+  profile: https://github.com/viktym
 - description: Published [release notes](https://devdocs.magento.com/quality-patches/release-notes.html)
     for the 1.0.10 Magento Quality Patch (MQP) package release.
   versions: ''
@@ -74,8 +184,8 @@ entries:
   link: https://github.com/magento/devdocs/pull/8187
   contributor: jeff-matthews
   profile: https://github.com/jeff-matthews
-- description: Reorganized the [system requirements](https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements.html) pages in the Magento Installation
-    Guide to to make it more coherent.
+- description: Reorganized the [system requirements](https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements.html)
+    pages in the Magento Installation Guide to to make it more coherent.
   versions: 2.3.x, 2.4.x
   type: Major Update
   date: November 5, 2020