There are quite a lot of new modules in Drupal 8.x without any hook_help() text (displayed by the Drupal Core Help module -- link can be found on the Modules list admin page). Also, many of the existing modules functionality has changed or been split up, and the hook_help() text from Drupal 7.x still in 8.x does not reflect this. In some cases, the module descriptions (in the .info files, displayed on the admin Modules list page) may also be incorrect.
This issue is critical in the sense that we should not release Drupal 8 without (a) each module having a help page and (b) that help page matching the current functionality of the module. Rather than marking each individual child issue as critical, this meta-issue is marked critical, and will be deemed fixed when all of its child issues are fixed.
In addition... It has been a while since our original assessment of all the modules. As of November 2014 we are in the "beta" phase and features should be frozen. So before we call this issue fixed, we need to review all the existing modules again. This is proposed in related issue.
On this meta-issue, we need to review each Drupal 8.x core module (see list below) and check for:
- Proofreading: Good grammar, clear writing, correct punctuation and spelling etc.
- Standards: Follows our standard help template, including correct URL syntax -- see http://drupal.org/node/632280
- Function: If there is already a patch, apply the patch. If not, test the existing help page. Test all the links manually to see if they go to the right place, and make sure that the formatting looks OK. You should be able to get to the help by navigating to admin/help and finding the module name in the list.
- Accuracy: Read the help text vs trying out what it tells you to do and make sure it's correct, and that page titles, field labels, tab labels, etc. that you see on the screen match with what is in the help text.
If you review a patch or an existing help page for any or all of the above, add a comment to the issue telling what you have checked. If you checked all 4 and it looks good, set the status to "reviewed and tested by the community" if there is a patch, and if it is still a "review existing help text" issue, add a note that the existing help is fine and mark the issue as "fixed".
a) List the core modules, and make sure each one has an issue to update its help. [done]
b) Get all the issues to "fixed" status [in progress]
c) Review the list below to ensure it is still complete & up-to-date (modules may have been added since the list was created 2 yrs ago
d) Before release, do another review of the help for each module to make sure that the help is in synch with the current UI. [should check this during the Beta phase, and have a sprint?]
Old list of issues
Please do not add to this list, which was maintained manually This is an older list of modules, before we had "parent/child issue" relationships. For active issues, see the "child issues" list on this page (right sidebar). There is no need to continue to update the issue list here, but not all the issues listed here are "children" of this issue, so this list is here for historical purposes.
If you find a new problem in a hook_help() for a Core module:
- If there is already an open issue, add a comment to that issue (and maybe a new patch)
- If the existing issue(s) for that module have all been marked "fixed" or "closed (fixed)", then open a new issue, and in the "Issue summary and metadata" section of the new issue, add this meta issue as its parent. Do not add it to the list below -- just adding this issue as a parent is enough -- it will appear in the sidebar of this issue so we can track it.
block: (also for possible comments)
editor: and and
forum: and follow-up
user: (see also: )