Document process plugins that this module introduces.

Created on 17 May 2022, over 2 years ago

Updated 21 September 2023, over 1 year ago

Problem/Motivation

While attempting to use this module's process plugins, with custom migrations, my colleagues found that much of the processing functionality of this module is undocumented either in the readme or within the process plugin file itself.

Steps to reproduce

Look in Readme here: https://git.drupalcode.org/project/media_migration/-/tree/8.x-1.x/

See no mention of the plugins that this module adds.

Process plugins:

ckeditor_link_file_to_linkit
file_entity_field_formatter_settings
file_entity_field_instance_settings
file_entity_field_settings
filter_settings_embed_media
ckeditor_link_file_to_linkit
img_tag_to_embed
media_image_field_instance_settings
media_internet_field_value
media_migrate_uuid
media_migration_delta_sort

This is the best documented one IMHO: https://git.drupalcode.org/project/media_migration/-/blob/8.x-1.x/src/Pl...
media_migration_delta_sort

Proposed resolution

Add process plugins to readme, add more inline documentation via code comments, with examples of how to use the plugin.

📌 Task

Status

Active

Version

1.0

Component

Documentation

Created by

🇺🇸United States trackleft2 Tucson, AZ 🇺🇸

Live updates comments and jobs are added and updated live.

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment over 1 year ago →

🇺🇸United States mortona2k Seattle

Some very important notes:

WysiwygMediaFilter plugin has extra config for transforming view modes and doing file/media migration lookups. These are not used in the generated migrations, but may be needed for customizations.

 * process:
 *   bar:
 *     plugin: media_wysiwyg_filter
 *     view_mode_matching:
 *       default: full
 *     media_migrations:
 *      - upgrade_d7_file_entity_archive
 *      - upgrade_d7_file_entity_image
 *      - upgrade_d7_file_entity_publication
 *     file_migrations:
 *      - upgrade_d7_file

ImgTagToEmbedFilter has a very hard to find config setting "migrations" for lookups.

plugin: img_tag_to_embed
migrations:
  - upgrade_d7_file_entity_image_public
  - upgrade_d7_file_entity_document_public
  - upgrade_d7_file_entity_default_public
  - upgrade_d7_file_entity_audio_public
  - upgrade_d7_file_entity_video_public
  - upgrade_d7_file_entity_video_youtube
  - upgrade_d7_file_entity_video_vimeo

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024