Merge branch 'master' into imported-tshabatyn-devdocs-9295

Author: dobooth

.github/ISSUE_TEMPLATE.md

@@ -19,7 +19,7 @@ GitHub Issues should only be created for problems/topics related to this project
 Before submitting this issue, please make sure you are complying with our Code of Conduct:
 https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md
 
-Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
+Issues that neither comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
 
 Feel free to remove this section before creating this issue.
 -->

.github/ISSUE_TEMPLATE/BUG.md

@@ -1,25 +1,27 @@
 ---
 name: Bug report
 about: Create an issue about a bug on the devdocs website
----
+title: Bug report
+labels: bug
+assignees: dshevtsov
 
-# Bug report
+---
 
 ## Description
 
 <!-- (REQUIRED) What is the issue/current behavior? -->
 
 ### Steps to reproduce
 
-<!-- (OPTIONAL) What needs to be done to replicate this issue? (provide Gist if needed) -->
+<!-- (OPTIONAL) What needs to be done to replicate this issue? You can provide your scenario in a Gist. -->
 
 1. First Step
 1. Second Step
 1. Etc.
 
 ## Expected result
 
-<!-- (REQUIRED) When this issue is resolved, what is the expected result/behavior? -->
+<!-- (REQUIRED) What is the expected result/behavior after resolving this issue? -->
 
 ## Possible solutions
 
@@ -31,7 +33,7 @@ about: Create an issue about a bug on the devdocs website
 
 <!--
 Thank you for taking the time to report this issue!
-GitHub Issues should only be created for problems/topics related to this project's codebase.
+GitHub Issues in this repo should relate to this project's codebase.
 
 Before submitting this issue, please make sure you are complying with our Code of Conduct:
 https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md

.github/ISSUE_TEMPLATE/COMMUNITY_ISSUE_TEMPLATE.md

@@ -1,9 +1,11 @@
 ---
-name: New feature
+name: New devdocs feature
 about: Create a request for new functionality in devdocs
----
+title: Request for a devdocs feature 
+labels: enhancement
+assignees: dshevtsov
 
-# New feature request
+---
 
 ## Description
 
@@ -27,7 +29,7 @@ about: Create a request for new functionality in devdocs
 
 <!--
 Thank you for taking the time to report this issue!
-GitHub Issues should only be created for problems/topics related to this project's codebase.
+GitHub Issues in this repo should only relate to this project's codebase.
 
 Before submitting this issue, please make sure you are complying with our Code of Conduct:
 https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md

.github/ISSUE_TEMPLATE/NEW_FEATURE.md

@@ -1,9 +1,11 @@
 ---
 name: New topic
 about: Create a request to add missing information to devdocs
----
+title: 'Request for a new topic'
+labels: New Topic
+assignees: ''
 
-# New topic request
+---
 
 ## Description
 
@@ -26,7 +28,7 @@ about: Create a request to add missing information to devdocs
 
 <!--
 Thank you for taking the time to report this issue!
-GitHub Issues should only be created for problems/topics related to this project's codebase.
+GitHub Issues in this repo should relate to this project's codebase.
 
 Before submitting this issue, please make sure you are complying with our Code of Conduct:
 https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md

.github/ISSUE_TEMPLATE/NEW_TOPIC.md

@@ -1,9 +1,11 @@
 ---
 name: Topic clarification/correction
 about: Create a request to clarify or correct a documentation topic
----
+title: 'Request for a topic update'
+labels: ''
+assignees: ''
 
-# Topic clarification/correction request
+---
 
 ## Topic Link
 
@@ -23,7 +25,7 @@ about: Create a request to clarify or correct a documentation topic
 
 <!--
 Thank you for taking the time to report this issue!
-GitHub Issues should only be created for problems/topics related to this project's codebase.
+GitHub Issues in this repo should relate to this project's codebase.
 
 Before submitting this issue, please make sure you are complying with our Code of Conduct:
 https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md

.github/ISSUE_TEMPLATE/TOPIC_CLARIFICATION.md

@@ -55,11 +55,12 @@ jobs:
       # Run Linter against code base #
       ################################
       - name: Lint Code Base
-        uses: github/super-linter@v3
+        uses: github/super-linter@v4
         env:
           VALIDATE_ALL_CODEBASE: false
           DEFAULT_BRANCH: master
           VALIDATE_HTML: false
           VALIDATE_JSCPD: false
           VALIDATE_OPENAPI: false
           MARKDOWN_CONFIG_FILE: .markdownlint.json
+          VALIDATE_NATURAL_LANGUAGE: false

.github/workflows/linter.yml

@@ -16,14 +16,14 @@ GEM
     algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
-    chef-utils (17.5.22)
+    chef-utils (17.8.25)
       concurrent-ruby
     colorator (1.1.0)
     concurrent-ruby (1.1.9)
-    em-websocket (0.5.2)
+    em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0.6.0)
-    ethon (0.14.0)
+      http_parser.rb (~> 0)
+    ethon (0.15.0)
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
     exifr (1.3.9)
@@ -50,31 +50,31 @@ GEM
     filesize (0.2.0)
     forwardable-extended (2.6.0)
     fspath (3.1.2)
