[META] Convert hook_help() module overview text to topics

Open on Drupal.org →

Created on 20 March 2019, over 5 years ago

Updated 21 April 2023, over 1 year ago

Problem/Motivation

As part of 🌱 Deprecate hook_help() and combine with Topics Active , 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.

Proposed resolution

Complete the child issue for each core module. The child issues have information on how to create and review the topics. All topics will conform to the Help Topic Standards →

Clean-up and finalization issues

📌 Fix up minor copy problems in help topics Fixed
🌱 [META] Fix up topics to use new help_route_link function Fixed and child issues
📌 Add tests to enforce correct use of help_topic_link and help_route_link functions Fixed
#3204175: Add security advisories Help Topic →

Already done
Topic writing issues

Pre-existing topics in the help_topics module: #3072312: Review/fix/delete existing help topics →
system-related modules: automated_cron, ban, dblog, syslog, system, update, and user #3041926: Convert automated_cron, ban, dblog, syslog, system, update, and user module hook_help() to topic(s) →
speed-related modules: big_pipe, dynamic_page_cache, page_cache #3044059: Convert big_pipe, dynamic_page_cache, page_cache module hook_help() to topic(s) →
action and views bulk operations #3094482: Convert action module hook_help() to topic(s), including views bulk operations →
appearance-related modules: breakpoint, color, layout_builder, layout_discovery #3055055: Convert appearance-related modules: breakpoint, color, layout_builder, layout_discovery module hook_help() to topic(s) →
aggregator #3046957: Convert aggregator module hook_help() to topic(s) →
block, block_content #3047709: Convert block and block_content module hook_help() to topic(s) →
block follow-up: #3093089: Minor improvements to block topics →
book #3047806: Convert book.module hook_help() to topic(s) →
ckeditor, editor, filter #3067614: Convert filter, ckeditor, editor module hook_help() to topic(s) →
comment, node, path, taxonomy #3067727: Convert comment, node, path, taxonomy module hook_help() to topic(s) →
contact #3067617: Convert contact module hook_help() to topic(s) →
config #3095734: Convert config module hook_help() to topic(s) →
content_moderation, workflows #3047722: Convert content_moderation, workflows module hook_help() to topic(s) →
field-related modules: datetime, datetime_range, field, field_ui, link, options, telephone, text #3087562: Convert datetime, datetime_range, field, field_ui, link, options, telephone, text modules hook_help() to topic(s) →
forum #3067622: Convert forum module hook_help() to topic(s) →
history, statistics, tracker #3055317: Convert history, statistics, tracker module hook_help() to topic(s) →
internationalization modules: config_translation, content_translation, locale, language #3095737: Convert internationalization modules: config_translation, content_translation, locale, language module hook_help() to topic(s) →
menu_link_content, menu_ui #3095740: Convert menu_link_content, menu_ui module hook_help() to topic(s) →
media-related: file, image, media, media_library, responsive_image #3047711: Convert file, image, media, media_library, responsive_image module hook_help() to topic(s) →
migrate, migrate_drupal, migrate_drupal_ui #3073476: Convert migrate, migrate_drupal, migrate_drupal_multilingual, migrate_drupal_ui module hook_help() to topic(s) →
search #3047719: Convert search module hook_help() to topic(s) →
services-related modules: basic_auth, hal, jsonapi, rdf, rest, serialization #3047703: Convert basic_auth, hal, jsonapi, rdf, rest, serialization module hook_help() to topic(s) →
views, views_ui #3047723: Convert views, views_ui module hook_help() to topic(s) →
admin UI-related modules: contextual, help, inline_form_errors, quickedit, settings_tray, shortcut, toolbar, tour #3095739: Convert admin UI-related modules: contextual, help, inline_form_errors, quickedit, settings_tray, shortcut, toolbar, tour module hook_help() to topic(s) →

Cleanup issues

#3192585: Fix up topics to use new help_topic_link function →

Modules we are not doing help topics for (hidden/removed modules)
(see also #3013276: [META] Remove deprecated modules on the Drupal 9 branch → ):
block_place
entity_reference
path_alias
simpletest

We are also not doing experimental modules -- we might do them later, or let the module developers make help topics for them later, depending on the timing -- but they are subject to change so it doesn't really make sense to do them in the first pass:
field_layout
config_environment
workspaces
migrate_drupal_multilingual

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.
See also #3013276: [META] Remove deprecated modules on the Drupal 9 branch →

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.

📌 Task

Status

Fixed

Version

10.1 ✨

Component

Last updated 7 days ago

Maintained by
🇺🇸United States @Amber Himes Matz
🇫🇷France @andypost

No maintainer

Created by

🇺🇸United States jhodgdon Spokane, WA, USA

Live updates comments and jobs are added and updated live.

Seattle2019

DrupalCampBelarus2019

dcasheville19

dcco2019

badcamp2019

midcamp2020

Global2020

Incomplete comments

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment almost 2 years ago →
🇫🇷France andypost
Closed meta as only 📌 Update sentence-embedded internal links in content_moderation, core.content_structure, search.overview help topics to use help_route_link function Fixed left
Comment almost 2 years ago →
🇫🇷France andypost
Set active 📌 Fix up minor copy problems in help topics Fixed and only 📌 Add tests to enforce correct use of help_topic_link and help_route_link functions Fixed is left to fix here - final clean-up
Comment over 1 year ago →
🇫🇷France andypost
Last conversion is commited, #132 still valid
Status changed to Fixed over 1 year ago2:15pm 21 April 2023
Comment over 1 year ago →
🇫🇷France andypost
Thinking a bit more and reading issues I consider it fixed because

- points in 📌 Fix up minor copy problems in help topics Fixed are only related to future renames in UI
- extra test addition 📌 Add tests to enforce correct use of help_topic_link and help_route_link functions Fixed is follow-up to 📌 Make a way for help topics to generate links only if they work and are accessible Fixed
Comment over 1 year ago →
System Message
Automatically closed - issue fixed for 2 weeks with no activity.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024