Merge branch 'master' of github.com:magento/devdocs into issue-8347-add-new-product-attribute-documentation

Author: Dinesh V B

.github/ISSUE_TEMPLATE/NEW_FEATURE.md

@@ -36,4 +36,3 @@ Issues that do not comply with our Code of Conduct or do not contain enough info
 
 Feel free to remove this section before creating this issue.
 -->
-

.github/workflows/linter.yml

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

.github/workflows/main.yml

@@ -13,7 +13,7 @@ content_map:
 -
   directory: src/mftf/v2
   repository: magento/magento2-functional-testing-framework
-  branch: 2.6.5
+  branch: 2.x-develop
   filter: true
 -
   directory: src/page-builder

Docfile.yml

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

README.md

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

Rakefile

@@ -33,7 +33,7 @@
     if url_ignore
       url_ignore.push(jekyll_excludes_as_regex).flatten!.uniq!
     else
-      checks_config['html-proofer'].merge!(url_ignore: jekyll_excludes_as_regex)
+      checks_config['html-proofer'][:url_ignore] = jekyll_excludes_as_regex
     end
 
     # Read configuration options for html-proofer

_checks/html_check_hook.rb

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

_plugins/debug/site_post_render.rb

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

_plugins/debug/site_pre_render.rb

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