From 9b956781b324fae1d5743e81a29d3f0f9e77ecc5 Mon Sep 17 00:00:00 2001 From: volkswagenchick Date: Sun, 10 Mar 2019 16:38:24 -0400 Subject: [PATCH] Issue #3037461 by volkswagenchick: Readme - list dependencies and recommended modules --- README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 65 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 8a87056..58af37d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,53 @@ -# Migrate Devel +CONTENTS OF THIS FILE +--------------------- -Adds new options to `drush migrate-import` which -allows developers to debug their migrations. + * Introduction + * Requirements + * Recommended modules + * Installation + * Configuration + * Maintainers -`drush migrate-import` comes from either the -[migrate_tools](https://www.drupal.org/project/migrate_tools) or the -[migrate_run](https://www.drupal.org/project/migrate_run) modules. + +INTRODUCTION +------------ + +The Migrate Devel module adds utilities to help out developers when creating +migrations. + + * For a full description of the module, visit the project page: + https://drupal.org/project/migrate_devel + + * To submit bug reports and feature suggestions, or to track changes: + https://drupal.org/project/issues/migrate_devel + + +REQUIREMENTS +------------ + +This module requires the modules outside of Drupal core: + + * [devel](https://www.drupal.org/project/devel) + + +RECOMMENDED MODULES +------------------- + + * [migrate_tools](https://www.drupal.org/project/migrate_tools) + * [migrate_run](https://www.drupal.org/project/migrate_run) + * [config_update](https://www.drupal.org/project/config_update) + * [migrate_plus](https://www.drupal.org/project/migrate_plus) + + +INSTALLATION +------------ + + * Install as you would normally install a contributed Drupal module. Visit: + https://www.drupal.org/node/1897420 for further information. + + +CONFIGURATION +------------- Currently uses Kint (from devel) directly to print out debug information instead of devel in order to take advantage of @@ -13,11 +55,21 @@ cli coloring and named variable debugging. Options are: -* `--migrate-debug` - Prints out rows as they run. -Can be used in `migrate-import` or `migrate-status` and will revert -existing migrations to the default and clear the cache for them. -This requires [config_update](https://www.drupal.org/project/config_update) -if you use [migrate_plus](https://www.drupal.org/project/migrate_plus) -because migrations go into config. +* `--migrate-debug` - Prints out rows as they run. + Can be used in `migrate-import` or `migrate-status` and will revert + existing migrations to the default and clear the cache for them. + This requires [config_update](https://www.drupal.org/project/config_update) + if you use [migrate_plus](https://www.drupal.org/project/migrate_plus) + because migrations go into config. * `--migrate-debug-pre` - Same as above before the process is run on the row. -Can be used in `migrate-import`. + Can be used in `migrate-import`. + + +MAINTAINERS +----------- + +Current maintainers: + * [Dave Wikoff (Derimagia)](https://www.drupal.org/u/derimagia) + +This project is sponsored by: + * [Mindgrub Technologies](https://www.drupal.org/mindgrub-technologies) -- GitLab