Problem/Motivation
The main help page (admin/help) needs a couple of changes so that a new block containing available tours can be added.
For background information see #1921152: META: Start providing tour tips for other core modules.
The result (with Tours block) should look as follows:
Proposed resolution
- the Getting started section should be moved to HelpController.php. At least that is what I think, because it seems that currently it misuses hook_help to display general site information on the main help page. This info will not be visible if the system help block is disabled or if the help region is not available in the theme.
- the intro text of the Help topics section should contain a short explanation on what help topics are
Remaining tasks
- move Getting started section to HelpController.php
- change intro text of the Help topics section
User interface changes
The main help page will contain some more text after the changes
API changes
No API changes
Comment | File | Size | Author |
---|---|---|---|
#7 | adapt-main-help-page-2205713-7.patch | 6.19 KB | amitgoyal |
#3 | adapt-main-help-page-2205713-3.patch | 6.26 KB | batigolix |
Comments
Comment #1
batigolixComment #2
batigolixComment #3
batigolixThis patch:
1. moves the Getting started section from:
core/modules/help/help.module to:
core/modules/help/lib/Drupal/help/Controller/HelpController.php
2. expands the introduction of the Help topics section
3. updates the docs block
Comment #5
larowlanThanks for opening. Are we adding the block here too?
Comment #6
batigolixlet us use this separate issue for the block: #2205801: Create Available Tours block
Comment #7
amitgoyal CreditAttribution: amitgoyal commented@batigolix - Please see updated patch as #3 patch no longer applies in current code.
I tried creating interdiff but got following error,
$ interdiff adapt-main-help-page-2205713-3.patch adapt-main-help-page-2205713-7.patch > interdiff-2205713-3-7.txt
1 out of 1 hunk FAILED -- saving rejects to file /tmp/interdiff-1.8XlbLw.rej
interdiff: Error applying patch1 to reconstructed file
Comment #9
jhodgdonTest failures seem to be related to the patch, not random test bot problems...
Comment #10
amitgoyal CreditAttribution: amitgoyal commented@jhodgdon - I think test failures are meant for the files but not to the section in which we have made changes.
Please see the changes which we have done and the test failures. Both are not related.
Comment #11
jhodgdon7: adapt-main-help-page-2205713-7.patch queued for re-testing.
Comment #13
jhodgdonThe test failures are the same this time, so they must be related to this patch?
Comment #14
amitgoyal CreditAttribution: amitgoyal commentedDoesn't look like that if the test failures are relevant to this patch.
Comment #15
jhodgdonI disagree with #14. I retested and got the same exact test errors, and HEAD is not getting these errors, so I think they must be from this patch?
Comment #16
jhodgdonSee also #2374083: Add tours list to admin/help page... This is a new currently sandbox contrib module called Configurable Help, which we hope to add to Core in 8.1.x. It has a hook that allows modules to add sections to the main Help page. I'm planning on adding Tours to it via this hook.
Comment #17
jhodgdonI took a careful look at the latest patch on this issue.
There is one documentation problem, in HelpController:
This needs to be condensed down to one line. "Texts" is also not a countable noun in English so it should probably be "topics" not "texts".
I'm also not sure that this current patch fixes the stated issue. Putting the text at the top into the controller is an excellent idea, but how exactly does this fix the stated goal of allowing the Available Tours block to be displayed? Maybe we should make this into two separate issues?
The test failures also need to be fixed.
Comment #18
mgiffordThere has been no new work on this issue in quite some time. So I'm assuming the person assigned is no longer being actively pursuing it. Sincere apologies if this is wrong.
Comment #19
jhodgdonI've filed a new meta issue to collect all the problems with the current help system and discuss the best route to fixing them; this issue is being added as Related there, and all of its concerns are listed in the Problem/Motivation section:
#2592487: [meta] Help system overhaul
Comment #20
jhodgdonI've also filed a new issue where I'm working on reorganizing this page that I think will subsume most of this issue:
#2661200: Make admin/help page more flexible, and list tours on it
Possibly I should have used this issue instead but I'm not sure my new issue covers everything here.
Comment #21
jhodgdonThat other issue I mentioned in the previous comment is probably/hopefully close to being done. I'm looking for final reviews so we can get it into 8.1.x. If you are interested in this issue, you probably want to look at #2661200: Make admin/help page more flexible, and list tours on it. Thanks!
Comment #22
jhodgdonThe other issue is done. I think this is now a duplicate of it, as Tours are now listed on admin/help.
Comment #23
larowlanagree