Closed (duplicate)
Project:
Drupal core
Version:
8.8.x-dev
Component:
help.module
Priority:
Normal
Category:
Task
Assigned:
Reporter:
Created:
26 Mar 2019 at 13:33 UTC
Updated:
29 Jun 2019 at 19:19 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #2
vadim.hirbu commentedAdded patch with converting hook_help into help_topics.
Comment #3
vadim.hirbu commentedComment #5
jhodgdonThanks!
The test failure seems to be unrelated, so I would ignore that.
Regarding the patch, we don't really want the exact text of the old hook_help() module overview page in the new help topic, with its "About" and "Uses" sections. The idea is for the help topics to be task-based and actually useful help for how to build/manage a Drupal web site. Take a look at what I did on the Actions module for ideas on issue #3041926: Convert automated_cron, ban, dblog, syslog, system, update, and user module hook_help() to topic(s). For example, instead of "About", the heading there is "What are actions?".
Also you have one H2 and one H3 in your topic, but I think they should logically be at one level?
I guess I will put more guidance into the template issue... Again, thanks for the patch!
Comment #6
jhodgdonUpdating with new summary from the template.
Comment #7
vadim.hirbu commentedJust updated previous patch according latest recommendations.
Comment #8
vadim.hirbu commentedComment #9
bramdriesenShouldn't the "Actions" patch from #7 be in the other issue #3041926: Convert automated_cron, ban, dblog, syslog, system, update, and user module hook_help() to topic(s)? To me it's very confusing to be working on 2 patches from 2 different modules under one issue. This issue is for automated_cron and should only cover that.
Comment #10
vadim.hirbu commentedYou are right. Uploaded the right patch.
Comment #11
vadim.hirbu commentedComment #12
jhodgdonThanks for the patches!
The last sentence needs some attention:
It doesn't quite make sense to me.
Also, the "What is" section still reads like a module summary... it's not really a "concept".
So, just to review the goals here:
a) We want to focus first on tasks that this module handles.
b) We only want concepts if they are necessary to understand what the tasks are.
So what I would suggest is rewriting this topic so it is structured like this:
(heading) What are cron tasks?
(description -- you might look at https://www.drupal.org/docs/user_guide/en/security-cron-concept.html for some ideas, or maybe just copy that first section)
(heading) Configuring automatic cron runs
(similar to what you have in the patch now)
Comment #13
vadim.hirbu commentedI hope I've understand now the idea of concept.
Comment #14
vadim.hirbu commentedComment #15
jhodgdonLooking good! Do you think we need a comma after "Cron page" in the last sentence?
Comment #16
vadim.hirbu commentedIt looks better with comma.
Comment #17
bramdriesenI agree it reads easier with the comma.
Comment #18
shwetaneelsharma commentedTested the patch "convert_hook_help_in_topics-3043460-16.patch". Since there is a section about configuration, a section on disabling cron should also be mentioned. It is present in the old help document.
Please find the SS attached.
Comment #19
jhodgdonThanks for the review! Marking as Needs Work.
Comment #20
vadim.hirbu commentedAdded section about disabling Automated cron jobs.
Added interdiff file.
Comment #21
jhodgdonWe need to postpone this until the #2920309: Add experimental module for Help Topics gets committed. No idea when/if that might happen right now...
Comment #22
jhodgdonThat issue was committed, so we can un-postpone this now!
Comment #23
jhodgdonWe are combining this issue with another issue. Thanks for your work here! You'll be credited on the other issue.