Add a generator for the Migrated topics page

Group migrated topics by guide

Add a link to the migrated log onto the banner

rubocop's auto-fixes

Author: dshevtsov

_checks/html_check_hook.rb

@@ -11,7 +11,7 @@
 #
 require 'html-proofer'
 require 'yaml'
-require_relative '../lib/double_slash_check.rb'
+require_relative '../lib/double_slash_check'
 
 Jekyll::Hooks.register :site, :post_write do |site|
   # Do nothing unless 'site.check_links' is set

_plugins/generators/migrated_log.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Copyright © Adobe, Inc. All rights reserved.
+# See COPYING.txt for license details.
+
+# This plugin generates the page that contains a list of migrated topics.
+#
+
+module Jekyll
+  # Custom generator for MRG pages
+  class MigratedLog < Generator
+    safe true
+
+    def generate(site)
+      # Make the site object available in any scope in this class.
+      @site = site
+      migrated_pages = @site.pages.filter { |page| page.data['layout'] == 'migrated' }
+
+      url_prefix = site.config['url'] + site.config['baseurl']
+
+      migrated_pages_data = []
+      migrated_pages.each do |page|
+        migrated_page = {
+          path: page.path,
+          title: page.data['title'],
+          guide: @site.data['toc'][page.data['group']]['label'],
+          migrated_from: url_prefix + page.url,
+          migrated_to: page.data['migrated_to']
+        }
+        migrated_pages_data << migrated_page
+      end
+
+      migrated_pages_by_group = migrated_pages_data.group_by { |page| page[:guide] }
+
+      content = "The folowing is the list of topics that have been migrated and will be redirected soon.\n\n"
+      migrated_pages_by_group.each do |guide, topics|
+        content += "\n## #{guide}\n\n\n"
+        topics.sort_by { |topic| topic[:title] }
+              .each do |topic|
+          content += "1. [#{topic[:title]}](#{topic[:migrated_from]}) has moved to <#{topic[:migrated_to]}>\n"
+        end
+      end
+
+      # PageWithoutAFile handles processing files without reading it.
+      # 'migrated.md' is a virtual file that's been created during Jekyll run.
+      # See details in https://www.rubydoc.info/gems/jekyll/Jekyll/PageWithoutAFile
+      # See tests in https://github.com/jekyll/jekyll/blob/master/test/test_page_without_a_file.rb
+      topic = PageWithoutAFile.new(
+        @site,
+        @site.source,
+        '.',
+        'migrated.md'
+      )
+      topic.content = content
+      topic.data['title'] = 'Migrated topics'
+      topic.data['layout'] = 'full-width'
+      topic.data['github_link'] = false
+      topic.data['feedback_link'] = false
+      topic.process('migrated.md')
+
+      # Add the newly constructed page object to the rest of pages
+      # on the site.
+      @site.pages << topic
+    end
+  end
+end

lib/doc_config.rb

@@ -6,6 +6,7 @@
 # Read Docfile file and get configuration data for adding subrepositories
 class DocConfig
   attr_reader :config
+
   def initialize(config_file = 'Docfile.yml')
     @config = YAML.load_file(config_file)
   end

lib/link_checker.rb

@@ -40,6 +40,6 @@ def self.current_branch
   def self.file_name
     prefix = 'broken-links-in-'
     timestamp = Time.now.strftime('_%m-%d_%H-%M-%S')
-    prefix + current_branch + timestamp + '.md'
+    "#{prefix}#{current_branch}#{timestamp}.md"
   end
 end

rakelib/check.rake

@@ -14,7 +14,9 @@ namespace :check do
       puts 'Looking in uncommitted files ...'.blue
       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 }
+      image_files_to_check = (modified_files - deleted_files).select do |file|
+        File.extname(file) =~ /\.(png|jpg|jpeg|gif)/i
+      end
 
       next puts 'No images to check.'.magenta if image_files_to_check.empty?
 

rakelib/multirepo.rake

@@ -8,7 +8,7 @@ namespace :multirepo do
   task :init do
     protocol = ENV['token'] ? "https://#{ENV['token']}@github.com/" : 'git@github.com:'
     @content_map.each do |subrepo|
-      repo_url = protocol + subrepo['repository'] + '.git'
+      repo_url = "#{protocol}#{subrepo['repository']}.git"
       add_subrepo(subrepo['directory'], repo_url, subrepo['branch'], subrepo['filter'])
     end
   end

rakelib/test.rake

@@ -115,7 +115,7 @@ namespace :test do
         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  
+      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

src/_layouts/migrated.html

@@ -8,7 +8,8 @@
 		<div class="content-wrap">
 			<header class="content-header">
 				<div class="message-banner">
-					<b>This page has <a href="{{ page.migrated_to }}">moved</a> and will be redirected soon.</b>
+					<b>This page has <a href="{{ page.migrated_to }}">moved</a> and will be redirected soon. See <a href="{{ site.baseurl }}/migrated.html">Migrated topics</a> for the complete list.</b>
+					
 				</div>
 				{% include layout/page-header.html %}
 			</header>