Merge pull request magento-commerce/devdocs#3230

Update the migration log generator

Author: dshevtsov

.gitignore

@@ -27,6 +27,4 @@ _algolia_api_key
 
 /src/mbi/
 /src/page-builder/
-/src/page-builder-migration/
-/src/guides/m1x/
 /src/mftf/

_plugins/generators/migrated_log.rb

@@ -4,12 +4,15 @@
 # See COPYING.txt for license details.
 
 # This plugin generates the page that contains a list of migrated topics: https://devdocs.magento.com/migrated.html
-# Also, it adds global data:
+# It adds global data:
 #   - site.data.migration.migrated_pages
 #   - site.data.migration.deprecated_pages
 #   - site.data.migration.all_migrating_pages
 #   - site.data.migration.remained_migrating_pages
 #
+# And generates the `tmp/migrated-from-to.csv` file with the list of links "from" and "to" for the migrated pages.
+# To enable the file generation, add 'migrated_log: generate_file' to _config.local.yml.
+#
 
 module Jekyll
   # Custom generator for MRG pages
@@ -19,14 +22,21 @@ class MigratedLog < Generator
     def generate(site)
       @site = site
       pages = @site.pages
-      migrated_pages = pages.select { |page| page.data['layout']&.include? 'migrated' }
+      migrated_pages = pages.select { |page| page.data['status']&.include? 'migrated' }
       v2_3_pages = pages.select { |page| page.data['guide_version'] == '2.3' }
       remained_pages = pages - v2_3_pages
-      deprecated_pages = remained_pages.select { |page| page.data['group'].nil? || page.data['redirect_to'] }
+      deprecated_pages = remained_pages.select { |page| page.data['group'].nil? || (page.data['redirect_to'] && !page.data['status']) }
       all_migrating_pages = remained_pages - deprecated_pages
       remained_migrating_pages = all_migrating_pages - migrated_pages
       migrated_pages_data = []
 
+      if (site.config['migrated_log']&.include? 'generate_file')
+        # Create a CSV file that contains links 'from' and 'to' for migrated pages
+        migrated_pages = pages.select { |pages| pages.data['status']&.include? 'migrated' }
+        redirects = migrated_pages.map { |page| "https://devdocs.magento.com#{page.data['redirect']['from']},#{page.data['redirect']['to']}" }
+        File.write('tmp/migrated-from-to.csv', redirects.join("\n"))
+      end
+
       # Create an array of JSON objects that contain metadata for migrated pages
       migrated_pages.each do |page|
         migrated_page = {
@@ -39,27 +49,27 @@ def generate(site)
                                   'label') || abort("Error in '#{page.path}'.\n Check 'group' in the file's frontmatter or 'label' in the corresponding TOC.".red)
                  end,
           migrated_from: site.baseurl + page.url,
-          migrated_to: page.data['migrated_to'] || abort("Error in '#{page.path}'.\n Check 'migrated_to' in the file's frontmatter.".red),
-          migrated_to_source: if page.data['migrated_to'].start_with?('https://experienceleague.adobe.com')
-                                'Adobe Experience League'
-                              elsif page.data['migrated_to'].start_with?('https://developer.adobe.com')
-                                'Adobe Developer'
-                              else
-                                abort "Error in '#{page.path}'.\nThe 'migrated_to' parameter in the front matter points to the wrong domain: #{page.data['migrated_to']}.\nShould be 'https://experienceleague.adobe.com' or 'https://developer.adobe.com'".red
-                              end
+          redirected_to: page.data['redirect_to'] || abort("Error in '#{page.path}'.\n Check 'redirect_to' in the file's frontmatter.".red),
+          redirected_to_source: if page.data['redirect_to'].start_with?('https://experienceleague.adobe.com')
+                                  'Adobe Experience League'
+                                elsif page.data['redirect_to'].start_with?('https://developer.adobe.com')
+                                  'Adobe Developer'
+                                else
+                                  abort "Error in '#{page.path}'.\nThe 'redirected_to' parameter in the front matter points to the wrong domain: #{page.data['redirect_to']}.\nShould be 'https://experienceleague.adobe.com' or 'https://developer.adobe.com'".red
+                                end
         }
         migrated_pages_data << migrated_page
       end
 
       # Group migrated pages by guide
       migrated_pages_by_group = migrated_pages_data.group_by { |page| page[:guide] }.sort.to_h
       # Introductory text in the Migrated topics page
-      content = "The folowing #{migrated_pages.size} topics out of #{all_migrating_pages.size} have been migrated and will be redirected soon.\n\n"
+      content = "The following #{migrated_pages.size} topics have been migrated and redirected.\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_source]}](#{topic[:migrated_to]})\n"
+          content += "1. [#{topic[:title]}](#{topic[:migrated_from]}) has moved to [#{topic[:redirected_to_source]}](#{topic[:redirected_to]})\n"
         end
       end
 

src/catalog-service/index.md

@@ -3,7 +3,7 @@ group: catalog-service
 title: Catalog Service for Adobe Commerce
 ee_only: True
 redirect_to: https://experienceleague.adobe.com/docs/commerce-merchant-services/catalog-service/overview.html
