Help Topic Standards [#3211279]

Problem/Motivation

As of Drupal 8.8.x, there is a new functionality in Drupal Core, where each module, theme, and install profile (core or contrib) can provide one or more Help Topics. It is a Experimental module now, but the topics can be built from the base and be ready when the core module is released.
More information in:
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

Comment	File	Size	Author
#5	3211279-5.patch	1.74 KB	guilhermevp
#2	3211279-2.patch	1.74 KB	guilhermevp

Comments

Comment #1

28 April 2021 at 18:54

guilhermevp created an issue. See original summary.

Comment #2

guilhermevp commented 28 April 2021 at 18:56

Status:

Active

» Needs review

Status	File	Size
new	3211279-2.patch	1.74 KB

Patch as it is is just a direct conversion of the hook_help, that I didn't remove because the hook still the oficial way to add a help page.

Comment #3

deaom commented 25 May 2021 at 14:00

Status:

Needs review

» Needs work

Hi @guilhermevp, the patch does apply and the topic page does work (once you enable the Help Topics module). The thing I noticed is a typo in the line <p>{% trans %}The <em>Context</em> module lets users define conditions for when certains reactions should take place.{% endtrans %}</p> It should be without s in the certains (certain). I checked the help hook in module and there it is written correctly.
Also looking at other topic pages all have a h2 tag for titles, here it is set to h3, so maybe that can also be changed? So setting status to needs work.