From 16ff6e093af87ca8b09fb231d84a6f81b3dcaedd Mon Sep 17 00:00:00 2001 From: HongPong <hongpong@hongpong.com> Date: Wed, 27 Nov 2024 00:23:09 -0500 Subject: [PATCH] Update README.md and .cspell dictionary for documentation, security notice and contributors --- .cspell-project-words.txt | 16 ++++++++++++++++ README.md | 36 +++++++++++++++++++++++++++--------- 2 files changed, 43 insertions(+), 9 deletions(-) diff --git a/.cspell-project-words.txt b/.cspell-project-words.txt index 38910c0..b2f352f 100644 --- a/.cspell-project-words.txt +++ b/.cspell-project-words.txt @@ -40,3 +40,19 @@ vlad.dancer ressa msielski baltowen +msielski +ressa +damienmckenna +splash112 +caspervoogt +ivrh +tabestan +bserem +apmsooner +dinarcon +mithun-a-sridharan +ryumaou +tolstoydotcom +lobodakyrylo +uridrupal +vaidas_a diff --git a/README.md b/README.md index 680782f..32dc0b1 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,8 @@ composer require 'drupal/wordpress_migrate:^3.0@alpha' ## Migrate via User Interface Wizard Enabling the WordPress Migrate UI module. This creates an -"Add import from WordPress" button on the migrate_tools UI at **/admin/structure/migrate** . From there a wizard prompts you -for the configuration options. +"Add import from WordPress" button on the migrate_tools UI at **/admin/structure/migrate** . From there a wizard +prompts you for the configuration options. Enter 'Base url of the WordPress site' into the first stage of the wizard to automatically generate permalinks to the new content nodes. @@ -54,8 +54,7 @@ imported and reversed as needed. ## Importing Image Assets -For the new importation of attached images including post thumbnails -(also known as featured images) you should: +For the new importation of attached images including post thumbnails (also known as featured images) you should: - Assign an image field for these assets in the migrate process. - Before importing the content posts, import the media assets. @@ -68,6 +67,21 @@ Important: While image assets can be imported to the Drupal filesystem, the paths of inline images from the WordPress body are not rewritten. See issue: <https://drupal.org/project/wordpress_migrate/issues/2742279> +## Security Note + +Existing users (keyed by email address) will not be overwritten if imported. +new [access checks](https://www.drupal.org/node/3201242) are allowed in entity lookups during the migrate +process. + +Our module assumes the operator of the migration is an administrator who has access to all entities. Also, +this module can create new users (WordPress post authors) which are set to "active" so be sure to review your users +after the migration is completed. + +Importing posts and comments can potentially include harmful JavaScript snippets or other malicious materials. We +recommend you carefully review all imported content for security issues from unsanitized markup. + +The module can be disabled and its data deleted after your migration is complete. It does not need to stay enabled. + ## API You may also programmatically configure a set of WordPress migrations by @@ -110,7 +124,7 @@ Drush 8 code has been removed as it is no longer supported. - Your support, questions and contributions are welcome. Please try to provide example files to help reproduce errors and notices: <https://drupal.org/project/issues/wordpress_migrate> -- Plan for 8.x-3.x beta release: +- **Plan for 8.x-3.x beta release:** (The current main plan) <https://drupal.org/project/wordpress_migrate/issues/2904990> - Comment migration may need to set a body text format: <https://drupal.org/project/wordpress_migrate/issues/2742311> @@ -125,20 +139,24 @@ Drush 8 code has been removed as it is no longer supported. ### Similar projects -[WordPress Migrate SQL](https://www.drupal.org/project/wordpress_migrate_sql): Enables customized migrations based on WordPress SQL sites, allowing migration of complex WordPress sites, using a SQL source. [wp_migrate](https://www.drupal.org/project/wp_migrate) is another module which is compatible with up to Drupal 9. +**[WordPress Migrate SQL](https://www.drupal.org/project/wordpress_migrate_sql):** Enables customized migrations based on WordPress SQL sites, +allowing migration of complex WordPress sites, using a SQL source. +**[wp_migrate](https://www.drupal.org/project/wp_migrate)** is another module which is compatible with up to Drupal 9. ## Credits -Current co-maintainer: +**Current co-maintainer:** - [HongPong](https://drupal.org/u/HongPong) Originally developed for Drupal 7 and 8 by [mikeryan](https://drupal.org/u/mikeryan). -Committers include: +**Committers and active volunteers have included:** somersoft, lomasr, chaitanya17, felribeiro, maccath, MaskyS, mrmikedewolf, Darren Shelley, dwillems, othermachines, ohthehugemanatee, ezeedub, grasmash, bdone, queenvictoria, ksenzee, ptaff, pverrier, xurizaemon, hekele, aaron, emarchak, wizonesolutions, baltowen, msielski, ressa, vlad.dancer, nitapawar, phjou, el7cosmos, batonac, stargayte, darchuletajr, -e.ruiter, ankshetty, i.vuchkov, sahana16081996, marktonino, john_b, frederickjh +e.ruiter, ankshetty, i.vuchkov, sahana16081996, marktonino, john_b, frederickjh, +damienmckenna, splash112, caspervoogt, ivrh, tabestan, bserem, apmsooner, dinarcon, +mithun-a-sridharan, ryumaou, tolstoydotcom, uridrupal, lobodakyrylo, vaidas_a, ryumaou -- GitLab