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

Files: 
CommentFileSizeAuthor
#21 interdiff-2161797-16-20.txt1.57 KBboris sondagh
#21 help-text-Migrate-Drupal-Module-2161797-20.patch1.51 KBboris sondagh
FAILED: [[SimpleTest]]: [PHP 5.4 MySQL] Unable to apply patch help-text-Migrate-Drupal-Module-2161797-20.patch. Unable to apply patch. See the log in the details link for more information.
[ View ]
#18 help-text-Migrate-Drupal-Module-2161797-18.patch1.39 KBboris sondagh
FAILED: [[SimpleTest]]: [PHP 5.4 MySQL] Setup environment: Test cancelled by admin prior to completion.
[ View ]
#10 migrate_drupal-help-text-2161797-10.patch1.04 KBamitgoyal
FAILED: [[SimpleTest]]: [PHP 5.4 MySQL] Unable to apply patch migrate_drupal-help-text-2161797-10.patch. Unable to apply patch. See the log in the details link for more information.
[ View ]
#6 migrate_drupal-help-text-2161797-6.patch686 bytesmfernea
PASSED: [[SimpleTest]]: [MySQL] 63,159 pass(es).
[ View ]
#3 help-function-3-2161797.patch719 bytesarrrgh
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch help-function-3-2161797.patch. Unable to apply patch. See the log in the details link for more information.
[ View ]

Comments

jhodgdon’s picture

Priority:Normal» Critical
Status:Needs work» Active

"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.

arrrgh’s picture

Assigned:Unassigned» arrrgh

Will have a first pass at help docs for this during today's code sprint.

Will un-assign myself at end of day

arrrgh’s picture

Assigned:arrrgh» Unassigned
Status:Active» Needs review
StatusFileSize
new719 bytes
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch help-function-3-2161797.patch. Unable to apply patch. See the log in the details link for more information.
[ View ]

Bit of a moving target regarding documentation... but have attached the briefest of patches. Will need review once the functionality of migrate_drupal has matured.

Status:Needs review» Needs work

The last submitted patch, 3: help-function-3-2161797.patch, failed testing.

mfernea’s picture

I'll try to fix the patch.

mfernea’s picture

Status:Needs work» Needs review
StatusFileSize
new686 bytes
PASSED: [[SimpleTest]]: [MySQL] 63,159 pass(es).
[ View ]

I'm uploading the patch fixed.
I also modified the coding style a little bit to match other modules.

jhodgdon’s picture

Status:Needs review» Postponed

I 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.

catch’s picture

Priority:Critical» Major

Since 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.

jhodgdon’s picture

We 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.

amitgoyal’s picture

StatusFileSize
new1.04 KB
FAILED: [[SimpleTest]]: [PHP 5.4 MySQL] Unable to apply patch migrate_drupal-help-text-2161797-10.patch. Unable to apply patch. See the log in the details link for more information.
[ View ]

@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.

batigolix’s picture

Issue tags:+documentation, +sprint
jhodgdon’s picture

Instead 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.

boris sondagh’s picture

Status:Postponed» Active

The Migrate Drupal is in Core, so it needs a help text.
Working on this.

jhodgdon’s picture

Priority:Major» Critical

Yes, 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.

webchick’s picture

Status:Active» Needs work

Indicating that there is a patch here, it just needs work.

benjy’s picture

Yes, and it's also a non-hidden module now.

What does that mean?

jhodgdon’s picture

What it means is that any module that a Drupal user can see on the Modules page ("non-hidden") must have help before release.

boris sondagh’s picture

Status:Needs work» Needs review
Issue tags:+drupaldevdays
StatusFileSize
new1.39 KB
FAILED: [[SimpleTest]]: [PHP 5.4 MySQL] Setup environment: Test cancelled by admin prior to completion.
[ View ]

Old patch failed to apply so redid it, no interdiff.

jhodgdon’s picture

Status:Needs review» Needs work

Pretty close! Just a couple of small things to fix:

  1. +++ b/core/modules/migrate_drupal/migrate_drupal.module
    @@ -1,6 +1,12 @@
    + * Extends the Migrate API the enable migrations from other Drupal versions.

    How about just:

    Provides migration from other Drupal sites.

  2. +++ b/core/modules/migrate_drupal/migrate_drupal.module
    @@ -1,6 +1,12 @@
    + */
    +use Drupal\Core\Routing\RouteMatchInterface;
    +

    I think we need a blank line added before the use statement here.

  3. We have a standard help template that starts with "The Foo Bar module does foo with bar...". This just needs to start with "The Migrate Drupal module provides..." or something like that.
  4. "to ease building migrations from..." How about "to facilitate migration from"?
  5. "(6, 7 and 8) " ==> We use serial commas in the Drupal project, so there needs to be a comma after 7 here.
  6. Maybe it should mention there is no user interface?
keopx’s picture

Assigned:Unassigned» keopx
boris sondagh’s picture

Assigned:keopx» Unassigned
Status:Needs work» Needs review
StatusFileSize
new1.51 KB
FAILED: [[SimpleTest]]: [PHP 5.4 MySQL] Unable to apply patch help-text-Migrate-Drupal-Module-2161797-20.patch. Unable to apply patch. See the log in the details link for more information.
[ View ]
new1.57 KB

with the latest changes

The last submitted patch, 18: help-text-Migrate-Drupal-Module-2161797-18.patch, failed testing.

ifrik’s picture

Status:Needs review» Reviewed & tested by the community

Thanks 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.

webchick’s picture

Status:Reviewed & tested by the community» Fixed

Awesome work!!

Committed and pushed to 8.0.x. Thanks!

  • webchick committed 8e7de1c on 8.0.x
    Issue #2161797 by boris sondagh, mfernea, arrrgh, amitgoyal: Create...

Status:Fixed» Needs work

The last submitted patch, 21: help-text-Migrate-Drupal-Module-2161797-20.patch, failed testing.

The last submitted patch, 10: migrate_drupal-help-text-2161797-10.patch, failed testing.

Berdir’s picture

Status:Needs work» Fixed

Testbot, you're a bit late.

Status:Fixed» Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.