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

Files: 
CommentFileSizeAuthor
#2 help-function-2-2161793.patch1.2 KBarrrgh
PASSED: [[SimpleTest]]: [MySQL] 63,087 pass(es).
[ 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

Status:Active» Needs review
StatusFileSize
new1.2 KB
PASSED: [[SimpleTest]]: [MySQL] 63,087 pass(es).
[ View ]

A lot of work obviously happening right now with migrate(), so not much to be added. Have attached a brief patch with the most current summary of help I could find.

Have not added a help link to /admin/structure/migrate as there appears to be no UI for the current version module.

Might need more work once the module matures. (see also #2161797: Create hook_help for migrate drupal module)

jhodgdon’s picture

Status:Needs review» Postponed

We should probably postpone this issue until the Migrate module and its UI are stable.

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.

catch’s picture

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.

mikeryan’s picture

Title:Create hook_help for migrate module» Create hook_help for migrate_upgrade module
Project:Drupal core» Migrate Upgrade
Version:8.x-dev»
Component:migration system» Documentation
Status:Postponed» Active

No UI for migrate in core yet - the work that will eventually go into core is in the Migrate Upgrade sandbox.

jhodgdon’s picture

Title:Create hook_help for migrate_upgrade module» Create hook_help for migrate module
Project:Migrate Upgrade» Drupal core
Version:» 8.x-dev
Component:Documentation» migration system
Status:Active» Postponed
Issue tags:+revisit before release candidate

Sorry, but there is a core module with machine name "migrate". Whether or not it has a UI, it still needs to have a hook_help() and it currently doesn't have a hook_help(). Missing hook_help() is a critical or at least major issue, because it is required for the Documentation gate.

So we still need this issue in core -- either core/modules/migrate will need to be removed, or it will need a hook_help before release. Please create a new issue for the migrate_upgrade module in the sandbox, and leave this one where it was. Thanks!

benjy’s picture

Issue tags:+Novice
batigolix’s picture

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

Untagging and making a child of the migrate criticals meta instead.

jhodgdon’s picture

Um. We still want this related to the hook_help() meta even if it's not a parent, and what's the "migrate criticals meta"?

catch’s picture

I meant to change the parent to #2297213: [meta] Ensure that there are no critical Migrate issues before releasing the migration path and make the hook_help() related, but apparently failed to do either of those things.

jhodgdon’s picture

benjy’s picture

So, if this issue is critical and blocks release does that mean that Migrate would be removed from core before release if the UI wasn't ready but the D6/D7->D8 API's were completed and runnable from Drush?

Whether or not it has a UI, it still needs to have a hook_help() and it currently doesn't have a hook_help().

This implies that we can just add a hook_help() to the existing Migrate module but I'm not sure how we would go about that without providing a URL since that is the key for hook_help() per https://www.drupal.org/node/632280

jhodgdon’s picture

Which URL are you talking about?

The About section, according to the standard, does need to link to a page named drupal.org/documentation/modules/migrate, but we can create this after the hook_help() is created.

Also we should probably at least make a "Uses" section that says something like "In order to migrate you need to either get the Foo contrib module that has a UI, or use Drush. Instructions are at drupal.org/foo." and make Foo, Drush, and drupal.org/foo be links.

catch’s picture

@benjy no I don't think it means that but we'd want to make sure the UI was disabled and possibly hide migrate module on the modules page (so it can only be enabled via drush).

benjy’s picture

Which URL are you talking about?

The URL at the end of my comment: https://www.drupal.org/node/632280

OK, great I just wanted to confirm that Migrate's inclusion in core upon release wasn't dependant entirely on the UI been completed, although it is very much a high priority.

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 module not hidden. It is not Critical if we release without the Migrate 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 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.