Merge branch 'master' into patch-1

Author: TuVanDev

.github/workflows/linter.yml

@@ -63,3 +63,4 @@ jobs:
           VALIDATE_JSCPD: false
           VALIDATE_OPENAPI: false
           MARKDOWN_CONFIG_FILE: .markdownlint.json
+          VALIDATE_NATURAL_LANGUAGE: false

.ruby-version

@@ -1 +1 @@
-ruby-2.7.2
+ruby-2.7.5

Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/magento-devdocs/devdocs-theme.git
-  revision: b1e43366e1fa7c7cd33a2213c6a9304f57536e8f
+  revision: 841025f8b27b7b66cb4a2661f0112d3151f49fa1
   specs:
     devdocs (16)
       jekyll (>= 4.0)
@@ -16,7 +16,7 @@ GEM
     algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
-    chef-utils (17.8.25)
+    chef-utils (17.9.26)
       concurrent-ruby
     colorator (1.1.0)
     concurrent-ruby (1.1.9)
@@ -27,25 +27,29 @@ GEM
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
     exifr (1.3.9)
-    faraday (1.8.0)
+    faraday (1.9.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
+      faraday-net_http_persistent (~> 1.0)
       faraday-patron (~> 1.0)
       faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.2)
+      multipart-post (>= 1.2, < 3)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
     ffi (1.15.4)
     filesize (0.2.0)
     forwardable-extended (2.6.0)
@@ -132,18 +136,18 @@ GEM
       mixlib-config (>= 2.2.1, < 4)
       mixlib-shellout
     mercenary (0.4.0)
-    mini_portile2 (2.6.1)
+    mini_portile2 (2.7.1)
     mixlib-cli (2.1.8)
     mixlib-config (3.0.9)
       tomlrb
     mixlib-shellout (3.2.5)
       chef-utils
     multipart-post (2.1.1)
     netrc (0.11.0)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
+    nokogiri (1.13.0)
+      mini_portile2 (~> 2.7.0)
       racc (~> 1.4)
-    nokogiri (1.12.5-x86_64-darwin)
+    nokogiri (1.13.0-x86_64-darwin)
       racc (~> 1.4)
     octokit (4.21.0)
       faraday (>= 0.9)
@@ -171,7 +175,7 @@ GEM
       faraday (> 0.8, < 2.0)
     terminal-table (2.0.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
-    thor (1.1.0)
+    thor (1.2.1)
     tomlrb (2.0.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
@@ -187,8 +191,8 @@ GEM
 PLATFORMS
   ruby
   x86-mswin32
-  x86_64-darwin-18
   x86_64-darwin-19
+  x86_64-darwin-21
 
 DEPENDENCIES
   devdocs!
@@ -209,4 +213,4 @@ DEPENDENCIES
   whatsup_github
 
 BUNDLED WITH
-   2.2.15
+   2.1.4

Rakefile

@@ -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

rakelib/test.rake

@@ -63,11 +63,16 @@ namespace :test do
     puts 'No issues found'.green
   end
 
-  desc 'Find unused images'
+  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'.magenta
-    images = Dir['src/**/*.{png,svg,jpeg,jpg,ico}']
+    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
@@ -76,33 +81,41 @@ namespace :test do
       images.delete_if { |image| File.read(file).include?(File.basename(image)) }
     end
 
-    abort 'No unlinked images' if images.empty?
-
-    images.each do |image|
-      puts "No links for #{image}".yellow
+    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
-    puts "Found #{images.size} dangling images".red
   end
 
-  desc 'Find unused includes'
+  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 = Dir['src/_includes/**/*']
+    includes = FileList['src/_includes/**/*']
+
     puts "The project contains a total of #{includes.size} includes"
-    puts 'The following includes are not linked:'
+
+    exclude = ENV['exclude_incl']
+    includes.exclude(/#{exclude}/) if exclude
+
     Dir['src/**/*.{md,html}'].each do |file|
-      # Exclude symmlinks
       next if File.symlink? file
 
       includes.delete_if { |include| File.read(file).include?(File.basename(include)) }
     end
 
-    abort 'No unlinked includes' if includes.empty?
-
-    includes.each do |include|
-      puts "No links for #{include}".yellow
+    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
-    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

src/_data/toc/release.yml

@@ -18,7 +18,7 @@ pages:
     versionless: true
 
   - label: Release policy
-    url: /release/policy
+    url: /release/policy/
     versionless: true
 
   - label: Lifecycle policy