Problem/Motivation
As part of #3031642: Deprecate hook_help() and combine with Topics, we need to convert the module overview help for each core module, located in the hook_help() implementation, into one or more help topics. This meta issue collects the child issues (one per core module) and explains the task.
Note: Committing the patches from the child issues will be postponed until
#2920309: Add experimental module for Help Topics
is fixed. But if it hasn't been fixed yet, you can still get started on this issue! To do so:
- Make a local development environment with Drupal Core 8.8.x checked out.
- Apply the patch from #2920309: Add experimental module for Help Topics and commit it in your local development environment.
- Make your patch for the child issue from that starting point.
Also, attached to this issue there is a sample help topic Twig file that you can use as a template when making your patch. (You will need to change the file extension to .html.twig and put it in the correct directory -- see child issue template for details.)
Proposed resolution
- Make a child issue for each core module.
- Complete the child issue for each core module.
Make a child issue for each core module
To make an issue (if there isn't one yet for a module),
- Use this link to create a new issue.
- Change the Parent issue field (below the Issue summary) to
[META] Convert hook_help() module overview text to topics (3041924) - Replace "THISMODULE" with the machine name of the module in the title and (4 place) in the Issue summary.
- Assigned: (assign the new issue to yourself if you are ready to work on it)
Then save the issue, and add a link to the list in this issue's summary. When adding the link to the summary, it is also helpful (for people following this parent issue) to put a short note in the Comment field saying something like "Adding issue for the THISMODULE module".
Using the above link should have the same effect as clicking the "Add child issue" link in the sidebar of this issue and filling in the following properties:
- Title: Convert THISMODULE module hook_help() to topic(s)
- Category: Task
- Status: Postponed
- Component: help.module
- Body (issue summary): copy from the template issue #3041928: ISSUE TEMPLATE -- Do not edit -- template for making child issues -- open up that link, and scroll down to find the area where you could edit the issue summary. Copy the summary from there, and paste it into the new issue you are creating.
- Issue tags: Novice
- If you are working on this issue at an event, add the tag for that too. Example: Seattle2019 is the tag for DrupalCon Seattle 2019
- Assigned: (assign the new issue to yourself if you are ready to work on it)
Modules to be converted (add issue links here)
- action #3041926: Convert action module hook_help() to topic(s)
- aggregator #3046957: Convert aggregator module hook_help() to topic(s)
- automated_cron #3043460: Convert automated_cron module hook_help() to topic(s)
- ban #3047585: Convert ban module hook_help() to topic(s)
- basic_auth #3047703: Convert basic_auth module hook_help() to topic(s)
- big_pipe #3044059: Convert big_pipe module hook_help() to topic(s)
- block #3047709: Convert block module hook_help() to topic(s)
- block_content #3047713: Convert block_content module hook_help() to topic(s)
- block_place #3047718: Convert block_place module hook_help() to topic(s)
- book #3047806: Convert book.module hook_help() to topic(s)
- breakpoint
- ckeditor
- color
- comment
- config
- config_translation
- contact
- content_moderation
- content_translation
- contextual
- datetime
- datetime_range
- dblog
- dynamic_page_cache
- editor
- entity_reference
- field
- field_layout
- field_ui
- file
- filter
- forum
- hal
- help
- history
- image
- inline_form_errors
- language
- layout_builder
- layout_discovery
- link
- locale
- media #3047711: Convert media module hook_help() to topic(s)
- media_library #3047716: Convert media_library module hook_help() to topic(s)
- menu_link_content
- menu_ui
- migrate
- migrate_drupal
- migrate_drupal_multilingual
- migrate_drupal_ui
- node
- options
- page_cache
- path
- quickedit
- rdf
- responsive_image
- rest
- search #3047719: Convert search module hook_help() to topic(s)
- serialization
- settings_tray
- shortcut
- simpletest
- statistics
- syslog
- system
- taxonomy
- telephone
- text
- toolbar
- tour
- tracker
- update
- user
- views
- views_ui #3047723: Convert views_ui module hook_help() to topic(s)
- workflows #3047722: Convert workflows module hook_help() to topic(s)
- workspaces #3047712: Convert workspaces module hook_help() to topic(s)
Remaining tasks
- This issue cannot be marked Fixed until all the child issues (one per module) are Fixed.
- Before we mark this as Fixed, we also need to review the list of modules and make sure it is current -- new modules are added, and old modules are deleted, from Drupal Core from time to time. So, we need to make sure that all modules have been converted, and create new child issues (and fix them) if modules are missing from the list.
User interface changes
Help topics will be added to cover tasks currently covered in modules' hook_help() implementations.
API changes
None.
Data model changes
None.
Release notes snippet
None.