diff --git a/.github/linters/.markdownlint.json b/.github/linters/.markdownlint.json new file mode 100644 index 00000000000..922a907842c --- /dev/null +++ b/.github/linters/.markdownlint.json @@ -0,0 +1,25 @@ +{ + "default": false, + "MD001": true, + "MD003": { "style": "atx" }, + "MD004": true, + "MD005": true, + "MD006": true, + "MD007": { "indent": 3 }, + "MD009": true, + "MD010": true, + "MD012": true, + "MD018": true, + "MD019": true, + "MD023": true, + "MD025": true, + "MD029": true, + "MD030": { "ol_single": 1, "ol_multi": 1, "ul_single": 2, "ul_multi": 2 }, + "MD032": true, + "MD035": true, + "MD036": true, + "MD037": true, + "MD038": true, + "MD040": true, + "MD046": { "style": "fenced"} +} diff --git a/.github/linters/.ruby-lint.yml b/.github/linters/.ruby-lint.yml new file mode 100644 index 00000000000..29b77e8d6b5 --- /dev/null +++ b/.github/linters/.ruby-lint.yml @@ -0,0 +1,11 @@ +--- +####################### +# Rubocop Config file # +####################### + +inherit_gem: + rubocop-github: + - config/default.yml + +Style/StringLiterals: + EnforcedStyle: single_quotes diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml new file mode 100644 index 00000000000..7735831ef62 --- /dev/null +++ b/.github/workflows/linter.yml @@ -0,0 +1,53 @@ +--- +########################### +########################### +## Linter GitHub Actions ## +########################### +########################### +name: Lint Code Base + +# +# Documentation: +# https://help.github.com/en/articles/workflow-syntax-for-github-actions +# + +############################# +# Start the job on all push # +############################# +on: + pull_request: + branches: + - master + - 2.*-develop + +############### +# Set the Job # +############### +jobs: + + build: + # Name the Job + name: Lint Code Base + # Set the agent to run on + runs-on: ubuntu-latest + + ################## + # Load all steps # + ################## + steps: + ########################## + # Checkout the code base # + ########################## + - name: Checkout Code + uses: actions/checkout@v2 + + ################################ + # Run Linter against code base # + ################################ + - name: Lint Code Base + uses: github/super-linter@v3 + env: + VALIDATE_ALL_CODEBASE: false + DEFAULT_BRANCH: master + VALIDATE_HTML: false + VALIDATE_MD: false diff --git a/.markdownlint.json b/.markdownlint.json new file mode 120000 index 00000000000..600dde1bbb1 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1 @@ +.github/linters/.markdownlint.json \ No newline at end of file diff --git a/Gemfile b/Gemfile index ab888caeec8..55d297c215e 100644 --- a/Gemfile +++ b/Gemfile @@ -4,15 +4,15 @@ source 'https://rubygems.org' gem 'devdocs', git: 'https://github.com/magento-devdocs/devdocs-theme.git' gem 'jekyll' -gem 'whatsup_github' gem 'rake' +gem 'whatsup_github' gem 'wdm', platform: :mswin group :test do gem 'html-proofer' - gem 'mdl' gem 'launchy' + gem 'mdl' end group :optimization do @@ -22,9 +22,9 @@ end group :jekyll_plugins do gem 'jekyll-algolia', '~> 1.0' + gem 'jekyll-optional-front-matter' gem 'jekyll-redirect-from' + gem 'jekyll-relative-links' gem 'jekyll-sitemap' gem 'jekyll-titles-from-headings' - gem 'jekyll-relative-links' - gem 'jekyll-optional-front-matter' end diff --git a/Rakefile b/Rakefile index dc74e4cbde6..5a78b4c913c 100644 --- a/Rakefile +++ b/Rakefile @@ -71,7 +71,7 @@ desc 'Generate data for a news digest. Default timeframe is a week since today. task :whatsnew do date = ENV['since'] print 'Generating data for the weekly digest: $ '.magenta - if date.nil? or date.empty? + if date.nil? || date.empty? sh 'bin/whatsup_github' elsif date.is_a? String sh 'bin/whatsup_github', 'since', ENV['since'].to_s @@ -84,8 +84,8 @@ desc 'Generate index for Algolia' task index: %w[init] do puts 'Generating index for Algolia ...' sh 'bin/jekyll', - 'algolia', - '--config=_config.yml,_config.index.yml' + 'algolia', + '--config=_config.yml,_config.index.yml' end desc 'Convert HTML text to kramdown in your terminal' @@ -94,4 +94,4 @@ task :convert do result = `bin/kramdown --input=html --output=kramdown` puts 'Converted text:'.magenta puts result.bold -end \ No newline at end of file +end diff --git a/_plugins/algolia.rb b/_plugins/algolia.rb index 0d8e2bb4c18..d33d86583ba 100644 --- a/_plugins/algolia.rb +++ b/_plugins/algolia.rb @@ -1,13 +1,15 @@ +# frozen_string_literal: true + # Copyright © Magento, Inc. All rights reserved. # See COPYING.txt for license details. module Jekyll module Algolia module Hooks - def self.before_indexing_each(record, node, context) + def self.before_indexing_each(record, _node, _context) # Do not index records larger than 20000 bytes - return nil if record.to_s.bytesize > 20000 - + return nil if record.to_s.bytesize > 20_000 + record end end diff --git a/_plugins/liquid-tags/collapsible.rb b/_plugins/liquid-tags/collapsible.rb index bb2399b13bf..beb4b415ae3 100644 --- a/_plugins/liquid-tags/collapsible.rb +++ b/_plugins/liquid-tags/collapsible.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Copyright © Magento, Inc. All rights reserved. # See COPYING.txt for license details. @@ -30,7 +32,7 @@ def render(context) #{@title}
#{content}
- HTML + HTML end end @@ -58,7 +60,7 @@ def render(context)

#{@title}

#{content}
- HTML + HTML end end @@ -85,7 +87,7 @@ def render(context)

#{@title}

