Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Background:
This issue is part of the task to update/create the hook_help texts of the modules for Drupal 8:
#1908570: [meta] Update or create hook_help() texts for D8 core modules
Tasks:
- write the hook_help function
- review d.o. docs at https://drupal.org/documentation/modules/migrate_drupal
Comment | File | Size | Author |
---|---|---|---|
#21 | interdiff-2161797-16-20.txt | 1.57 KB | botris |
#21 | help-text-Migrate-Drupal-Module-2161797-20.patch | 1.51 KB | botris |
#18 | help-text-Migrate-Drupal-Module-2161797-18.patch | 1.39 KB | botris |
#10 | migrate_drupal-help-text-2161797-10.patch | 1.04 KB | amitgoyal |
#6 | migrate_drupal-help-text-2161797-6.patch | 686 bytes | mfernea |
Comments
Comment #1
jhodgdon"needs work" status means that there is a patch that needs work. "active" means an issue where work has not started yet.
And if there is not any help at all for this module, that makes it a "critical" issue as it is a violation of the documentation gate.
Comment #2
robcarrWill have a first pass at help docs for this during today's code sprint.
Will un-assign myself at end of day
Comment #3
robcarrBit of a moving target regarding documentation... but have attached the briefest of patches. Will need review once the functionality of migrate_drupal has matured.
Comment #5
mfernea CreditAttribution: mfernea commentedI'll try to fix the patch.
Comment #6
mfernea CreditAttribution: mfernea commentedI'm uploading the patch fixed.
I also modified the coding style a little bit to match other modules.
Comment #7
jhodgdonI think the earlier comment about this being a moving target is right. Let's postpone this issue until the UI for the MIgrate Drupal module is a bit more settled.
Comment #8
catchSince migrate doesn't block release (we may release with it 'hidden' or similar), a hook_help() shouldn't block it either, so I'm going to downgrade to major. The hook_help() should block whichever release has a migration path in it so we can move it back to critical then.
Comment #9
jhodgdonWe just had a change to hook_help, on this issue: #2183113: Update hook_help signature to use route_name instead of path.
Here is the change record: https://drupal.org/node/2250345
This patch will need a reroll for this change.
Comment #10
amitgoyal CreditAttribution: amitgoyal commented@jhodgdon - Based on #9, I have made the changes in attached patch. The last patch was also not working with current code so made the required changes there as well.
Comment #11
batigolixComment #12
jhodgdonInstead of having one critical parent issue I have been asked to change the status of each child issue (child of the hook_help() issue that is).
This issue will be Critical if D8 releases with the Migrate Drupal module not hidden. It is not Critical if we release without the Migrate Drupal module. So I'll just leave it as Major/Postponed for now...
In my opinion the About section of the hook_help() should be written anyway, whether the Migrate Drupal module ends up as a hidden drush-only module or not, but catch doesn't think we should bother in that case. I think it can't hurt.
Comment #13
botrisThe Migrate Drupal is in Core, so it needs a help text.
Working on this.
Comment #14
jhodgdonYes, and it's also a non-hidden module now. Not having Help at all is a violation of our docs gate, and is actually considered Critical, since our policy is that every module available to users in Core must have help before we release.
Extra credit in the patch if you add a @file doc block to migrate_drupal.module, which currently is missing that.
Comment #15
webchickIndicating that there is a patch here, it just needs work.
Comment #16
benjy CreditAttribution: benjy at CodeDrop commentedWhat does that mean?
Comment #17
jhodgdonWhat it means is that any module that a Drupal user can see on the Modules page ("non-hidden") must have help before release.
Comment #18
botrisOld patch failed to apply so redid it, no interdiff.
Comment #19
jhodgdonPretty close! Just a couple of small things to fix:
How about just:
Provides migration from other Drupal sites.
I think we need a blank line added before the use statement here.
Comment #20
keopxComment #21
botriswith the latest changes
Comment #23
ifrikThanks Boris,
this looks good. The link to the Migrate module currently does not work, but that is correct because that help text is still missing, and since Migrate is a required module it doesn't need to check whether the module is there.
The link to the online documentation works.
Comment #24
webchickAwesome work!!
Committed and pushed to 8.0.x. Thanks!
Comment #28
BerdirTestbot, you're a bit late.