Migration

The project has migrated to the Adobe documentation infrastructure. The https://devdocs.magento.com/ website contains only 2.3 documentation after the migration and will be decommissioned soon. The 2.3 content will eventually move to https://magento.github.io/devdocs. All topics relevant to the 2.4 version redirect to new locations at the Adobe documentation websites.

Useful information

List of migrated topics

For the list of migrated topics and new locations, refer to https://devdocs.magento.com/migrated.html.

rake update:migrated_links_at

A new rake task update:migrated_links_at to facilitate the work on migration. It allows to find and replace the links to migrated topics in any source code directory.

rake update:migrated_links_at
    Find and replace links from 'tmp/migrated-from-to.csv' in files at the provided directory.
      Arguments:
      - 'dir' is an absolute path to the directory to process the links. Required.
      - 'exclude' is an fnmatch pattern for paths to exclude from processing. For fnmatch format, see https://ruby-doc.org/core-2.7.5/Dir.html#method-c-glob. Optional.
      Examples:
        rake update:migrated_links_at dir=path/to/codebase.
        rake update:migrated_links_at dir=path/to/codebase exclude='**/Test/**'

Prerequisite

Make sure, you have the tmp/migrated-from-to.csv file. If not, follow the guidelines:

1. Update the project: rake update:all
2. In your _config.local.yml:
   • Make sure nothing is excluded
   • Add the migrated_log: generate_file parameter
3. Run rake
4. Make sure, the tmp/migrated-from-to.csv file appeared in your local system

General use

1. Find any magento2 codebase in your system and copy full path to it. Make sure to stage, commit, or stash any changes in the magento2 codebase, because the tool you will run changes the content.
2. In your devdocs project, run the rake task. (Replace the /path/to/your/magento2/codebase with the actual path to the magento2 codebase)

   rake update:migrated_links_at dir=/path/to/your/magento2/codebase
   

3. Use git tools or IDE extensions to view the changes in your magento2 codebase