Skip to content

Commit

Permalink
Sync 2.4.2-develop (#8423)
Browse files Browse the repository at this point in the history
* Adding link to catalog sync dashboard

* Merge small-changes branch into master (#8377)

* Update braintree-vault.md (#8345)

* Update braintree-vault.md

Request data is invalid. Syntax Error: Expected Name, found <EOF>".

* Update braintree-vault.md

* Update payflow-pro.md (#8346)

Resolved Syntax Error: Expected Name, found <EOF> from the GraphQL Request.

* add reference to the order item options and link (#8344)

* Update add-products-to-cart.md (#8355)

* Update add-products-to-cart.md

Cart Id Invalid Error message.

* Update add-products-to-cart.md

Co-authored-by: Kevin Harper <keharper@users.noreply.github.com>

* customer query improvements (#8353)

* cart query object improvement (#8352)

* Update category-list.md (#8313)

* Update category-list.md

Give Example of url_key and url_path attribute with categoryList query.

* Update category-list.md

* Update category-list.md

* Update category-list.md

Co-authored-by: Kevin Harper <keharper@users.noreply.github.com>

* used viewModel

* Update customizable-option-interface.md (#8328)

* Update customizable-option-interface.md

Added Example of the custom option type CustomizableFieldOption for the text field.

* Update customizable-option-interface.md

* Update customizable-option-interface.md

* add error message on the product type (#8361)

Co-authored-by: Rakesh  Jesadiya <jesadiya.rakesh@gmail.com>
Co-authored-by: Sathiya Prakash <Sathiya.Prakash@gds.ey.com>
Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>

* Updated Serializer implementations (#8382)

Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>

* Example added on how to overwrite a knockoutjs html file (#8367)

* Added an example for overwriting a knockoutjs .html template file in requirejs-config.js by using paths

* removed the image

* fixed lint errors

* fixed lint errors

* Review comments

* Added spaces after list hyphen

* review comments

* lint errors

* Apply suggestions from code review

Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>

* split a point for clarity

* lint errors

* lint errors

* lint errors

* formatting errors

* Fixed formatting

Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>

* Added new page for URL library (#8384)

* Added new page for URL library

* Added new page to TOC

* Fixed PHP code doc blocks

* Added symlink to 2.4

Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>

* Fix 404s on External Links (#8348)

* Fix 404s on External Links

* Small change to avoid conflict

* Update src/guides/v2.3/coding-standards/docblock-standard-general.md

Co-authored-by: Dmitry Shevtsov <12731225+dshevtsov@users.noreply.github.com>

* Update src/guides/v2.3/config-guide/secy/secy-xframe.md

Co-authored-by: Dmitry Shevtsov <12731225+dshevtsov@users.noreply.github.com>

* Update src/guides/v2.3/config-guide/varnish/config-varnish-advanced.md

Co-authored-by: Dmitry Shevtsov <12731225+dshevtsov@users.noreply.github.com>

Co-authored-by: Barny Shergold <barnyshergold@MacBook-Pro-9.local>
Co-authored-by: Dmitry Shevtsov <12731225+dshevtsov@users.noreply.github.com>
Co-authored-by: Margaret Eker <meker@adobe.com>

* Update whastnew template and rake task (#8393)

* Update rake whatsnew

Exit with error when 'Missing whatsnew' appears to fail a Jenkins build

* Update whatsnew template

Add grouping by moth and by date

* Update Whats New data (#8385)

* added a note indicating that the deletion of snippets has to be done using the api (#8327)

* added a note indicating that the deletion of snippets has to be done using the API
* Update src/cloud/cdn/cloud-vcl-custom-snippets.md
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: Margaret Eker <meker@adobe.com>

* [maintenance] Add plugins for debugging (#7998)

* Update the linting workflow on GitHub (#8405)

* Delete main.yml

Removing the Markdown lint test as a duplicate of the Lint Code Base test

* Update linter.yml

Run linters on any pull request, not only to master or develop

* Disabel OpenAPI linter (#8409)

* Improve info about managing SSH keys in Cloud Guide (#8364)

* Fix broken link in Cloud Guide

* Add tip for managing SSH keys on Cloud projects

* Update src/_includes/cloud/enable-ssh.md

* Fix lint error

* Replace ssh-keygen instructions with link

- Replaced ssh-keygen instructions with link to GitHub documentation,
which provides instructions for Linux, macOS, and Windows.
- Clarified other instructions

* Apply suggestions from code review

Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

* Update performing-searches.md (#8400)

* Update performing-searches.md

Added Example of in and nin operator.

* Update performing-searches.md

* Update performing-searches.md

Co-authored-by: Kevin Harper <keharper@users.noreply.github.com>

* MC-40003: [Documentation] Invalid directive for 'X-Frame-Options' header

* Update widget_prompt.md (#8283)

Co-authored-by: Kevin Harper <keharper@users.noreply.github.com>

* Merge small-changes branch into master (#8418)

* Use "jekyll/jekyll:3.8.6" so it is locked, rather than "latest", refs #8370

* Update README.md

* Updated the linux kernel info in software pgae

* added a missing code-fence

* fixed lint

* fixed lint

* Apply suggestions from code review

Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>

* shipment-email-notify (#8399)

* shipment-email-notify

* Update order-create-shipment.md

Co-authored-by: Julian van den Berkmortel <julian@weprovide.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
Co-authored-by: CJ <cperumal@ztech.io>
Co-authored-by: Sathiya Prakash <Sathiya.Prakash@gds.ey.com>
Co-authored-by: chiranjeevi <52098385+chiranjeevi-cj@users.noreply.github.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>
Co-authored-by: Rakesh  Jesadiya <jesadiya.rakesh@gmail.com>

* Update catalog.md (#8401)

* Update catalog.md

Added Response of the Category creation.

* Update catalog.md

* Update catalog.md

Co-authored-by: Kevin Harper <keharper@users.noreply.github.com>

Co-authored-by: Erik Marr <emarr@adobe.com>
Co-authored-by: Rakesh  Jesadiya <jesadiya.rakesh@gmail.com>
Co-authored-by: Sathiya Prakash <Sathiya.Prakash@gds.ey.com>
Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>
Co-authored-by: Adarsh Manickam <adarsh.apple@icloud.com>
Co-authored-by: Sathiya Prakash <50226394+sathiyaaa@users.noreply.github.com>
Co-authored-by: Erik Marr <45772211+erikmarr@users.noreply.github.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: Barny Shergold <barnyshergold@MacBook-Pro-9.local>
Co-authored-by: Dmitry Shevtsov <12731225+dshevtsov@users.noreply.github.com>
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: devops-devdocs <48562208+devops-devdocs@users.noreply.github.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
Co-authored-by: Viktor Tymchynskyi <vtymchynskyi@magento.com>
Co-authored-by: Hardik Makwana <hardikm.magentodeveloper@gmail.com>
Co-authored-by: Julian van den Berkmortel <julian@weprovide.com>
Co-authored-by: CJ <cperumal@ztech.io>
Co-authored-by: chiranjeevi <52098385+chiranjeevi-cj@users.noreply.github.com>
  • Loading branch information
19 people committed Dec 21, 2020
1 parent da99448 commit d110b67
Show file tree
Hide file tree
Showing 55 changed files with 809 additions and 277 deletions.
12 changes: 5 additions & 7 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 #
Expand Down Expand Up @@ -50,4 +47,5 @@ jobs:
VALIDATE_ALL_CODEBASE: false
DEFAULT_BRANCH: master
VALIDATE_HTML: false
VALIDATE_OPENAPI: false
MARKDOWN_CONFIG_FILE: .markdownlint.json
22 changes: 0 additions & 22 deletions .github/workflows/main.yml

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
18 changes: 11 additions & 7 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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'
Expand Down
40 changes: 40 additions & 0 deletions _plugins/debug/site_post_render.rb
Original file line number Diff line number Diff line change
@@ -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
40 changes: 40 additions & 0 deletions _plugins/debug/site_pre_render.rb
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions src/_data/toc/php-developer-guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
116 changes: 113 additions & 3 deletions src/_data/whats-new.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: ''
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit d110b67

Please sign in to comment.