Closed (won't fix)
Project:
Drupal core
Version:
8.1.x-dev
Component:
documentation
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
10 Oct 2014 at 23:56 UTC
Updated:
13 Jun 2016 at 16:02 UTC
Jump to comment: Most recent
Comments
Comment #1
jhodgdonAdded additional notes.
Comment #2
jhodgdonI had a couple of thoughts about how to structure some help topics:
a) We could have a "Glossary" topic, with proposed machine name core_glossary. Then there could be individual topics with titles like "Glossary: Entity" -- each one would NOT have "Top level" checked, would put _core_glossary in its "list on" field, and would have machine name "glossary_specific_word". In this way, modules and themes and etc. could provide their own glossary terms, and they would be automatically listed on the Glossary page.
b) We could also have a "Field list" topic, machine name core_fields, and individual field topics like "Field: Telephone" (machine name field_telephone, not top level, marked as "list on core_fields"). Would work like Glossary. The glossary_field topic would list this as "Related", and vice versa. The Field module topic would also list this as Related. This would solve #2332687: Lost help for field types from Core/Field.
Comment #3
jhodgdonUpdating the issue summary. The new plan, assuming the parent issue gets done, is not to get rid of any existing hook_help() module overview topics, but to edit them down to being just module overviews, and provide information that is more user-orieinted in these help topics.
Comment #4
jhodgdonI've been working on this configurable help module in a sandbox, and over there I had a related issue: #2658680: Make some topics / redirect purpose of topics slightly. I had some topic ideas there for core topics, and am adding them to this issue's summary now.
Comment #6
jhodgdonParent issue is closed / won't fix. This one should be too.