-    html-proofer (3.19.2)
+    html-proofer (3.19.3)
       addressable (~> 2.3)
       mercenary (~> 0.3)
-      nokogumbo (~> 2.0)
+      nokogiri (~> 1.12)
       parallel (~> 1.3)
       rainbow (~> 3.0)
       typhoeus (~> 1.3)
       yell (~> 2.0)
-    http_parser.rb (0.6.0)
+    http_parser.rb (0.8.0)
     httpclient (2.8.3)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    image_optim (0.30.0)
+    image_optim (0.31.1)
       exifr (~> 1.2, >= 1.2.2)
       fspath (~> 3.0)
-      image_size (>= 1.5, < 3)
+      image_size (>= 1.5, < 4)
       in_threads (~> 1.3)
       progress (~> 3.0, >= 3.0.1)
-    image_optim_pack (0.7.0.20210511)
+    image_optim_pack (0.8.0.20211116)
       fspath (>= 2.1, < 4)
       image_optim (~> 0.19)
-    image_optim_pack (0.7.0.20210511-x86_64-darwin)
+    image_optim_pack (0.8.0.20211116-x86_64-darwin)
       fspath (>= 2.1, < 4)
       image_optim (~> 0.19)
-    image_size (2.1.2)
+    image_size (3.0.1)
     in_threads (1.5.4)
     jekyll (4.2.1)
       addressable (~> 2.4)
@@ -114,7 +114,7 @@ GEM
       jekyll (>= 3.3, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    json (2.5.1)
+    json (2.6.1)
     kramdown (2.3.1)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -145,8 +145,6 @@ GEM
       racc (~> 1.4)
     nokogiri (1.12.5-x86_64-darwin)
       racc (~> 1.4)
-    nokogumbo (2.0.5)
-      nokogiri (~> 1.8, >= 1.8.4)
     octokit (4.21.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
@@ -156,14 +154,14 @@ GEM
     progress (3.6.0)
     progressbar (1.11.0)
     public_suffix (4.0.6)
-    racc (1.5.2)
+    racc (1.6.0)
     rainbow (3.0.0)
     rake (13.0.6)
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rexml (3.2.5)
-    rouge (3.26.1)
+    rouge (3.27.0)
     ruby2_keywords (0.0.5)
     safe_yaml (1.0.5)
     sassc (2.4.0)

Gemfile.lock

@@ -24,7 +24,7 @@ desc "Same as 'rake', 'rake preview'"
 task default: %w[preview]
 
 desc "Same as 'test:report'"
-task test: %w[test:md test:report]
+task test: %w[test:md test:report test:unused_images test:unused_includes]
 
 desc 'Preview the devdocs locally'
 task preview: %w[install clean] do

Rakefile

@@ -62,4 +62,60 @@ namespace :test do
     abort 'Fix the reported issues'.red unless output.empty?
     puts 'No issues found'.green
   end
+
+  desc 'Find unused images. To exclude by regex pattern, use the "exclude_img" argument. Example of excluding a "layout" directory: "rake test:unused_includes exclude_img=/layout/"'
+  task :unused_images do
+    puts 'Running a task for finding unused images (png,svg,jpeg,jpg,ico)'.magenta
+    images = FileList['src/**/*.{png,svg,jpeg,jpg,ico}']
+
+    puts "The project contains a total of #{images.size} images."
+
+    exclude = ENV['exclude_img']
+    images.exclude(/#{exclude}/) if exclude
+
+    puts 'Checking for unlinked images...'
+    Dir['src/**/*.{md,html,js,css}'].each do |file|
+      # Exclude symmlinks
+      next if File.symlink? file
+
+      images.delete_if { |image| File.read(file).include?(File.basename(image)) }
+    end
+
+    if images.empty?
+      puts 'No unlinked images'.green
+    else
+      images.each do |image|
+        puts "No links for #{image}".yellow
+      end
+      puts "Found #{images.size} dangling images".red
+    end
+  end
+
+  desc 'Find unused includes. To exclude by regex pattern, use the "exclude_incl" argument. Example of excluding a "layout" directory: "rake test:unused_includes exclude_incl=/layout/"'
+  task :unused_includes do
+    puts 'Running a task to find unused _includes'.magenta
+    includes = FileList['src/_includes/**/*']
+
+    puts "The project contains a total of #{includes.size} includes"
+
+    exclude = ENV['exclude_incl']
+    includes.exclude(/#{exclude}/) if exclude
+
+    Dir['src/**/*.{md,html}'].each do |file|
+      next if File.symlink? file
+
+      includes.delete_if { |include| File.read(file).include?(File.basename(include)) }
+    end
+
+    if includes.empty?
+      puts 'No unlinked includes'.green
+    else
+      puts 'The following includes are not linked:'
+      includes.each do |include|
+        puts "No links for #{include}".yellow
+      end
+      puts "Found #{includes.size} unlinked includes".red
+      puts 'Be careful removing include files. Some include files, such as those in the layout/** directory, may not be linked in the project, but may be used implicitly by the doc theme.'.bold  
+    end
+  end
 end