#{content}
- HTML + HTML end end end diff --git a/_plugins/page-params/github-path.rb b/_plugins/page-params/github_path.rb similarity index 94% rename from _plugins/page-params/github-path.rb rename to _plugins/page-params/github_path.rb index 5a7f33b7c9d..368d0274f50 100644 --- a/_plugins/page-params/github-path.rb +++ b/_plugins/page-params/github_path.rb @@ -10,9 +10,8 @@ # The parameter contains a file path relative to its repository. # Jekyll::Hooks.register :pages, :post_init do |page| - # Skip virtual pages like MRG topics - next if page.kind_of? Jekyll::PageWithoutAFile + next if page.is_a? Jekyll::PageWithoutAFile # Process only files with 'md' and 'html' extensions next unless File.extname(page.path).match?(/md|html/) # Skip redirects @@ -22,7 +21,7 @@ page.site.source, File.dirname(page.path) ) - + filename = File.basename page.path # Change to the parent directory of the page and read full file path diff --git a/_plugins/page-params/last-modified-at.rb b/_plugins/page-params/last_modified_at.rb similarity index 96% rename from _plugins/page-params/last-modified-at.rb rename to _plugins/page-params/last_modified_at.rb index 3882a0d3ebd..ac35554760c 100644 --- a/_plugins/page-params/last-modified-at.rb +++ b/_plugins/page-params/last_modified_at.rb @@ -25,11 +25,11 @@ next if page.data['last_modified_at'] # Skip pages created by custom generators like 'mrg_pages' - next if page.kind_of? Jekyll::PageWithoutAFile + next if page.is_a? Jekyll::PageWithoutAFile # Add site.source to the page path file_path = File.join(page.site.source, page.path) - + # Get real path of the page. If this is a symlink read it to get path of the real file with content. real_filepath = File.realpath(file_path) diff --git a/_plugins/page-params/page-baseurl-generator.rb b/_plugins/page-params/page_baseurl_generator.rb similarity index 97% rename from _plugins/page-params/page-baseurl-generator.rb rename to _plugins/page-params/page_baseurl_generator.rb index f284c300d7b..5c7766d4778 100644 --- a/_plugins/page-params/page-baseurl-generator.rb +++ b/_plugins/page-params/page_baseurl_generator.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Copyright © Magento, Inc. All rights reserved. # See COPYING.txt for license details. diff --git a/_plugins/page-params/page-canonical-url.rb b/_plugins/page-params/page_canonical_url.rb similarity index 98% rename from _plugins/page-params/page-canonical-url.rb rename to _plugins/page-params/page_canonical_url.rb index 13d7f95313f..41244ea9a03 100644 --- a/_plugins/page-params/page-canonical-url.rb +++ b/_plugins/page-params/page_canonical_url.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Copyright © Magento, Inc. All rights reserved. # See COPYING.txt for license details. diff --git a/_plugins/page-params/page-versionless.rb b/_plugins/page-params/page_versionless.rb similarity index 99% rename from _plugins/page-params/page-versionless.rb rename to _plugins/page-params/page_versionless.rb index c5cbdfcc384..289e526c172 100644 --- a/_plugins/page-params/page-versionless.rb +++ b/_plugins/page-params/page_versionless.rb @@ -17,6 +17,6 @@ filtering_pattern = '/guides/v' next if page.url.start_with? filtering_pattern - + page.data['versionless'] = true -end \ No newline at end of file +end diff --git a/_plugins/page-params/page-versions.rb b/_plugins/page-params/page_versions.rb similarity index 99% rename from _plugins/page-params/page-versions.rb rename to _plugins/page-params/page_versions.rb index 0dff8e6b9c0..f26958103ac 100644 --- a/_plugins/page-params/page-versions.rb +++ b/_plugins/page-params/page_versions.rb @@ -29,6 +29,7 @@ urls_filtered_by_pattern = pages.select do |site_page| next if site_page.name == 'redirect.html' + site_page.url.start_with? filtering_pattern end.map(&:url) diff --git a/bin/htmlproofer b/bin/htmlproofer index e668c8385ff..b7e0c6b17ed 100755 --- a/bin/htmlproofer +++ b/bin/htmlproofer @@ -8,11 +8,11 @@ # this file is here to facilitate running it. # -require "pathname" -ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", - Pathname.new(__FILE__).realpath) +require 'pathname' +ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', + Pathname.new(__FILE__).realpath) -bundle_binstub = File.expand_path("../bundle", __FILE__) +bundle_binstub = File.expand_path('bundle', __dir__) if File.file?(bundle_binstub) if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/ @@ -23,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this end end -require "rubygems" -require "bundler/setup" +require 'rubygems' +require 'bundler/setup' -load Gem.bin_path("html-proofer", "htmlproofer") +load Gem.bin_path('html-proofer', 'htmlproofer') diff --git a/bin/image_optim b/bin/image_optim index a2624d763ac..10eeb949276 100755 --- a/bin/image_optim +++ b/bin/image_optim @@ -8,11 +8,11 @@ # this file is here to facilitate running it. # -require "pathname" -ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", - Pathname.new(__FILE__).realpath) +require 'pathname' +ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', + Pathname.new(__FILE__).realpath) -bundle_binstub = File.expand_path("../bundle", __FILE__) +bundle_binstub = File.expand_path('bundle', __dir__) if File.file?(bundle_binstub) if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/ @@ -23,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this end end -require "rubygems" -require "bundler/setup" +require 'rubygems' +require 'bundler/setup' -load Gem.bin_path("image_optim", "image_optim") +load Gem.bin_path('image_optim', 'image_optim') diff --git a/bin/jekyll b/bin/jekyll index 1bb103b459e..86ee6e5fccc 100755 --- a/bin/jekyll +++ b/bin/jekyll @@ -1,4 +1,6 @@ #!/usr/bin/env ruby +# frozen_string_literal: true + # # This file was generated by Bundler. # @@ -7,8 +9,8 @@ # require 'pathname' -ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", - Pathname.new(__FILE__).realpath) +ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', + Pathname.new(__FILE__).realpath) require 'rubygems' require 'bundler/setup' diff --git a/bin/kramdown b/bin/kramdown index 73320ecb804..79836a090b6 100755 --- a/bin/kramdown +++ b/bin/kramdown @@ -8,11 +8,11 @@ # this file is here to facilitate running it. # -require "pathname" -ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", - Pathname.new(__FILE__).realpath) +require 'pathname' +ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', + Pathname.new(__FILE__).realpath) -bundle_binstub = File.expand_path("../bundle", __FILE__) +bundle_binstub = File.expand_path('bundle', __dir__) if File.file?(bundle_binstub) if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/ @@ -23,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this end end -require "rubygems" -require "bundler/setup" +require 'rubygems' +require 'bundler/setup' -load Gem.bin_path("kramdown", "kramdown") +load Gem.bin_path('kramdown', 'kramdown') diff --git a/bin/mdl b/bin/mdl index ec5a264e868..eedf2b4756f 100755 --- a/bin/mdl +++ b/bin/mdl @@ -8,11 +8,11 @@ # this file is here to facilitate running it. # -require "pathname" -ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", - Pathname.new(__FILE__).realpath) +require 'pathname' +ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', + Pathname.new(__FILE__).realpath) -bundle_binstub = File.expand_path("../bundle", __FILE__) +bundle_binstub = File.expand_path('bundle', __dir__) if File.file?(bundle_binstub) if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/ @@ -23,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this end end -require "rubygems" -require "bundler/setup" +require 'rubygems' +require 'bundler/setup' -load Gem.bin_path("mdl", "mdl") +load Gem.bin_path('mdl', 'mdl') diff --git a/bin/whatsup_github b/bin/whatsup_github index 498f93617a7..de9ee9e1e22 100755 --- a/bin/whatsup_github +++ b/bin/whatsup_github @@ -8,11 +8,11 @@ # this file is here to facilitate running it. # -require "pathname" -ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", - Pathname.new(__FILE__).realpath) +require 'pathname' +ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', + Pathname.new(__FILE__).realpath) -bundle_binstub = File.expand_path("../bundle", __FILE__) +bundle_binstub = File.expand_path('bundle', __dir__) if File.file?(bundle_binstub) if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/ @@ -23,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this end end -require "rubygems" -require "bundler/setup" +require 'rubygems' +require 'bundler/setup' -load Gem.bin_path("whatsup_github", "whatsup_github") +load Gem.bin_path('whatsup_github', 'whatsup_github') diff --git a/lib/double_slash_check.rb b/lib/double_slash_check.rb index 587c757eb10..a9a41ff434a 100644 --- a/lib/double_slash_check.rb +++ b/lib/double_slash_check.rb @@ -17,9 +17,7 @@ def run @link = create_element(node) line = node.line - if slash? - return add_issue('Remove double forward slashes from URLs', line: line) - end + return add_issue('Remove double forward slashes from URLs', line: line) if slash? end end end diff --git a/rakelib/build.rake b/rakelib/build.rake index ca5b222b71a..b64a4f99280 100644 --- a/rakelib/build.rake +++ b/rakelib/build.rake @@ -1,28 +1,29 @@ +# frozen_string_literal: true + # Copyright © Magento, Inc. All rights reserved. # See COPYING.txt for license details. namespace :build do - desc 'Build the site for production' task prod: %w[init] do print 'Building the site for production: $ '.magenta sh 'bin/jekyll', - 'build', - '--config=_config.yml,_config.prod.yml', - '--verbose', - '--profile', - '--trace' + 'build', + '--config=_config.yml,_config.prod.yml', + '--verbose', + '--profile', + '--trace' end desc 'Build the site for staging' task :stage do print 'Building the site for staging: $ '.magenta sh 'bin/jekyll', - 'build', - "--baseurl=/#{ENV['BUILD_NUMBER']}", - '--config=_config.yml,_config.stage.yml', - '--verbose', - '--trace', - '--profile' + 'build', + "--baseurl=/#{ENV['BUILD_NUMBER']}", + '--config=_config.yml,_config.stage.yml', + '--verbose', + '--trace', + '--profile' end end diff --git a/rakelib/check.rake b/rakelib/check.rake index 293d1397e21..c84bf3d23b0 100644 --- a/rakelib/check.rake +++ b/rakelib/check.rake @@ -4,7 +4,6 @@ # frozen_string_literal: true namespace :check do - desc 'Optimize images in modified files, or by path (rake check:img path=path/to/dir/or/file).' task :image_optim do puts @@ -16,7 +15,7 @@ namespace :check do modified_files = `git ls-files --modified --others --exclude-standard`.split("\n") deleted_files = `git ls-files --deleted`.split("\n") image_files_to_check = (modified_files - deleted_files).select { |file| File.extname(file) =~ /\.(png|jpg|jpeg|gif)/i } - + next puts 'No images to check.'.magenta if image_files_to_check.empty? path = image_files_to_check.join(' ') @@ -40,7 +39,7 @@ namespace :check do modified_files = `git ls-files --modified --others --exclude-standard`.split("\n") deleted_files = `git ls-files --deleted`.split("\n") md_files_to_check = (modified_files - deleted_files).select { |file| File.extname(file) == '.md' } - + next puts 'No Markdown files to check.'.magenta if md_files_to_check.empty? path = md_files_to_check.join(' ') diff --git a/rakelib/multirepo.rake b/rakelib/multirepo.rake index 1b47eb0eee1..02d096e4955 100644 --- a/rakelib/multirepo.rake +++ b/rakelib/multirepo.rake @@ -9,7 +9,7 @@ namespace :multirepo do protocol = ENV['token'] ? "https://#{ENV['token']}@github.com/" : 'git@github.com:' @content_map.each do |subrepo| repo_url = protocol + subrepo['repository'] + '.git' - add_subrepo(subrepo['directory'], repo_url , subrepo['branch'], subrepo['filter']) + add_subrepo(subrepo['directory'], repo_url, subrepo['branch'], subrepo['filter']) end end @@ -33,7 +33,9 @@ namespace :multirepo do abort 'Provide a directory name for the multirepo docs. Example: dir=src/mftf' unless dir abort "'#{dir}' directory already exists" if Dir.exist? dir - abort 'Provide a repository cloning URL (SSH).Example: repo=git@github.com:magento-devdocs/magento2-functional-testing-framework.git' unless repo + unless repo + abort 'Provide a repository cloning URL (SSH).Example: repo=git@github.com:magento-devdocs/magento2-functional-testing-framework.git' + end abort 'Provide a branch name for the multirepo docs. Example: branch=master' unless branch add_subrepo(dir, repo, branch, filter) @@ -43,9 +45,7 @@ end def add_subrepo(dir, repo, branch, filter) filter_text = filter ? 'some' : 'all' puts "Checking out #{filter_text} files from #{repo} (#{branch} branch) to the #{dir} directory ...".magenta - sh('./scripts/docs-from-code.sh', dir, repo, branch, filter.to_s) do |ok,res| - if !ok - abort "Couldn't checkout files for the #{repo} project".red - end + sh('./scripts/docs-from-code.sh', dir, repo, branch, filter.to_s) do |ok, _res| + abort "Couldn't checkout files for the #{repo} project".red unless ok end end diff --git a/rakelib/symlink.rake b/rakelib/symlink.rake index b224ece6102..1c28b7b2210 100644 --- a/rakelib/symlink.rake +++ b/rakelib/symlink.rake @@ -1,17 +1,24 @@ +# frozen_string_literal: true + namespace :symlink do - desc 'Create a 2.4 symlink from the corresponding 2.3 file. Example: rake symlink:create_from path=src/guides/v2.3/release-notes/packages-cloud.md' task :create_from do path = Pathname.new ENV['path'] - abort "Failed: Provide the path that starts with 'src/guides/v2.3'".red unless path.to_path.start_with? 'src/guides/v2.3' - abort "Failed: Couldn't find the file at the provided path: #{path}\nTip: Use auto-completion to enter the path.".red unless path.exist? + unless path.to_path.start_with? 'src/guides/v2.3' + abort "Failed: Provide the path that starts with 'src/guides/v2.3'".red + end + unless path.exist? + abort "Failed: Couldn't find the file at the provided path: #{path}\nTip: Use auto-completion to enter the path.".red + end new_path = path.sub('/v2.3/', '/v2.4/') puts "Creating the #{new_path} symlink from the #{path} file".magenta - abort "Failed: Couldn't create a symlink, because '#{new_path}' is already there.".red if new_path.exist? || new_path.symlink? + if new_path.exist? || new_path.symlink? + abort "Failed: Couldn't create a symlink, because '#{new_path}' is already there.".red + end new_path.dirname.mkpath relative_path = path.relative_path_from new_path.dirname @@ -24,19 +31,21 @@ namespace :symlink do task :replace_at do path = Pathname.new ENV['path'] - abort "Failed: Provide the path that starts with 'src/guides/v2.4'".red unless path.to_path.start_with? 'src/guides/v2.4' + unless path.to_path.start_with? 'src/guides/v2.4' + abort "Failed: Provide the path that starts with 'src/guides/v2.4'".red + end new_path = path.sub('/v2.4/', '/v2.3/') puts "Replacing the #{new_path} symlink with a copy of the #{path} file".magenta - abort "Failed: The file '#{path}' is not a symlink or missing".red unless path.exist? and path.symlink? + abort "Failed: The file '#{path}' is not a symlink or missing".red unless path.exist? && path.symlink? abort "Failed: Couldn't find the '#{new_path}' file to copy from".red unless path.exist? sh "git rm #{path}" sh "cp #{new_path} #{path}" - + puts "Finished: replaced symlink with file at '#{path}'".green end -end \ No newline at end of file +end diff --git a/rakelib/test.rake b/rakelib/test.rake index 10016ea8f22..dec7365a221 100644 --- a/rakelib/test.rake +++ b/rakelib/test.rake @@ -23,23 +23,21 @@ namespace :test do desc 'Check the existing _site for broken links and report to a separate file' task :links_no_build do - begin - # Write console output (stderr only) to a file. - # Use this if you need to also capture stdout: https://stackoverflow.com/a/2480439 - report = LinkChecker.md_report_path - $stderr.reopen(report, 'w+') + # Write console output (stderr only) to a file. + # Use this if you need to also capture stdout: https://stackoverflow.com/a/2480439 + report = LinkChecker.md_report_path + $stderr.reopen(report, 'w+') - Rake::Task['test:html'].invoke + Rake::Task['test:html'].invoke - # We're expecting link validation errors, but unless we rescue from - # StandardError, rake will abort and won't run the convert task (https://stackoverflow.com/a/10048406). - # Wrapping task in a begin-rescue block prevent rake from aborting. - # Seems to prevent printing an error count though. - rescue StandardError => e - # Show how many lines contains the Markdown report - puts e.to_s.red - puts "To see the report, open the #{report} file.".red - end + # We're expecting link validation errors, but unless we rescue from + # StandardError, rake will abort and won't run the convert task (https://stackoverflow.com/a/10048406). + # Wrapping task in a begin-rescue block prevent rake from aborting. + # Seems to prevent printing an error count though. + rescue StandardError => e + # Show how many lines contains the Markdown report + puts e.to_s.red + puts "To see the report, open the #{report} file.".red end desc 'Report about broken links in HTML' @@ -61,7 +59,7 @@ namespace :test do --git-recurse \ -- .` puts output.yellow - abort "Fix the reported issues".red unless output.empty? + abort 'Fix the reported issues'.red unless output.empty? puts 'No issues found'.green end end diff --git a/rakelib/update.rake b/rakelib/update.rake index 49cadbe57e4..10503bc8889 100644 --- a/rakelib/update.rake +++ b/rakelib/update.rake @@ -57,11 +57,14 @@ namespace :update do end def update_dir(dir) - abort "Cannot find the #{dir} directory. You can run 'rake init' to create it and rerun 'rake update:all' again.".red unless Dir.exist? dir + unless Dir.exist? dir + abort "Cannot find the #{dir} directory. You can run 'rake init' to create it and rerun 'rake update:all' again.".red + end Dir.chdir dir do puts "Updating #{dir}:".magenta - next warn "No branch to update" if `git status -sb`.include? 'no branch' + next warn 'No branch to update' if `git status -sb`.include? 'no branch' + sh 'git remote -v' sh 'git pull --no-recurse-submodules' sh 'git status -sb' diff --git a/src/_includes/backward-incompatible-changes/commerce/2.2.10-2.2.11.md b/src/_includes/backward-incompatible-changes/commerce/2.2.10-2.2.11.md index 8b137891791..e69de29bb2d 100644 --- a/src/_includes/backward-incompatible-changes/commerce/2.2.10-2.2.11.md +++ b/src/_includes/backward-incompatible-changes/commerce/2.2.10-2.2.11.md @@ -1 +0,0 @@ - diff --git a/src/_includes/backward-incompatible-changes/open-source/2.1.0-2.3.0.md b/src/_includes/backward-incompatible-changes/open-source/2.1.0-2.3.0.md index ced73c4bc9b..96c97b1b27a 100644 --- a/src/_includes/backward-incompatible-changes/open-source/2.1.0-2.3.0.md +++ b/src/_includes/backward-incompatible-changes/open-source/2.1.0-2.3.0.md @@ -3058,4 +3058,3 @@ | Magento\AdvancedSearch\Model\Client\ClientInterface | Interface was added. | | Magento\AdvancedSearch\Model\Client\ClientOptionsInterface | Interface was added. | | Magento\AdvancedSearch\Model\Adapter\DataMapper\AdditionalFieldsProviderInterface | Interface was added. | - diff --git a/src/_includes/backward-incompatible-changes/open-source/2.3.2-2.3.3.md b/src/_includes/backward-incompatible-changes/open-source/2.3.2-2.3.3.md index f32c5be5e01..df3412a99eb 100644 --- a/src/_includes/backward-incompatible-changes/open-source/2.3.2-2.3.3.md +++ b/src/_includes/backward-incompatible-changes/open-source/2.3.2-2.3.3.md @@ -50,4 +50,3 @@ | What changed | How it changed | | --- | --- | | Magento\Vault\Api\PaymentTokenManagementInterface::getListByCustomerId | [public] Method return typing changed. | - diff --git a/src/_includes/config/message-queue-consumers.md b/src/_includes/config/message-queue-consumers.md index 2b55140b3eb..a0d8891abfb 100644 --- a/src/_includes/config/message-queue-consumers.md +++ b/src/_includes/config/message-queue-consumers.md @@ -21,4 +21,3 @@ bin/magento queue:consumers:start & ``` See [queue:consumers:start]({{ page.baseurl }}/reference/cli/magento-commerce.html#queueconsumersstart) in the _Magento command-line reference_ for details about the command options, parameters, and values. - diff --git a/src/_includes/config/split-deploy/split-deploy-overview.md b/src/_includes/config/split-deploy/split-deploy-overview.md index ae050368bb6..f615a0b2403 100644 --- a/src/_includes/config/split-deploy/split-deploy-overview.md +++ b/src/_includes/config/split-deploy/split-deploy-overview.md @@ -24,13 +24,13 @@ Staging system Production system : Your live store. You should make minimal configuration changes here and no changes to: - - websites - - stores - - store views - - products - - product view settings - - catalog - - categories - - category view settings. +- websites +- stores +- store views +- products +- product view settings +- catalog +- categories +- category view settings. You should make all those types of changes in your development system. diff --git a/src/_includes/install/get-help.md b/src/_includes/install/get-help.md index 5cce8d88b94..f11d9ef5c86 100644 --- a/src/_includes/install/get-help.md +++ b/src/_includes/install/get-help.md @@ -7,4 +7,3 @@ In the event you need additional help, consult the following resources. |{{site.data.var.ce}} and {{site.data.var.ee}}|- [Magento support forums](http://community.magento.com/)
- [stack Exchange](http://magento.stackexchange.com)
- [Twitter](https://twitter.com/magento)| |{{site.data.var.ce}}|[Submit bug reports](http://www.magentocommerce.com/bug-tracking)| |{{site.data.var.ee}} only|[Submit bug reports](http://support.magentocommerce.com)| - diff --git a/src/_includes/install/php-extensions-template.md b/src/_includes/install/php-extensions-template.md index f40ac005df7..8236a5be1e1 100644 --- a/src/_includes/install/php-extensions-template.md +++ b/src/_includes/install/php-extensions-template.md @@ -2,6 +2,7 @@ {% for item in product.require %} {% if item[0] contains 'ext-' %} -* {{ item[0] }} + +* {{ item[0] }} {% endif %} {% endfor %} diff --git a/src/_includes/install/sampledata/sample-data-composer.md b/src/_includes/install/sampledata/sample-data-composer.md index 4d640d12ee4..4cbab0efa59 100644 --- a/src/_includes/install/sampledata/sample-data-composer.md +++ b/src/_includes/install/sampledata/sample-data-composer.md @@ -4,6 +4,7 @@ This section discusses how to install sample data if you got the Magento softwar * Downloaded a compressed archive from [Magento](https://magento.com/tech-resources/download). If you downloaded an archive from GitHub, this method won't work because the `composer.json` file doesn't contain the `repo.magento.com` URL. + * Used `composer create-project` You can use this method of getting sample data for both {{site.data.var.ce}} or {{site.data.var.ee}}, but you must use the same [authentication keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html) you used to install Magento. diff --git a/src/_includes/reference/cli-template.md b/src/_includes/reference/cli-template.md index 9556b22b420..f69d07262a0 100644 --- a/src/_includes/reference/cli-template.md +++ b/src/_includes/reference/cli-template.md @@ -57,6 +57,7 @@ This reference is generated from the Magento codebase. To change the content, yo {% unless item.default == nil %} {% if item.default == false or (item.default == empty and item.default != '') %} + - Default: `{{ item.default | inspect }}` {% else %} - Default: `{{ item.default }}` @@ -94,6 +95,7 @@ This reference is generated from the Magento codebase. To change the content, yo {% unless opt.default == nil %} {% if opt.default == false or opt.default == empty and opt.default != '' %} + - Default: `{{ opt.default | inspect }}` {% else %} - Default: `{{ opt.default }}` diff --git a/src/_includes/release-notes/engcomm-2-2-10-issues.md b/src/_includes/release-notes/engcomm-2-2-10-issues.md index 1f467d82901..85db0057720 100644 --- a/src/_includes/release-notes/engcomm-2-2-10-issues.md +++ b/src/_includes/release-notes/engcomm-2-2-10-issues.md @@ -56,4 +56,3 @@ | LouNik1984 | [16446](https://github.com/magento/magento2/issues/16446) | [22510](https://github.com/magento/magento2/pull/22510) | | ffauvel | [23643](https://github.com/magento/magento2/issues/23643) | [23650](https://github.com/magento/magento2/pull/23650) | | hostep | [11615](https://github.com/magento/magento2/issues/11615) | [14344](https://github.com/magento/magento2/pull/14344) | - diff --git a/src/_includes/release-notes/engcomm-2-3-0-partner.md b/src/_includes/release-notes/engcomm-2-3-0-partner.md index 14d77bec715..155e833d3cb 100644 --- a/src/_includes/release-notes/engcomm-2-3-0-partner.md +++ b/src/_includes/release-notes/engcomm-2-3-0-partner.md @@ -48,4 +48,3 @@ | Perficient | [15607](https://github.com/magento/magento2/pull/15607) | [15469](https://github.com/magento/magento2/issues/15469) | | CoolBlueWeb | [10627](https://github.com/magento/magento2/pull/10627) | [9533](https://github.com/magento/magento2/issues/9533) | | Limesharp | [94](https://github.com/magento/graphql-ce/pull/94) | [80](https://github.com/magento/graphql-ce/issues/80) | - diff --git a/src/cloud/deploy/continuous-deployment.md b/src/cloud/deploy/continuous-deployment.md index 3616e8e9e27..43b61b78322 100644 --- a/src/cloud/deploy/continuous-deployment.md +++ b/src/cloud/deploy/continuous-deployment.md @@ -48,4 +48,3 @@ We recommend the following best practices for {{site.data.var.ece}} environments * Create a backup of your database and snapshot on a schedule or before pushing major updates. We provide snapshots of the Pro Production environment according to a [progressive schedule]({{ site.baseurl }}/cloud/architecture/pro-architecture.html#backup-and-disaster-recovery), but you may need to backup your Staging environment for constant iterations. * Pull a data dump of your Production data into the Staging environment for extensive testing * Consider running scripts or pulling only specific tables to sanitize customer data from non-Production environments Staging - diff --git a/src/cloud/docker/docker-manage-database.md b/src/cloud/docker/docker-manage-database.md index 7f56833f592..5624dc53ae2 100644 --- a/src/cloud/docker/docker-manage-database.md +++ b/src/cloud/docker/docker-manage-database.md @@ -196,4 +196,3 @@ See [Docker service containers][Docker database container] for details about the [Docker database container]: https://devdocs.magento.com/cloud/docker/docker-containers-service.html#database-container [mysqldump]: https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html [Service configuration options]: {{ site.baseurl }}/cloud/docker/docker-containers.html#service-configuration-options - diff --git a/src/cloud/release-notes/cloud-release-archive.md b/src/cloud/release-notes/cloud-release-archive.md index cbaf6ae2107..2162ac24316 100644 --- a/src/cloud/release-notes/cloud-release-archive.md +++ b/src/cloud/release-notes/cloud-release-archive.md @@ -416,7 +416,7 @@ The `{{site.data.var.ct}}` version 2002.0.17 includes an important security patc - Added the [DATABASE_CONFIGURATION]({{ site.baseurl }}/cloud/env/variables-deploy.html#database_configuration) environment variable to customize your database connections for deployment. - The new [MIN_LOGGING_LEVEL]({{ site.baseurl }}/cloud/env/variables-global.html#min_logging_level) variable overrides the minimum logging level for all output streams without making changes to the code. -- {:.fix}Fixed an issue that caused downtime between the deploy and post-deploy phase. Now, the post_deploy phase begins _immediately_ after the deploy phase ends. +- {:.fix}Fixed an issue that caused downtime between the deploy and post-deploy phase. Now, the post-deploy phase begins _immediately_ after the deploy phase ends. - {:.fix}Fixed an issue that did not clean the successful cron jobs, those with `status = success`, from the schedule. @@ -459,10 +459,10 @@ The ece-tools version 2002.0.11 is required for 2.2.4 compatibility. - {:.fix}**SCD-specific improvements**— - - You can use the `VERBOSE_COMMANDS` and the `SCD_COMPRESSION_LEVEL` environment variables during both _build_ and _deploy_ phases. + - You can use the `VERBOSE_COMMANDS` and the `SCD_COMPRESSION_LEVEL` environment variables during both *build* and *deploy* phases. - Fixed an issue that caused deployment to fail with a random error when encountering an unexpected value for the `SCD_COMPRESSION_LEVEL` environment variable. Improved the configuration validation to provide meaningful notifications. See [`SCD_COMPRESSION_LEVEL`]({{ site.baseurl }}/cloud/env/variables-build.html#scd_compression_level) for acceptable values. - Fixed the behavior of the `SCD_COMPRESSION_LEVEL` environment variable configuration flow so the overrides work as expected. - - Fixed an issue that prevented the configuration of the `SCD_THREADS` environment variable in the `.magento.env.yaml` file _deploy_ stage. + - Fixed an issue that prevented the configuration of the `SCD_THREADS` environment variable in the `.magento.env.yaml` file *deploy* stage. ## v2002.0.10 @@ -470,7 +470,7 @@ The ece-tools version 2002.0.11 is required for 2.2.4 compatibility. - **New environment variable**—Added the `SCD_ON_DEMAND` global environment variable to generate static content when requested. - - **Post-deploy hook**—Added a `post_deploy` hook for the `.magento.app.yaml` file that clears the cache and pre-loads (warms) the cache _after_ the container begins accepting connections. It is available only for Pro projects that contain Staging and Production environments in the Project Web Interface and for Starter projects. Although not required, this works in tandem with the `SCD_ON_DEMAND` environment variable. + - **Post-deploy hook**—Added a `post_deploy` hook for the `.magento.app.yaml` file that clears the cache and pre-loads (warms) the cache *after* the container begins accepting connections. It is available only for Pro projects that contain Staging and Production environments in the Project Web Interface and for Starter projects. Although not required, this works in tandem with the `SCD_ON_DEMAND` environment variable. - {:.new}**Optimization**—Optimized moving or copying files during deployment to improve deployment speed and decrease loads on the file system. diff --git a/src/guides/v2.3/b2b/credit-manage.md b/src/guides/v2.3/b2b/credit-manage.md index 33913989803..8af2bbc11c2 100644 --- a/src/guides/v2.3/b2b/credit-manage.md +++ b/src/guides/v2.3/b2b/credit-manage.md @@ -295,7 +295,8 @@ A Reimburse transaction can be updated to include a purchase order and comment. `companyCreditCreditHistoryManagementV1` **REST Endpoints:** -``` + +```text GET /V1/companyCredits/history PUT /V1/companyCredits/history/:historyId ``` diff --git a/src/guides/v2.3/coding-standards/docblock-standard-javascript.md b/src/guides/v2.3/coding-standards/docblock-standard-javascript.md index 8a710dc8056..904da3a16f1 100644 --- a/src/guides/v2.3/coding-standards/docblock-standard-javascript.md +++ b/src/guides/v2.3/coding-standards/docblock-standard-javascript.md @@ -414,14 +414,14 @@ So the key will always be a string in for...in loops. But the compiler will veri Function
function(x, y) {
-   return x * y;
+   return x * y;
 }
Function object function(number, number): number
function(x, y) {
-   return x * y;
+   return x * y;
 }
function value diff --git a/src/guides/v2.3/comp-mgr/prereq/prereq_cron.md b/src/guides/v2.3/comp-mgr/prereq/prereq_cron.md index 38b3d470db2..fd6a58f9b35 100644 --- a/src/guides/v2.3/comp-mgr/prereq/prereq_cron.md +++ b/src/guides/v2.3/comp-mgr/prereq/prereq_cron.md @@ -18,4 +18,3 @@ The cron jobs schedule tasks for the Setup Wizard and for the updater applicatio {% include config/setup-cron_2.2_how-to.md %} For more information about cron, including how to remove a crontab and run cron from the command line, see [Configure and run cron]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-cron.html). - diff --git a/src/guides/v2.3/comp-mgr/upgrader/upgrade-backup.md b/src/guides/v2.3/comp-mgr/upgrader/upgrade-backup.md index 245f8468235..ac316b1caea 100644 --- a/src/guides/v2.3/comp-mgr/upgrader/upgrade-backup.md +++ b/src/guides/v2.3/comp-mgr/upgrader/upgrade-backup.md @@ -15,4 +15,3 @@ functional_areas: Related topics After your backup is complete, continue with [Step 4. Upgrade]({{ page.baseurl }}/comp-mgr/upgrader/upgrade.html). - diff --git a/src/guides/v2.3/comp-mgr/upgrader/upgrade-checklist.md b/src/guides/v2.3/comp-mgr/upgrader/upgrade-checklist.md index 701074af867..b7dbf4d4f68 100644 --- a/src/guides/v2.3/comp-mgr/upgrader/upgrade-checklist.md +++ b/src/guides/v2.3/comp-mgr/upgrader/upgrade-checklist.md @@ -29,9 +29,10 @@ _System upgrade_ refers to updating the Magento 2.x core components and other in {:.bs-callout-warning} * Authorization keys from a [shared account](http://docs.magento.com/m2/ce/user_guide/magento/magento-account-share.html) _cannot_ be used for upgrade. You must get your authorization keys from `magento.com` account owner. -* If you installed the Magento application by [cloning the GitHub repository]({{ page.baseurl }}/install-gde/prereq/dev_install.html), you _cannot_ use the System Upgrade utility to upgrade the software. Instead, you must [update it manually]({{ page.baseurl }}/install-gde/install/cli/dev_options.html). +* If you installed the Magento application by [cloning the GitHub repository]({{ page.baseurl }}/install-gde/prereq/dev_install.html), you *cannot* use the System Upgrade utility to upgrade the software. Instead, you must [update it manually]({{ page.baseurl }}/install-gde/install/cli/dev_options.html). ## System Upgrade checklist + {% include comp-man/checklist_2.2.md %} {:.ref-header} diff --git a/src/guides/v2.3/comp-mgr/upgrader/upgrade-readiness.md b/src/guides/v2.3/comp-mgr/upgrader/upgrade-readiness.md index 9c491b516c9..b4bf5e01930 100644 --- a/src/guides/v2.3/comp-mgr/upgrader/upgrade-readiness.md +++ b/src/guides/v2.3/comp-mgr/upgrader/upgrade-readiness.md @@ -18,4 +18,3 @@ To start, click either **Start Readiness Check** or **Next** on the System Upgra ![The readiness check enables you to find out if your server and environment are ready to proceed]({{ site.baseurl }}/common/images/upgr_readiness.png) {% include comp-man/readiness-check.md %} - diff --git a/src/guides/v2.3/config-guide/cli/config-cli-subcommands-perf-data.md b/src/guides/v2.3/config-guide/cli/config-cli-subcommands-perf-data.md index 2ece9b4d4ef..fe34c505674 100644 --- a/src/guides/v2.3/config-guide/cli/config-cli-subcommands-perf-data.md +++ b/src/guides/v2.3/config-guide/cli/config-cli-subcommands-perf-data.md @@ -29,139 +29,23 @@ Profiles are located in `/setup/performance-toolkit/profiles/ - - - Parameter - Small profile - Medium profile - Medium multi-site profile - Large profile - Extra large profile - - - -

websites

-

1

-

3

-

25

-

5

-

5

- - -

store_groups

-

1

-

3

-

25

-

5

-

5

- - -

store_views

-

1

-

3

-

50

-

5

-

5

- - -

simple_products

-

800

-

24,000

-

4,000

-

300,000

-

600,000

- - -

configurable_products

-

16 with 24 options

-

640 with 24 options

-

800 with 24 options & 79 with 200 options

-

8,000 with 24 options

-

16,000 with 24 options

- - -

product_images

-

100 images / 3 images per product

-

1000 images / 3 images per product

-

1000 images / 3 images per product

-

2000 images / 3 images per product

-

2000 images / 3 images per product

- - -

categories

-

30

-

300

-

100

-

3,000

-

6,000

- - -

categories_nesting_level

-

3

-

3

-

3

-

5

-

5

- - -

catalog_price_rules

-

20

-

20

-

20

-

20

-

20

- - -

catalog_target_rules

-

5

-

5

-

5

-

5

-

5

- - -

cart_price_rules

-

20

-

20

-

20

-

20

-

20

- - -

cart_price_rules_floor

-

2

-

2

-

2

-

2

-

2

- - -

customers

-

200

-

2,000

-

2,000

-

5,000

-

10,000

- - -

tax rates

-

130

-

40,000

-

40,000

-

40,000

-

40,000

- - -

orders

-

80

-

50,000

-

50,000

-

100,000

-

150,000

- - - +| Parameter | Small profile | Medium profile | Medium multi-site profile | Large profile | Extra large profile | +| --- | --- | --- | --- | --- | --- | +| `websites` | 1 | 3 | 25 | 5 | 5 | +| `store_groups` | 1 | 3 | 25 | 5 | 5 | +| `store_views` | 1 | 3 | 50 | 5 | 5 | +| `simple_products` | 800 | 24,000 | 4,000 | 300,000 | 600,000 | +| `configurable_products` | 16 with 24 options | 640 with 24 options | 800 with 24 options & 79 with 200 options | 8,000 with 24 options | 16,000 with 24 options | +| `product_images` | 100 images / 3 images per product | 1000 images / 3 images per product | 1000 images / 3 images per product | 2000 images / 3 images per product | 2000 images / 3 images per product | +| `categories` | 30 | 300 | 100 | 3,000 | 6,000 | +| `categories_nesting_level` | 3 | 3 | 3 | 5 | 5 | +| `catalog_price_rules` | 20 | 20 | 20 | 20 | 20 | +| `catalog_target_rules` | 5 | 5 | 5 | 5 | 5 | +| `cart_price_rules` | 20 | 20 | 20 | 20 | 20 | +| `cart_price_rules_floor` | 2 | 2 | 2 | 2 | 2 | +| `customers` | 200 | 2,000 | 2,000 | 5,000 | 10,000 | +| `tax rates` | 130 | 40,000 | 40,000 | 40,000 | 40,000 | +| `orders` | 80 | 50,000 | 50,000 | 100,000 | 150,000 | ### Run the data generator {#config-cli-perf-run} @@ -241,21 +125,25 @@ The following sections discuss additional details about the performance fixtures Generates [admin](https://glossary.magento.com/admin) users. [XML](https://glossary.magento.com/xml) profile node: -
<!-- Number of admin users -->
-<admin_users>{int}
+```xml + +{int} +``` ### Attribute sets {#config-cli-gen-attrib} Generates attribute sets with specified configuration. XML profile node: -
<!-- Number of product attribute sets -->
-<product_attribute_sets>{int}</product_attribute_sets>
+```xml
+
+{int}
 
-<!-- Number of attributes per set -->
-<product_attribute_sets_attributes>{int}</product_attribute_sets_attributes>
+
+{int}
 
- <!-- Number of values per attribute -->
-<product_attribute_sets_attributes_values>{int}</product_attribute_sets_attributes_values>
+ +{int} +``` ### Bundle products {#config-cli-gen-bundle} @@ -263,31 +151,37 @@ Generates bundle products. Generated bundle selections are not displayed individ XML profile node: -
<!-- Number of products -->
-<bundle_products>{int}</bundle_products>
+```xml
+
+{int}
 
-<!-- Number of options per each product -->
-<bundle_products_options>{int}</bundle_products_options>
+
+{int}
 
-<!-- Number of simple products per each option -->
-<bundle_products_variation>{int}</bundle_products_variation>
+ +{int} +``` ### Cart price rules {#config-cli-gen-cartrules} Generates cart price rules. XML profile node: -
<!-- Number of cart price rules -->
-<cart_price_rules>{int}</cart_price_rules>
+```xml
+
+{int}
 
-<!-- Number of conditions per rule -->
-<cart_price_rules_floor>{int}</cart_price_rules_floor>
+ +{int} +``` ### Catalog price rules {#config-cli-gen-pricerules} Generates catalog price rules. XML profile node: -
<!-- Number of catalog price rules -->
-<catalog_price_rules>{int}</catalog_price_rules>
+```xml + +{int} +``` ### Categories {#config-cli-gen-cat} @@ -295,27 +189,31 @@ Generates categories. If `assign_entities_to_all_websites` is set to `0`, all ca XML profile node: -
<!-- Number of categories to generate -->
-<categories>{int}</categories>
+```xml
+
+{int}
 
-<!-- Nesting level of categories -->
-<categories_nesting_level>{int}</categories_nesting_level>
+ +{int} +``` ### Configs {#config-cli-gen-config} Sets values for config fields. XML profile node: -
<!-- Config variables and values for change -->
-    <configs>
-        <config>
-            <path>{string}</path> <!-- e.g. admin/security/use_form_key -->
-            <scope>{string}</scope> <!-- e.g. default -->
-            <scopeId>{int}</scopeId>
-            <value>{int|string}</value>
-        </config>
-
-        <!-- ... more entries ... -->
-    </configs>
+```xml + + + + {string} + {string} + {int} + {int|string} + + + + +``` ### Configurable products {#config-cli-gen-configprod} @@ -325,94 +223,102 @@ We support the following XML node formats: * Distribution per Default and pre-defined attribute sets: -
<!-- Number of configurable products -->
-    <configurable_products>{int}</configurable_products>
+```xml + +{int} +``` * Generate products based on an existing attribute set: -
<configurable_products>
-        
-        <config>
-             <!-- Existing attribute set name -->
-             <attributeSet>{string}</attributeSet>
+```xml
+
+
+    
+            
+            {string}
 
-             <!-- Configurable sku pattern with %s -->
-             <sku>{string}</sku>
+            
+            {string}
 
-             <!-- Number of configurable products -->
-             <products>{int}</products>
+            
+            {int}
 
-             <!-- Category Name. Optional. By default category name from Categories fixture will be used -->
-             <category>[{string}]</category>
+            
+            [{string}]
 
-             <!-- Type of Swatch attribute e.g. color|image -->
-             <swatches>{string}</swatches>
-        </config>
+            
+            {string}
+    
 
-        <!-- ... more entries ... -->
-    </configurable_products>
+ + +``` * Generate products based on a dynamically created [attribute set](https://glossary.magento.com/attribute-set) with a specified amount of attributes and options: -
<configurable_products>
-        
-        <config>
-            <!-- Number of attributes in configurable product -->
-            <attributes>{int}</attributes>
+```xml
+
+
+    
+        
+        {int}
 
-            <!-- Number of options per attribute -->
-            <options>{int}</options>
+        
+        {int}
 
-            <!-- Configurable sku pattern with %s -->
-            <sku>{string}</sku>
+        
+        {string}
 
-            <!-- Number of configurable products -->
-            <products>{int}</products>
+        
+        {int}
 
-            <!-- Category Name. Optional. By default category name from Categories fixture will be used -->
-            <category>[{string}]</category>
+        
+        [{string}]
 
-            <!-- Type of Swatch attribute e.g. color|image -->
-            <swatches>{string}</swatches>
-        </config>
+        
+        {string}
+    
 
-        <!-- ... more entries ... -->
-    </configurable_products>
+ + +``` * Generate products based on a dynamically created attribute set with a specified configuration per each attribute: -
<configurable_products>
-        
-        <config>
-            <attributes>
-                <!-- Configuration for a first attribute -->
-                <attribute>
-                    <!-- Amount of options per attribute -->
-                    <options>{int}</options>
+```xml
+
 
-                    <!-- Type of Swatch attribute -->
-                    <swatches>{string}</swatches>
-                </attribute>
+    
+        
+            
+            
+                
+                {int}
 
-                <!-- Configuration for a second attribute -->
-                <attribute>
-                    <!-- Amount of options per attribute -->
-                    <options>{int}</options>
-                </attribute>
-            </attributes>
+                
+                {string}
+            
 
-            <!-- Configurable sku pattern with %s -->
-            <sku>{string}</sku>
+            
+            
+                
+                {int}
+            
+        
 
-            <!-- Number of configurable products -->
-            <products>{int}</products>
+        
+        {string}
 
-            <!-- Category Name. Optional. By default, the category name from Categories fixture will be used -->
-            <category>[{string}]</category>
-        </config>
+        
+        {int}
 
-        <!-- ... more entries ... -->
-    </configurable_products>
+ + [{string}] + + + + +``` ### Customers {#config-cli-gen-cust} @@ -420,15 +326,19 @@ Generates customers. Customers have a normal distribution on all available websi XML profile node: -
<!-- Number of customers to generate -->
-<customers>{int}</customers>
+```xml + +{int} +``` You can also use the following XML to change the customer configuration: -
<customer-config>
-    <!-- Number of addresses per each customer -->
-    <addresses-count>{int}</addresses-count>
-</customer-config>
+```xml + + + {int} + +``` ### Product images {#config-cli-gen-prodimg} @@ -436,23 +346,27 @@ Generates product images. Generation does not include resizing. XML profile node: -
<product-images>
-    <!-- Number of images to generate -->
-    <images-count>{int}</images-count>
+```xml
+
+    
+    {int}
 
-    <!-- Number of images to be assigned per each product -->
-    <images-per-product>{int}</images-per-product>
-</product-images>
+ + {int} + +``` ### Indexers state {#config-cli-gen-index} Updates indexers' state. XML profile node: -
<indexer>
-    <!-- Name of indexer (e.g. catalogrule_product) -->
-    <id>{string}</id>
-    <set_scheduled>{bool}</set_scheduled>
-</indexer>
+```xml + + + {string} + {bool} + +``` ### Orders {#config-cli-gen-orders} @@ -460,29 +374,31 @@ Generates orders with configurable number of different types of order items. Opt XML profile node: -
<!-- It is necessary to enable quotes for orders -->
-<order_quotes_enable>{bool}</order_quotes_enable>
+```xml
+
+{bool}
 
-<!-- Min number of simple products per each order -->
-<order_simple_product_count_from>{int}</order_simple_product_count_from>
+
+{int}
 
-<!-- Max number of simple products per each order -->
-<order_simple_product_count_to>{int}</order_simple_product_count_to>
+
+{int}
 
-<!-- Min number of configurable products per each order -->
-<order_configurable_product_count_from>{int}</order_configurable_product_count_from>
+
+{int}
 
-<!-- Max number of configurable products per each order -->
-<order_configurable_product_count_to>{int}</order_configurable_product_count_to>
+
+{int}
 
-<!-- Min number of big configurable products (with big amount of options) per each order -->
-<order_big_configurable_product_count_from>{int}</order_big_configurable_product_count_from>
+
+{int}
 
-<!-- Max number of big configurable products (with big amount of options) per each order -->
-<order_big_configurable_product_count_to>{int}</order_big_configurable_product_count_to>
+
+{int}
 
-<!-- Number of orders to generate -->
-<orders>{int}</orders>
+ +{int} +``` ### Simple products {#config-cli-gen-simp} @@ -492,15 +408,19 @@ Products are uniformly distributed per categories and websites. If `assign_entit XML profile node: -
<!-- Number of simple products to generate -->
-<simple_products>{int}</simple_products>
+```xml + +{int} +``` ### Websites {#config-cli-gen-websites} Generates websites. XML profile node: -
<!-- Number of websites to be generated -->
-<websites>{int}</websites>
+```xml + +{int} +``` ### Store groups {#config-cli-gen-stores} @@ -508,25 +428,31 @@ Generates store groups (referred to in the [Magento Admin](https://glossary.mage XML profile node: -
<!-- Number of store groups to be generated -->
-<store_groups>{int}</store_groups>
+```xml + +{int} +``` ### Store views {#config-cli-gen-storeview} Generates store views. Store views are distributed normally among store groups. XML profile node: -
<!-- Number of store views to be generated -->
-<store_views>{int}</store_views>
+```xml
+
+{int}
 
-<!-- 1 means that all stores will have the same root category, 0 means that all stores will have unique root category -->
-<assign_entities_to_all_websites>{0|1}<assign_entities_to_all_websites/>
+ +{0|1} +``` ### Tax rates {#config-cli-gen-taxrate} Generates tax rates. XML profile node: -
<!-- Accepts name of [csv](https://glossary.magento.com/csv) file with tax rates (<path to magento folder>/setup/src/Magento/Setup/Fixtures/_files) -->
-<tax_rates_file>{csv file name}</tax_rates_file>
+```xml + +{csv file name} +``` ## Additional information diff --git a/src/guides/v2.3/design-styleguide/color/color.md b/src/guides/v2.3/design-styleguide/color/color.md index a08bfec4afc..a272ccd31cf 100644 --- a/src/guides/v2.3/design-styleguide/color/color.md +++ b/src/guides/v2.3/design-styleguide/color/color.md @@ -10,4 +10,3 @@ menu_node: Our color palette reflects our brand personality. It meets accessibility standards and provides clear legibility, hierarchy, navigation, and messaging. ![](img/ColorPalette.jpg) - diff --git a/src/guides/v2.3/design-styleguide/typography/typography.md b/src/guides/v2.3/design-styleguide/typography/typography.md index ce4200a52d9..f75abbd4a75 100644 --- a/src/guides/v2.3/design-styleguide/typography/typography.md +++ b/src/guides/v2.3/design-styleguide/typography/typography.md @@ -11,13 +11,11 @@ Typography is used to establish page hierarchy. ## Heading Types -
- -# H1 - Page title +### H1 - Page title Page titles use Open Sans font, regular weight, 28px font size, and 34px line height. -## H2 - Section heading +### H2 - Section heading Section headings use Open Sans font, regular weight, 20px font size, and 25px line height. diff --git a/src/guides/v2.3/extension-dev-guide/cache/partial-caching/database-caching.md b/src/guides/v2.3/extension-dev-guide/cache/partial-caching/database-caching.md index 3b3f5759bf8..381b5288a8d 100644 --- a/src/guides/v2.3/extension-dev-guide/cache/partial-caching/database-caching.md +++ b/src/guides/v2.3/extension-dev-guide/cache/partial-caching/database-caching.md @@ -162,6 +162,7 @@ Use the following steps: 1. In a web browser, go to any cacheable page (such as the [storefront](https://glossary.magento.com/storefront) front door page). If exceptions display, verify `di.xml` syntax and try again. (To see exceptions in the browser, you must [enable developer mode].) + 1. Enter the following commands: ```bash diff --git a/src/guides/v2.3/extension-dev-guide/cli-cmds/cli-add.md b/src/guides/v2.3/extension-dev-guide/cli-cmds/cli-add.md index 1410e967d37..a02a30f7ec1 100644 --- a/src/guides/v2.3/extension-dev-guide/cli-cmds/cli-add.md +++ b/src/guides/v2.3/extension-dev-guide/cli-cmds/cli-add.md @@ -12,4 +12,3 @@ Your [module](https://glossary.magento.com/module) can optionally use Magento 2' * [Command naming guidelines]({{ page.baseurl }}/extension-dev-guide/cli-cmds/cli-naming-guidelines.html) * [How to add CLI commands]({{ page.baseurl }}/extension-dev-guide/cli-cmds/cli-howto.html) * [List of Magento CLI commands]({{ page.baseurl }}/reference/cli/magento.html) - diff --git a/src/guides/v2.3/extension-dev-guide/service-contracts/service-to-web-service.md b/src/guides/v2.3/extension-dev-guide/service-contracts/service-to-web-service.md index 8d63f4b04fa..300f4a92297 100644 --- a/src/guides/v2.3/extension-dev-guide/service-contracts/service-to-web-service.md +++ b/src/guides/v2.3/extension-dev-guide/service-contracts/service-to-web-service.md @@ -175,7 +175,6 @@ To define web API components, set these attributes on these XML elements in the Note:The Magento web API framework enables guest users to access resources that are configured with `anonymous` permission. Any user that the framework cannot authenticate through existing authentication mechanisms is considered a guest user. - diff --git a/src/guides/v2.3/extension-dev-guide/xss-protection.md b/src/guides/v2.3/extension-dev-guide/xss-protection.md index cfbbf6f1830..416ed727e8f 100644 --- a/src/guides/v2.3/extension-dev-guide/xss-protection.md +++ b/src/guides/v2.3/extension-dev-guide/xss-protection.md @@ -190,9 +190,9 @@ This sniff finds all _echo_ calls in PHTML-templates and determines if the outpu It covers the following cases: -- /_ @noEscape _/ before output. Output does not require escaping. Test is green. +- `/_ @noEscape _/` before output. Output does not require escaping. Test is green. -- /_ @escapeNotVerified _/ before output. Output escaping is not checked and should be verified. Test is green. +- `/_ @escapeNotVerified _/` before output. Output escaping is not checked and should be verified. Test is green. - Methods which contain "html" in their names (for example echo $object->{suffix}Html{postfix}()). Data is ready for the HTML output. Test is green. diff --git a/src/guides/v2.3/frontend-dev-guide/bk-frontend-dev-guide.md b/src/guides/v2.3/frontend-dev-guide/bk-frontend-dev-guide.md index 3d036c12dae..9f6844e7ce7 100644 --- a/src/guides/v2.3/frontend-dev-guide/bk-frontend-dev-guide.md +++ b/src/guides/v2.3/frontend-dev-guide/bk-frontend-dev-guide.md @@ -68,4 +68,3 @@ Related topics * [JavaScript coding standard]({{ page.baseurl }}/coding-standards/code-standard-javascript.html) * [Responsive web design]({{ page.baseurl }}/frontend-dev-guide/responsive-web-design/rwd_overview.html) * [Translations]({{ page.baseurl }}/frontend-dev-guide/translations/xlate.html) - diff --git a/src/guides/v2.3/frontend-dev-guide/css-topics/css-jquery.md b/src/guides/v2.3/frontend-dev-guide/css-topics/css-jquery.md index 142d3499726..de2d5dae2bd 100644 --- a/src/guides/v2.3/frontend-dev-guide/css-topics/css-jquery.md +++ b/src/guides/v2.3/frontend-dev-guide/css-topics/css-jquery.md @@ -21,4 +21,3 @@ To use the jQuery styles, you need to define those which you need in your custom - [Define what styles you need to change]({{ page.baseurl }}/frontend-dev-guide/themes/debug-theme.html#debug-theme-style) - [Quick start guide to working with styles for a new theme]({{ page.baseurl }}/frontend-dev-guide/css-guide/css_quick_guide_overview.html) - diff --git a/src/guides/v2.3/frontend-dev-guide/css-topics/theme-ui-lib.md b/src/guides/v2.3/frontend-dev-guide/css-topics/theme-ui-lib.md index 5c867f942ff..8b34aee29cf 100644 --- a/src/guides/v2.3/frontend-dev-guide/css-topics/theme-ui-lib.md +++ b/src/guides/v2.3/frontend-dev-guide/css-topics/theme-ui-lib.md @@ -250,4 +250,3 @@ The generated Magento UI library documentation is provided in a convenient [HTML [ui_lib1.png]: {{ site.baseurl }}/common/images/ui_lib1.png [ui_lib2.png]: {{ site.baseurl }}/common/images/ui_lib2.png - diff --git a/src/guides/v2.3/frontend-dev-guide/layouts/layout-types.md b/src/guides/v2.3/frontend-dev-guide/layouts/layout-types.md index f3e7a1c3797..2b5d301eb86 100644 --- a/src/guides/v2.3/frontend-dev-guide/layouts/layout-types.md +++ b/src/guides/v2.3/frontend-dev-guide/layouts/layout-types.md @@ -431,7 +431,6 @@ The following table describes the instructions specific for generic layout files
  • <container>
  • <update>
  • -
Mandatory root element. @@ -466,7 +465,6 @@ none
  • <container>
  • <referenceBlock>
  • <referenceContainer>
  • - Mandatory element diff --git a/src/guides/v2.3/frontend-dev-guide/themes/product-video.md b/src/guides/v2.3/frontend-dev-guide/themes/product-video.md index 360df9cc34c..efbe5046a91 100644 --- a/src/guides/v2.3/frontend-dev-guide/themes/product-video.md +++ b/src/guides/v2.3/frontend-dev-guide/themes/product-video.md @@ -43,7 +43,6 @@ You can set the following product video options: Display related videos. Boolean - 0
    @@ -57,7 +56,6 @@ Boolean Auto re-play video. Boolean - 0
    diff --git a/src/guides/v2.3/frontend-dev-guide/themes/theme-images.md b/src/guides/v2.3/frontend-dev-guide/themes/theme-images.md index 18a81d28bdc..514f1a03d70 100644 --- a/src/guides/v2.3/frontend-dev-guide/themes/theme-images.md +++ b/src/guides/v2.3/frontend-dev-guide/themes/theme-images.md @@ -82,7 +82,6 @@ Can have any value, but in out-of-the- box Magento themes id's are
  • swatch_thumb - corresponds to the Swatch Image role in the Magento Admin
  • thumbnail - corresponds to the Thumbnail Image role in the Magento Admin
  • - diff --git a/src/guides/v2.3/frontend-dev-guide/themes/theme-overview.md b/src/guides/v2.3/frontend-dev-guide/themes/theme-overview.md index 22a40700d16..97327d56504 100644 --- a/src/guides/v2.3/frontend-dev-guide/themes/theme-overview.md +++ b/src/guides/v2.3/frontend-dev-guide/themes/theme-overview.md @@ -25,4 +25,3 @@ Your new theme can be a standalone new theme, or it can inherit from the default ![Themes flow]({{ site.baseurl }}/common/images/fdg/create_install_theme.png) [inherit other required files from a parent theme]: {{page.baseurl}}/frontend-dev-guide/themes/theme-inherit.html - diff --git a/src/guides/v2.3/graphql/develop/extend-existing-schema.md b/src/guides/v2.3/graphql/develop/extend-existing-schema.md index 5a523f5f773..b0316f7c80e 100644 --- a/src/guides/v2.3/graphql/develop/extend-existing-schema.md +++ b/src/guides/v2.3/graphql/develop/extend-existing-schema.md @@ -15,7 +15,7 @@ In the following example, we will change the description of an existing field (` The simplified structure of the query schema to get products is: -```text +```graphql schema { query: Query ... @@ -42,7 +42,8 @@ interface ProductInterface { We need to extend the `ProductInterface`, since that is the schema object for a product. We can do this by creating a `schema.graphqls` file in our custom module's (`OrangeCo/CustomGQL`) `etc` directory. `OrangeCo_CustomGQL/etc/schema.graphqls` -``` + +```graphql interface ProductInterface { attribute_set_id: Int @doc(description: "ID of the attribute set assigned to the product") diff --git a/src/guides/v2.3/graphql/interfaces/grouped-product.md b/src/guides/v2.3/graphql/interfaces/grouped-product.md index cc32a8cc82d..ed331b79397 100644 --- a/src/guides/v2.3/graphql/interfaces/grouped-product.md +++ b/src/guides/v2.3/graphql/interfaces/grouped-product.md @@ -31,4 +31,3 @@ Attribute | Type | Description The following query returns information about downloadable product `24-WG085_Group`, which is defined in the sample data. {% include graphql/grouped-product-sample.md %} - diff --git a/src/guides/v2.3/howdoi/checkout/checkout_payment.md b/src/guides/v2.3/howdoi/checkout/checkout_payment.md index c3a178909ec..7fae086a135 100644 --- a/src/guides/v2.3/howdoi/checkout/checkout_payment.md +++ b/src/guides/v2.3/howdoi/checkout/checkout_payment.md @@ -76,7 +76,6 @@ Usually, your component will extend the default payment method component (defaul getBillingAddressFormName():string Gets the unique billing address name. - disposeSubscriptions() Terminates the object's subscription. diff --git a/src/guides/v2.3/install-gde/install-resource-diagram.md b/src/guides/v2.3/install-gde/install-resource-diagram.md index ffe762cd2f9..d13c23e5942 100644 --- a/src/guides/v2.3/install-gde/install-resource-diagram.md +++ b/src/guides/v2.3/install-gde/install-resource-diagram.md @@ -14,4 +14,3 @@ functional_areas: The following diagram provides a high-level overview of installing the Magento software: {% include install/flow-diagram.md %} - diff --git a/src/guides/v2.3/install-gde/install/cli/install-cli-subcommands-store.md b/src/guides/v2.3/install-gde/install/cli/install-cli-subcommands-store.md index 51088a1eb81..227a6e69cf4 100644 --- a/src/guides/v2.3/install-gde/install/cli/install-cli-subcommands-store.md +++ b/src/guides/v2.3/install-gde/install/cli/install-cli-subcommands-store.md @@ -42,4 +42,3 @@ where the following table defines parameters and values. |`--use-secure-admin`|`1` means you use SSL to access the Magento Admin. Make sure your web server supports SSL before you select this option.

    `0` means you do not use SSL with the Admin. This is the default.|No| |`--admin-use-security-key`|`1` causes the Magento software to use a randomly generated key value to access pages in the Magento Admin and in forms. These key values help prevent cross-site script forgery attacks. This is the default.

    `0` disables the use of the key.|No| |`--magento-init-params`|Add to any command to customize Magento initialization parameters

    For example: `MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache`|No| - diff --git a/src/guides/v2.3/install-gde/install/get-help.md b/src/guides/v2.3/install-gde/install/get-help.md index 18f4fc3a2ea..f89b185277e 100644 --- a/src/guides/v2.3/install-gde/install/get-help.md +++ b/src/guides/v2.3/install-gde/install/get-help.md @@ -12,4 +12,3 @@ functional_areas: --- {% include install/get-help.md %} - diff --git a/src/guides/v2.3/install-gde/install/hosted/hosted_install.md b/src/guides/v2.3/install-gde/install/hosted/hosted_install.md index 39eb44f20bc..0664fc29e09 100644 --- a/src/guides/v2.3/install-gde/install/hosted/hosted_install.md +++ b/src/guides/v2.3/install-gde/install/hosted/hosted_install.md @@ -12,4 +12,3 @@ functional_areas: --- {% include install/web/install-web.md %} - diff --git a/src/guides/v2.3/install-gde/install/hosted/hosted_install_1_readiness.md b/src/guides/v2.3/install-gde/install/hosted/hosted_install_1_readiness.md index 2d184654a6a..8df63128211 100644 --- a/src/guides/v2.3/install-gde/install/hosted/hosted_install_1_readiness.md +++ b/src/guides/v2.3/install-gde/install/hosted/hosted_install_1_readiness.md @@ -17,4 +17,3 @@ functional_areas: Related topics [Step 2. Add a database]({{ page.baseurl }}/install-gde/install/hosted/hosted_install_2_db.html) - diff --git a/src/guides/v2.3/install-gde/install/hosted/hosted_install_6_install.md b/src/guides/v2.3/install-gde/install/hosted/hosted_install_6_install.md index a90860031e2..69f25453e60 100644 --- a/src/guides/v2.3/install-gde/install/hosted/hosted_install_6_install.md +++ b/src/guides/v2.3/install-gde/install/hosted/hosted_install_6_install.md @@ -12,4 +12,3 @@ functional_areas: --- {% include install/web/install-web_6-install.md %} - diff --git a/src/guides/v2.3/install-gde/install/sample-data-before-clone.md b/src/guides/v2.3/install-gde/install/sample-data-before-clone.md index 267421f41cb..b4303b6c582 100644 --- a/src/guides/v2.3/install-gde/install/sample-data-before-clone.md +++ b/src/guides/v2.3/install-gde/install/sample-data-before-clone.md @@ -12,4 +12,3 @@ functional_areas: --- {% include install/sampledata/sample-data-clone.md %} - diff --git a/src/guides/v2.3/install-gde/install/sample-data-before-composer.md b/src/guides/v2.3/install-gde/install/sample-data-before-composer.md index 3f448aa2675..af166122e49 100644 --- a/src/guides/v2.3/install-gde/install/sample-data-before-composer.md +++ b/src/guides/v2.3/install-gde/install/sample-data-before-composer.md @@ -12,4 +12,3 @@ functional_areas: --- {% include install/sampledata/sample-data-composer.md %} - diff --git a/src/guides/v2.3/install-gde/install/sample-data-other-cmds.md b/src/guides/v2.3/install-gde/install/sample-data-other-cmds.md index 258613f6583..12d50b32193 100644 --- a/src/guides/v2.3/install-gde/install/sample-data-other-cmds.md +++ b/src/guides/v2.3/install-gde/install/sample-data-other-cmds.md @@ -12,4 +12,3 @@ functional_areas: --- {% include install/sampledata/sample-data-other-cmds.md %} - diff --git a/src/guides/v2.3/install-gde/install/web/install-web_1-readiness.md b/src/guides/v2.3/install-gde/install/web/install-web_1-readiness.md index bb2f75b0d15..991ae5294ec 100644 --- a/src/guides/v2.3/install-gde/install/web/install-web_1-readiness.md +++ b/src/guides/v2.3/install-gde/install/web/install-web_1-readiness.md @@ -20,4 +20,3 @@ functional_areas: Related topics [Step 2. Add a database]({{ page.baseurl }}/install-gde/install/web/install-web_2-db.html) - diff --git a/src/guides/v2.3/install-gde/install/web/install-web_6-install.md b/src/guides/v2.3/install-gde/install/web/install-web_6-install.md index ebebcd1a4d4..88e9f0c94ba 100644 --- a/src/guides/v2.3/install-gde/install/web/install-web_6-install.md +++ b/src/guides/v2.3/install-gde/install/web/install-web_6-install.md @@ -12,4 +12,3 @@ functional_areas: --- {% include install/web/install-web_6-install.md %} - diff --git a/src/guides/v2.3/install-gde/prereq/merch_install.md b/src/guides/v2.3/install-gde/prereq/merch_install.md index daf30dea768..9435358e696 100644 --- a/src/guides/v2.3/install-gde/prereq/merch_install.md +++ b/src/guides/v2.3/install-gde/prereq/merch_install.md @@ -39,4 +39,3 @@ To start configuring your hosted system: 1. If necessary, log in to cPanel. ## Step 3: Configure a database and a database user {#newbie-db} - diff --git a/src/guides/v2.3/install-gde/system-requirements_tls1-2.md b/src/guides/v2.3/install-gde/system-requirements_tls1-2.md index 0721429f606..bcf73752344 100644 --- a/src/guides/v2.3/install-gde/system-requirements_tls1-2.md +++ b/src/guides/v2.3/install-gde/system-requirements_tls1-2.md @@ -14,4 +14,3 @@ functional_areas: --- {% include install/paypal-tls1-2.md %} - diff --git a/src/guides/v2.3/install-gde/trouble/tshoot_access-browser.md b/src/guides/v2.3/install-gde/trouble/tshoot_access-browser.md index 25c58598a10..5d6b30f9c82 100644 --- a/src/guides/v2.3/install-gde/trouble/tshoot_access-browser.md +++ b/src/guides/v2.3/install-gde/trouble/tshoot_access-browser.md @@ -38,4 +38,3 @@ Try the following: * Ubuntu: `service apache2 restart` * CentOS: `service httpd restart` - diff --git a/src/guides/v2.3/javascript-dev-guide/bk-javascript-dev-guide.md b/src/guides/v2.3/javascript-dev-guide/bk-javascript-dev-guide.md index 79d4c571aad..b0c10891cfe 100644 --- a/src/guides/v2.3/javascript-dev-guide/bk-javascript-dev-guide.md +++ b/src/guides/v2.3/javascript-dev-guide/bk-javascript-dev-guide.md @@ -46,4 +46,3 @@ JavaScript automatic testing is described in a separate [JavaScript unit testing [Magento jQuery widgets]: {{page.baseurl}}/javascript-dev-guide/widgets/jquery-widgets-about.html [Customizing JavaScript illustration]: {{page.baseurl}}/javascript-dev-guide/javascript/js_practice.html [JavaScript unit testing]: {{page.baseurl}}/test/js/jasmine.html - diff --git a/src/guides/v2.3/payments-integrations/payment-gateway/payment-gateway-structure.md b/src/guides/v2.3/payments-integrations/payment-gateway/payment-gateway-structure.md index b75e59a84ec..64b60b1d059 100644 --- a/src/guides/v2.3/payments-integrations/payment-gateway/payment-gateway-structure.md +++ b/src/guides/v2.3/payments-integrations/payment-gateway/payment-gateway-structure.md @@ -22,4 +22,3 @@ Each component from this scheme is described in the corresponding topic: * [Gateway Client]({{ page.baseurl }}/payments-integrations/payment-gateway/gateway-client.html) * [Response Validator]({{ page.baseurl }}/payments-integrations/payment-gateway/response-validator.html) * [Response Handler]({{ page.baseurl }}/payments-integrations/payment-gateway/response-handler.html) - diff --git a/src/guides/v2.3/release-notes/ReleaseNotes2.3.0Commerce.md b/src/guides/v2.3/release-notes/ReleaseNotes2.3.0Commerce.md index c3cea1f177b..4e07b4a2c50 100644 --- a/src/guides/v2.3/release-notes/ReleaseNotes2.3.0Commerce.md +++ b/src/guides/v2.3/release-notes/ReleaseNotes2.3.0Commerce.md @@ -33,8 +33,8 @@ Magento Commerce 2.3.0 includes a wealth of new features as well as hundreds of * **Inventory Management (provided by [Magento Inventory (was MSI)](https://github.com/magento/inventory))** is now available with Magento 2.3.0. It lets merchants manage inventory for all product types in a single warehouse and across complex shipping networks. Merchants can manage these locations as sources, tracking on-hand inventory quantities per product. Stocks map these sources and sales channels (websites) to provide an accurate, salable quantity as inventory pools for concurrent checkout and product reservations. Inventory Management also updates order and shipment options, giving you full control over your stock. Magento Inventory is a Magento Community Engineering special project open to contributors. To take part and contribute, see the [Magento Inventory GitHub](https://github.com/magento/inventory) repository and [wiki](https://github.com/magento/inventory/wiki) to get started. Join us in our [Slack](https://magentocommeng.slack.com/messages/C5FU5E2HY) channel (or [self signup](https://tinyurl.com/engcom-slack)) to discuss the project. - * [Inventory Management overview]({{ page.baseurl }}/inventory/index.html) for developer documentation - * [Managing Inventory](https://docs.magento.com/m2/ce/user_guide/catalog/inventory-management.html) for merchant information and instructions + * [Inventory Management overview]({{ page.baseurl }}/inventory/index.html) for developer documentation + * [Managing Inventory](https://docs.magento.com/m2/ce/user_guide/catalog/inventory-management.html) for merchant information and instructions * **CMS enhancements** include banner enhancements. You can now create banner content in native Magento WYSIWYG (or Page Builder. See the `Page Builder` discussion below. (Within the product interface, we now use the term *dynamic block* instead of *banner*.) We've also updated the WYSIWYG editor to use TinyMCE 4.6. (TinyMCE is now integrated into Magento through an adapter that allows it to be replaced with any other WYSIWYG editor.) @@ -3268,7 +3268,7 @@ We've fixed hundreds of issues in the Magento 2.3.0 core code. -* We've replaced `.size()` with `.length` to be compatible with jQuery 3.*. *Fix submitted by Kirill Morozov in pull request [13686](https://github.com/magento/magento2/pull/13686)*. +* We've replaced `.size()` with `.length` to be compatible with jQuery 3. *Fix submitted by Kirill Morozov in pull request [13686](https://github.com/magento/magento2/pull/13686)*. @@ -3705,4 +3705,3 @@ You can install Magento Commerce 2.3.0 using Composer. The Data Migration Tool helps transfer existing Magento 1.x store data to Magento 2.x. This command-line interface includes verification, progress tracking, logging, and testing functions. For installation instructions, see [Install the Data Migration Tool]({{page.baseurl}}/migration/migration-tool-install.html). Consider exploring or contributing to the [Magento Data Migration repository](https://github.com/magento/data-migration-tool). The [Code Migration Toolkit](https://github.com/magento/code-migration) helps transfer existing Magento 1.x store extensions and customizations to Magento 2.0.x. The command-line interface includes scripts for converting Magento 1.x modules and layouts. - diff --git a/src/guides/v2.3/release-notes/ReleaseNotes2.3.0OpenSource.md b/src/guides/v2.3/release-notes/ReleaseNotes2.3.0OpenSource.md index 47fcf7cfba5..8bbe4ee9fec 100644 --- a/src/guides/v2.3/release-notes/ReleaseNotes2.3.0OpenSource.md +++ b/src/guides/v2.3/release-notes/ReleaseNotes2.3.0OpenSource.md @@ -3119,7 +3119,7 @@ See [Magento Security Center](https://magento.com/security/patches/magento-2.2.7 -* We've replaced `.size()` with `.length` to be compatible with jQuery 3.*. *Fix submitted by Kirill Morozov in pull request [13686](https://github.com/magento/magento2/pull/13686)*. +* We've replaced `.size()` with `.length` to be compatible with jQuery 3. *Fix submitted by Kirill Morozov in pull request [13686](https://github.com/magento/magento2/pull/13686)*. @@ -3554,4 +3554,3 @@ You can install {{site.data.var.ce}} 2.3 Beta using Composer. The Data Migration Tool helps transfer existing Magento 1.x store data to Magento 2.x. This command-line interface includes verification, progress tracking, logging, and testing functions. For installation instructions, see [Install the Data Migration Tool]({{page.baseurl}}/migration/migration-tool-install.html). Consider exploring or contributing to the [Magento Data Migration repository](https://github.com/magento/data-migration-tool). The [Code Migration Toolkit](https://github.com/magento/code-migration) helps transfer existing Magento 1.x store extensions and customizations to Magento 2.0.x. The command-line interface includes scripts for converting Magento 1.x modules and layouts. - diff --git a/src/guides/v2.3/release-notes/ReleaseNotes2.3.1Commerce.md b/src/guides/v2.3/release-notes/ReleaseNotes2.3.1Commerce.md index 118cf87dc09..9a7502ca63b 100644 --- a/src/guides/v2.3/release-notes/ReleaseNotes2.3.1Commerce.md +++ b/src/guides/v2.3/release-notes/ReleaseNotes2.3.1Commerce.md @@ -2402,4 +2402,3 @@ You can install {{site.data.var.ee}} 2.3.1 using Composer. The Data Migration Tool helps transfer existing Magento 1.x store data to Magento 2.x. This command-line interface includes verification, progress tracking, logging, and testing functions. For installation instructions, see [Install the Data Migration Tool]({{page.baseurl}}/migration/migration-tool-install.html). Consider exploring or contributing to the [Magento Data Migration repository](https://github.com/magento/data-migration-tool). The [Code Migration Toolkit](https://github.com/magento/code-migration) helps transfer existing Magento 1.x store extensions and customizations to Magento 2.0.x. The command-line interface includes scripts for converting Magento 1.x modules and layouts. - diff --git a/src/guides/v2.3/release-notes/ReleaseNotes2.3.1OpenSource.md b/src/guides/v2.3/release-notes/ReleaseNotes2.3.1OpenSource.md index 43870a9caa5..820e1559803 100644 --- a/src/guides/v2.3/release-notes/ReleaseNotes2.3.1OpenSource.md +++ b/src/guides/v2.3/release-notes/ReleaseNotes2.3.1OpenSource.md @@ -2232,4 +2232,3 @@ You can install {{site.data.var.ce}} 2.3.1 using Composer. The Data Migration Tool helps transfer existing Magento 1.x store data to Magento 2.x. This command-line interface includes verification, progress tracking, logging, and testing functions. For installation instructions, see [Install the Data Migration Tool]({{page.baseurl}}/migration/migration-tool-install.html). Consider exploring or contributing to the [Magento Data Migration repository](https://github.com/magento/data-migration-tool). The [Code Migration Toolkit](https://github.com/magento/code-migration) helps transfer existing Magento 1.x store extensions and customizations to Magento 2.0.x. The command-line interface includes scripts for converting Magento 1.x modules and layouts. - diff --git a/src/guides/v2.3/release-notes/ReleaseNotes2.3.2OpenSource.md b/src/guides/v2.3/release-notes/ReleaseNotes2.3.2OpenSource.md index 82de8c353d6..9939720d754 100644 --- a/src/guides/v2.3/release-notes/ReleaseNotes2.3.2OpenSource.md +++ b/src/guides/v2.3/release-notes/ReleaseNotes2.3.2OpenSource.md @@ -1286,4 +1286,3 @@ You can install {{site.data.var.ee}} 2.3.2 using Composer. The Data Migration Tool helps transfer existing Magento 1.x store data to Magento 2.x. This command-line interface includes verification, progress tracking, logging, and testing functions. For installation instructions, see [Install the Data Migration Tool]({{page.baseurl}}/migration/migration-tool-install.html). Consider exploring or contributing to the [Magento Data Migration repository](https://github.com/magento/data-migration-tool). The [Code Migration Toolkit](https://github.com/magento/code-migration) helps transfer existing Magento 1.x store extensions and customizations to Magento 2.0.x. The command-line interface includes scripts for converting Magento 1.x modules and layouts. - diff --git a/src/guides/v2.3/release-notes/component-status.md b/src/guides/v2.3/release-notes/component-status.md index 7234dbf2e88..6af23fa4e19 100644 --- a/src/guides/v2.3/release-notes/component-status.md +++ b/src/guides/v2.3/release-notes/component-status.md @@ -209,4 +209,3 @@ Issues that are not related to the 2.3.0 beta release are not part of this repor | Module/ Sales | Yellow | | None | Green | | Tools/ Utilities | Green | - diff --git a/src/guides/v2.3/rest/anonymous-api-security.md b/src/guides/v2.3/rest/anonymous-api-security.md index cb98b0bf3e1..8e4c2f2df2b 100644 --- a/src/guides/v2.3/rest/anonymous-api-security.md +++ b/src/guides/v2.3/rest/anonymous-api-security.md @@ -104,4 +104,3 @@ The following APIs remain accessible to anonymous users. Most of these must rema | Commerce | GiftCardAccount | /V1/carts/guest-carts/:cartId/checkGiftCard/:giftCardCode | GET | | Commerce | GiftRegistry | /V1/guest-giftregistry/:cartId/estimate-shipping-methods | POST | | Commerce | WorldPay | /V1/worldpay-guest-carts/:cartId/payment-information | POST - diff --git a/src/guides/v2.3/rest/operation-status-endpoints.md b/src/guides/v2.3/rest/operation-status-endpoints.md index dce40b4f284..b9f7a54de90 100644 --- a/src/guides/v2.3/rest/operation-status-endpoints.md +++ b/src/guides/v2.3/rest/operation-status-endpoints.md @@ -21,10 +21,10 @@ Field name | Data type | Description --- | --- | --- `operations_list` | Object | An array containing information about each operation in a bulk or asynchronous request. `id` | Integer | Identifies the bulk or asynchronous request. -`status` | Integer | The operation status
    * `1` = Complete
    * `2` = The operation failed, but you can try to perform it again
    * `3` = The operation failed. You must change something to retry it.
    * `4` = Open
    * `5` = Rejected +`status` | Integer | The operation status
    \* `1` = Complete
    \* `2` = The operation failed, but you can try to perform it again
    \* `3` = The operation failed. You must change something to retry it.
    \* `4` = Open
    \* `5` = Rejected `result_message` | String | Describes the result of the operation. If successful, the value contains the string `Service execution success` as well as the method that executed the operation. `error_code` | Integer | If applicable, an error code associated with the operation. -`user_type` | Integer | Type of user who made this request. Possible values are:
    * `1` = Integration
    * `2` = Administrator
    * `3` = Customer
    * `4` = Guest User +`user_type` | Integer | Type of user who made this request. Possible values are:
    \* `1` = Integration
    \* `2` = Administrator
    \* `3` = Customer
    \* `4` = Guest User `bulk_id` | String | UUID generated by an [asynchronous API request]({{ page.baseurl }}/rest/asynchronous-web-endpoints.html) or [Bulk API request]({{ page.baseurl }}/rest/bulk-endpoints.html). `description` | String | Contains the message queue topic. `start_time` | String | The time that a bulk or asynchronous operation started. @@ -86,10 +86,10 @@ Field name | Data type | Description `topic_name` | String | The name of the message queue topic, in the format `async..`. The service contract path is lowercase, and the method is either `post`, `put`, or `delete`. `serialized_data` | String | An array of serialized input data. It contains serialized JSON with the following keys: `entity_id` - `null`, `entity_link` - an empty string, `meta_info` - the body of the API request that was executed. `result_serialized_data` | String | Contains serialized output of the corresponding synchronous API call. For example, if you call `POST /async/V1/products`, this field contains serialized response from `POST /V1/products`. -`status` | Integer | The operation status
    * `1` = Complete
    * `2` = The operation failed, but you can try to perform it again
    * `3` = The operation failed. You must change something to retry it.
    * `4` = Open
    * `5` = Rejected +`status` | Integer | The operation status
    \* `1` = Complete
    \* `2` = The operation failed, but you can try to perform it again
    \* `3` = The operation failed. You must change something to retry it.
    \* `4` = Open
    \* `5` = Rejected `result_message` | String | Describes the result of the operation. If successful, the value contains the string `Service execution success` as well as the method that executed the operation. `error_code` | Integer | If applicable, an error code associated with the operation. -`user_type` | Integer | Type of user who made this request. Possible values are:
    * `1` = Integration
    * `2` = Administrator
    * `3` = Customer
    * `4` = Guest User +`user_type` | Integer | Type of user who made this request. Possible values are:
    \* `1` = Integration
    \* `2` = Administrator
    \* `3` = Customer
    \* `4` = Guest User `bulk_id` | String | UUID generated by an [asynchronous API request]({{ page.baseurl }}/rest/asynchronous-web-endpoints.html) or [Bulk API request]({{ page.baseurl }}/rest/bulk-endpoints.html). `description` | String | Contains the message queue topic name. `start_time` | String | The time that a bulk or asynchronous operation started. diff --git a/src/guides/v2.3/rest/retrieve-filtered-responses.md b/src/guides/v2.3/rest/retrieve-filtered-responses.md index db920f52238..87325dfbd4b 100644 --- a/src/guides/v2.3/rest/retrieve-filtered-responses.md +++ b/src/guides/v2.3/rest/retrieve-filtered-responses.md @@ -19,7 +19,7 @@ Separate each field or object with a comma. On POST and PUT requests, Magento ignores the `fields` parameter as input, but the response includes only the requested fields and objects. -# Examples +## Examples {:.no_toc} All examples use {{site.data.var.ce}} sample data. diff --git a/src/guides/v2.3/ui_comp_guide/components/basic-attributes.md b/src/guides/v2.3/ui_comp_guide/components/basic-attributes.md index 07125c3e7f6..a22ab8af865 100644 --- a/src/guides/v2.3/ui_comp_guide/components/basic-attributes.md +++ b/src/guides/v2.3/ui_comp_guide/components/basic-attributes.md @@ -65,4 +65,3 @@ The following options are available for all basic components: String - diff --git a/src/guides/v2.3/ui_comp_guide/components/ui-button.md b/src/guides/v2.3/ui_comp_guide/components/ui-button.md index 181961d736a..e94879e7549 100644 --- a/src/guides/v2.3/ui_comp_guide/components/ui-button.md +++ b/src/guides/v2.3/ui_comp_guide/components/ui-button.md @@ -126,4 +126,3 @@ Here is an example of how the Button component integrates with the [Form]({{ pag #### Result ![Form Buttons example]({{ site.baseurl }}/common/images/ui_comps/ui-form-buttons-example.png) - diff --git a/src/guides/v2.3/ui_comp_guide/components/ui-columns-editing-bulk.md b/src/guides/v2.3/ui_comp_guide/components/ui-columns-editing-bulk.md index 868ce9c8a67..93633750f8b 100644 --- a/src/guides/v2.3/ui_comp_guide/components/ui-columns-editing-bulk.md +++ b/src/guides/v2.3/ui_comp_guide/components/ui-columns-editing-bulk.md @@ -69,4 +69,3 @@ This is an example of how the ColumnsEditingBulk component disables the [Columns ``` - diff --git a/src/guides/v2.3/ui_comp_guide/components/ui-columns-editing-client.md b/src/guides/v2.3/ui_comp_guide/components/ui-columns-editing-client.md index 76af7f7c7c7..1008d3ef2ab 100644 --- a/src/guides/v2.3/ui_comp_guide/components/ui-columns-editing-client.md +++ b/src/guides/v2.3/ui_comp_guide/components/ui-columns-editing-client.md @@ -69,5 +69,3 @@ This is an example of how to disable validation before saving data: ``` - - diff --git a/src/guides/v2.3/ui_comp_guide/components/ui-columns-editor-view.md b/src/guides/v2.3/ui_comp_guide/components/ui-columns-editor-view.md index 65a35a5d201..3396279bb0e 100644 --- a/src/guides/v2.3/ui_comp_guide/components/ui-columns-editor-view.md +++ b/src/guides/v2.3/ui_comp_guide/components/ui-columns-editor-view.md @@ -88,4 +88,3 @@ This is an example of how the ColumnsEditorView component integrates with the [C #### Result ![ColumnsEditorView Component example]({{ site.baseurl }}/common/images/ui_comps/ui-columns-editor-view-result.png) - diff --git a/src/guides/v2.3/ui_comp_guide/components/ui-columns-editor.md b/src/guides/v2.3/ui_comp_guide/components/ui-columns-editor.md index fda183afbc4..85e60f13c41 100644 --- a/src/guides/v2.3/ui_comp_guide/components/ui-columns-editor.md +++ b/src/guides/v2.3/ui_comp_guide/components/ui-columns-editor.md @@ -84,4 +84,3 @@ This is an example of how the ColumnsEditor component integrates with the [Colum #### Result ![DynamicRowsDragAndDrop Component example]({{ site.baseurl }}/common/images/ui_comps/ui-columns-editor-result.png) - diff --git a/src/guides/v2.3/ui_comp_guide/components/ui-columnscontrols.md b/src/guides/v2.3/ui_comp_guide/components/ui-columnscontrols.md index 69b380cd893..6eb99214216 100644 --- a/src/guides/v2.3/ui_comp_guide/components/ui-columnscontrols.md +++ b/src/guides/v2.3/ui_comp_guide/components/ui-columnscontrols.md @@ -46,4 +46,3 @@ Extends [`uiCollection`]({{ page.baseurl }}/ui_comp_guide/concepts/ui_comp_uicol #### Result ![ColumnsControls component example]({{ site.baseurl }}/common/images/ui_comps/columns-controls-result.png) - diff --git a/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/_code-samples/ckeditor4Adapter.md b/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md similarity index 100% rename from src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/_code-samples/ckeditor4Adapter.md rename to src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md diff --git a/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md b/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md index 47d9b01de1c..4233d4ada98 100644 --- a/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md +++ b/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md @@ -94,7 +94,7 @@ If you are integrating Magento entities such as variable and widget as plugins, **Example:** CKEditor/CKEditor4/view/base/web/ckeditor4Adapter.js {% collapsible Show file content %} -{% include_relative _code-samples/ckeditor4Adapter.md %} +{% include_relative code-samples/ckeditor4Adapter.md %} {% endcollapsible %} ## Step 4. Load editor library diff --git a/src/guides/v2.3/ui_comp_guide/components/wysiwyg/extension-points/index.md b/src/guides/v2.3/ui_comp_guide/components/wysiwyg/extension-points/index.md index ccf86f1c823..fb878fd232c 100644 --- a/src/guides/v2.3/ui_comp_guide/components/wysiwyg/extension-points/index.md +++ b/src/guides/v2.3/ui_comp_guide/components/wysiwyg/extension-points/index.md @@ -128,6 +128,7 @@ public function getVariablesWysiwygActionUrl() return $this->_url->getUrl('mui/index/render', ['namespace' => 'variables_modal']); } ``` + * htmlId of the WYSIWYG editor. For CKEditor4, you can get this by calling `editor.element.getId()`. diff --git a/src/guides/v2.3/ui_comp_guide/concepts/ui_comp_data_source.md b/src/guides/v2.3/ui_comp_guide/concepts/ui_comp_data_source.md index 2d068ac2ef4..867a5d4b304 100644 --- a/src/guides/v2.3/ui_comp_guide/concepts/ui_comp_data_source.md +++ b/src/guides/v2.3/ui_comp_guide/concepts/ui_comp_data_source.md @@ -61,7 +61,7 @@ A good way to keep configuration data out of the javascript is to declare a "pro This example declares the name of the data provider class and will be output in the JSON that contains the UI component's configuration. It can then be used to locate the data source component. This is essentially declaring a variable that will be available to a javascript class. -# Javascript Template Literals +## Javascript Template Literals Throughout Magento's core Javascript components there are strings like this: `'${ $.provider }:data.totalRecords'`. These are ES2015 [template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals). The `${ }` surrounds an expression that will be parsed as Javascript. `$.provider` is the expression, in this example. @@ -71,7 +71,7 @@ When the component is initialized, it will automatically evaluate all string lit But, XML is static and while that gets us the name of the data provider component, it still does not actually provide data. There is one more important step in providing data to Javascript components. -# Javascript Component Linking +## Javascript Component Linking Every Javascript component should extend the core Element class in some way (mapped to [`uiElement`]({{ page.baseurl }}/ui_comp_guide/concepts/ui_comp_uielement_concept.html) with RequireJS and located in [`Magento/Ui/view/base/web/js/lib/core/element/element.js`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Ui/view/base/web/js/lib/core/element/element.js). When this class initializes it runs an `initLinks()` method. That method, in turn, passes a few class properties into a method that handles linking components together. This file (`lib/core/element/link.js`) binds the values of those parameters to actual components. diff --git a/src/guides/v2.4/extension-dev-guide/xss-protection.md b/src/guides/v2.4/extension-dev-guide/xss-protection.md index 785fb42e4a5..5c6be2857b6 100644 --- a/src/guides/v2.4/extension-dev-guide/xss-protection.md +++ b/src/guides/v2.4/extension-dev-guide/xss-protection.md @@ -193,8 +193,8 @@ To check your .phtml template for XSS vulnerabilities, use the _Magento2.Securit This sniff finds all _echo_ calls in PHTML-templates and determines if the output is properly escaped. It covers the following cases: -- /_ @noEscape _/ before output. Output does not require escaping. Test is green. -- /_ @escapeNotVerified _/ before output. Output escaping is not checked and should be verified. Test is green. +- `/_ @noEscape _/` before output. Output does not require escaping. Test is green. +- `/_ @escapeNotVerified _/` before output. Output escaping is not checked and should be verified. Test is green. - Methods which contain "html" in their names (for example echo $object->{suffix}Html{postfix}()). Data is ready for the HTML output. Test is green. - AbstractBlock methods `escapeHtml`, `escapeHtmlAttr`, `escapeUrl`, `escapeJs` are allowed. Test is green. - Type casting and php function `count()` are allowed (for example `echo (int)$var`, `(bool)$var`, `count($var)`). Test is green. diff --git a/src/guides/v2.4/frontend-dev-guide/bk-frontend-dev-guide.md b/src/guides/v2.4/frontend-dev-guide/bk-frontend-dev-guide.md index c511ff236f2..7458720bb9d 100644 --- a/src/guides/v2.4/frontend-dev-guide/bk-frontend-dev-guide.md +++ b/src/guides/v2.4/frontend-dev-guide/bk-frontend-dev-guide.md @@ -68,4 +68,3 @@ Related topics * [JavaScript coding standard]({{ page.baseurl }}/coding-standards/code-standard-javascript.html) * [Responsive web design]({{ page.baseurl }}/frontend-dev-guide/responsive-web-design/rwd_overview.html) * [Translations]({{ page.baseurl }}/frontend-dev-guide/translations/xlate.html) - diff --git a/src/guides/v2.4/frontend-dev-guide/themes/theme-images.md b/src/guides/v2.4/frontend-dev-guide/themes/theme-images.md index 5f9cb59ef82..7f447a2921b 100644 --- a/src/guides/v2.4/frontend-dev-guide/themes/theme-images.md +++ b/src/guides/v2.4/frontend-dev-guide/themes/theme-images.md @@ -82,7 +82,6 @@ Can have any value, but in out-of-the- box Magento themes id's are
  • swatch_thumb - corresponds to the Swatch Image role in the [Magento Admin](https://glossary.magento.com/magento-admin).
  • thumbnail - corresponds to the Thumbnail Image role in the Magento Admin
  • - diff --git a/src/guides/v2.4/graphql/interfaces/grouped-product.md b/src/guides/v2.4/graphql/interfaces/grouped-product.md index c5ac54e3708..2729145aece 100644 --- a/src/guides/v2.4/graphql/interfaces/grouped-product.md +++ b/src/guides/v2.4/graphql/interfaces/grouped-product.md @@ -30,4 +30,3 @@ Attribute | Type | Description The following query returns information about downloadable product `24-WG085_Group`, which is defined in the sample data. {% include graphql/grouped-product-sample.md %} - diff --git a/src/guides/v2.4/howdoi/checkout/checkout_payment.md b/src/guides/v2.4/howdoi/checkout/checkout_payment.md index 53a78b442c8..955d12e39c5 100644 --- a/src/guides/v2.4/howdoi/checkout/checkout_payment.md +++ b/src/guides/v2.4/howdoi/checkout/checkout_payment.md @@ -76,7 +76,6 @@ Usually, your component will extend the default payment method component (defaul getBillingAddressFormName():string Gets the unique billing address name. - disposeSubscriptions() Terminates the object's subscription. diff --git a/src/guides/v2.4/release-notes/b2b-release-notes.md b/src/guides/v2.4/release-notes/b2b-release-notes.md index 0cc0e119c42..f8c5a56c60d 100644 --- a/src/guides/v2.4/release-notes/b2b-release-notes.md +++ b/src/guides/v2.4/release-notes/b2b-release-notes.md @@ -46,4 +46,3 @@ These release notes can include: - Magento throws an exception during upgrade to B2B 1.2.0 in a multi-website deployment. When `setup:upgrade` runs, this error occurs on the `PurchaseOrder` module: `Module Magento_PurchaseOrder: Unable to apply data patch Magento\PurchaseOrder\Setup\Patch\Data\InitPurchaseOrderSalesSequence for moduleMagento_PurchaseOrder`. **Workaround**: Install the **B2B-716 Add NonTransactionableInterface interface to the InitPurchaseOrderSalesSequence data patch** hotfix, which is now available from the **My Account** > **Downloads** section of `magento.com`. - If a discount code expires before a Purchase Order (PO) is approved, the PO continues to display the discounted amount, but once the PO is approved, the order is placed at the non-discounted total. **Workaround**: Install the **B2B-709 Purchase Order Discount patch** hotfix for this issue, which is now available from the **My Account** > **Downloads** section of `magento.com`. - If items in a purchase order are out-of-stock, or of insufficient quantity when the purchase order is converted into an actual order, an error will occur. If backorders are enabled, the order will be processed normally. - diff --git a/src/guides/v2.4/test/testing.md b/src/guides/v2.4/test/testing.md index e83e1667ea9..9f27ca0fa99 100644 --- a/src/guides/v2.4/test/testing.md +++ b/src/guides/v2.4/test/testing.md @@ -102,7 +102,7 @@ It is run on changed `*.php` files using rule strictness [level 1][] and detects - Array has N duplicate keys - Call to an undefined method - Possibly undefined variables -- Unknown magic methods and properties on classes with __call and __get (supports DataObject's magic methods: get/set/has/uns) +- Unknown magic methods and properties on classes with `__call` and `__get` (supports DataObject's magic methods: get/set/has/uns) #### Suppressing errors diff --git a/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/_code-samples/ckeditor4Adapter.md b/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/_code-samples/ckeditor4Adapter.md deleted file mode 120000 index 97a261f0c8f..00000000000 --- a/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/_code-samples/ckeditor4Adapter.md +++ /dev/null @@ -1 +0,0 @@ -../../../../../../v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/_code-samples/ckeditor4Adapter.md \ No newline at end of file diff --git a/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md b/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md new file mode 120000 index 00000000000..9572008b48e --- /dev/null +++ b/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md @@ -0,0 +1 @@ +../../../../../../v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md \ No newline at end of file