-layout: migrated
+status: migrated
 ---
 
 Catalog Service uses GraphQL queries to provide rich view-model (read-only) catalog data to quickly and fully render product-related content on storefront, including product detail pages and product list pages. Catalog Service, along with [Live Search]({{site.baseurl}}/live-search/overview.html), each implement queries that return information that is not available to the [`products` query]({{site.baseurl}}/guides/v2.4/graphql/queries/products.html) on Adobe Commerce and Magento Open Source. For example, the Catalog Service [`products` query](products.html) treats all products as either simple or complex. Simple products have a single price, while complex products have a price range. The Live Search [`productSearch` query](../live-search/product-search.html) returns detailed facet information.

src/catalog-service/products.md

@@ -3,7 +3,7 @@ group: catalog-service
 title: products query
 ee_only: True
 redirect_to: https://developer.adobe.com/commerce/webapi/graphql/schema/catalog-service/queries/products/
-layout: migrated
+status: migrated
 ---
 
 The Catalog Service for Adobe Commerce `products` query returns details about the SKUs specified as input. Although this query has the same name as  the [`products` query]({{site.baseurl}}/guides/v2.4/graphql/queries/products.html) that is provided with core Adobe Commerce and Magento Open Source, there are some differences.

src/catalog-service/productsearch.md

@@ -3,7 +3,7 @@ group: catalog-service
 title: productSearch query
 ee_only: True
 redirect_to: https://developer.adobe.com/commerce/webapi/graphql/schema/catalog-service/queries/product-search/
-layout: migrated
+status: migrated
 ---
 
 The Catalog Service for Adobe Commerce `productSearch` query can use LiveSearch to return details about the SKUs specified as input. Although this query is the same  as the [`productSearch` query]({{site.baseurl}}/live-search/product-search.html), LiveSearch returns a `productView` object. See the [`productSearch` query]({{site.baseurl}}/live-search/product-search.html) topic for reference information.

src/catalog-service/refine-product.md

@@ -3,7 +3,7 @@ group: catalog-service
 title: refineProduct query
 ee_only: True
 redirect_to: https://developer.adobe.com/commerce/webapi/graphql/schema/catalog-service/queries/refine-product/
-layout: migrated
+status: migrated
 ---
 
 The `refineProduct` query narrows the results of a `products` query that was run against a complex product. Before you run the `refineProduct` query, you must run the `products` query and construct the response so that it returns a list of `options` within a `ComplexProductView` inline fragment. When a shopper selects a product option (such as size or color) on the storefront, run the `refineProduct` query, specifying the SKU and selected option value IDs as input. Depending on the number of product options the complex product has, you might need to run the `refineProduct` query multiple times, until the shopper has selected a specific variant.

src/cloud/architecture/cloud-architecture.md

@@ -6,7 +6,7 @@ functional_areas:
 redirect_from:
   - /cloud/basic-information/cloud-plans.html
 redirect_to: https://experienceleague.adobe.com/docs/commerce-cloud-service/user-guide/architecture/cloud-architecture.html
-layout: migrated
+status: migrated
 ---
 
 {{site.data.var.ece}} has a Starter and a Pro plan. Each plan has a unique architecture to drive your {{site.data.var.ee}} development and deployment process. Both the Starter plan and the Pro plan architecture deploy databases, web server, and caching servers across multiple environments for end-to-end testing while supporting continuous integration.

src/cloud/architecture/pro-architecture.md

@@ -8,7 +8,7 @@ redirect_from:
 functional_areas:
   - Cloud
 redirect_to: https://experienceleague.adobe.com/docs/commerce-cloud-service/user-guide/architecture/pro-architecture.html
-layout: migrated
+status: migrated
 ---
 
 Your {{site.data.var.ece}} Pro architecture supports multiple environments that you can use to develop, test, and launch your store.

src/cloud/architecture/pro-develop-deploy-workflow.md

@@ -8,7 +8,7 @@ redirect_from:
 functional_areas:
   - Cloud
 redirect_to: https://experienceleague.adobe.com/docs/commerce-cloud-service/user-guide/architecture/pro-develop-deploy-workflow.html
-layout: migrated
+status: migrated
 ---
 
 The {{site.data.var.ece}} Pro plan includes a single Git repository with a Global Master and three main environments: the **Integration** environment for development and testing, the **Staging** environment for testing with all services, and the **Production** environment for launching and maintaining your live site. See [Pro architecture]({{ site.baseurl }}/cloud/architecture/pro-architecture.html) for an overview.

src/cloud/architecture/scaled-architecture.md

@@ -4,7 +4,7 @@ title: Scaled architecture
 functional_areas:
   - Cloud
 redirect_to: https://experienceleague.adobe.com/docs/commerce-cloud-service/user-guide/architecture/scaled-architecture.html
-layout: migrated
+status: migrated
 ---
 
 The Cloud infrastructure scales according to your resource needs to achieve greater efficiency. The {{site.data.var.ece}} monitors your applications and can adjust capacity to maintain steady, predictable performance. Converting to this architecture helps to mitigate problems, such as latency or large spikes in traffic.