Problem/Motivation

The System module includes much more functionality that is currently included in the hook_help text. See the list of administration pages on the help page compared to the list of topics above.
Adding all of these topics on the help page is obviously too much, but some might need adding such as for example RSS.

Proposed resolution

Decide whether to add any more topics, and if so write them.

Remaining tasks

User interface changes

This would be a UI text change.

API changes

None.

Data model changes

None.

Comments

ifrik created an issue. See original summary.

jhodgdon’s picture

Issue tags: +rc deadline

Apparently this needs to be "rc deadline" because it changes translatable UI text strings. See https://groups.drupal.org/node/484788

jhodgdon’s picture

Title: Review the hook_help for the system module » Review the hook_help for the system module - should mention status report
Status: Active » Needs review
StatusFileSize
new2.42 KB

I took a look through the System module help page, vs. the list of pages that System provides.

So about half of the items on the list are actually the "category" pages on Configure, like "Search and meta-data" or "Development". These do not need to be covered in the hook_help() (the help About section does say it provides the basic admin menu structure anyway).

There are a few pages that are not covered, which System provides:
- admin/config/development/logging - logging and error settings
- admin/config/regional/settings - regional settings
- admin/config/services/rss-publishing - RSS publishing settings
- admin/reports/status - status report

So. RSS settings are probably irrelevant and probably going away on another issue. We should not talk about them anyway because at a minimum the settings are now unused, so it's a useless page even if it doesn't get removed.

Regional settings and logging settings - the help has this:

Configuring basic site settings

The System module provides pages for managing basic site configuration, including Date and time formats and basic Site information (site name, email address to send mail from, home page, and error pages). Additional configuration pages are listed on the main Configuration page.

So I think we can be OK not mentioning logging or regional settings.

But the status report is probably a good thing to mention... It is referred to in the Cron section but I think that is not enough. Here is a patch.

wim leers’s picture

Status: Needs review » Reviewed & tested by the community

Looks great!

webchick’s picture

Status: Reviewed & tested by the community » Fixed

Nice catch. Looks good.

Committed and pushed to 8.0.x. Thanks!

  • webchick committed 3328ab0 on 8.0.x
    Issue #2571665 by jhodgdon, ifrik: Review the hook_help for the system...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.