Convert automated_cron, ban, dblog, syslog, system, update, and user module hook_help() to topic(s)

I'm working on this as a test for the meta issue process.

OK, first the analysis. The current hook_help() [module overview part] for the actions module says:

      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Actions module provides tasks that can be executed by the site such as unpublishing content, sending email messages, or blocking a user. Other modules can trigger these actions when specific system events happen; for example, when new content is posted or when a user logs in. Modules can also provide additional actions. For more information, see the <a href=":documentation">online documentation for the Actions module</a>.', [':documentation' => 'https://www.drupal.org/documentation/modules/action']) . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Using simple actions') . '</dt>';
      $output .= '<dd>' . t('<em>Simple actions</em> do not require configuration and are listed automatically as available on the <a href=":actions">Actions page</a>.', [':actions' => \Drupal::url('entity.action.collection')]) . '</dd>';
      $output .= '<dt>' . t('Creating and configuring advanced actions') . '</dt>';
      $output .= '<dd>' . t('<em>Advanced actions</em> are user-created and have to be configured individually. Create an advanced action on the <a href=":actions">Actions page</a> by selecting an action type from the drop-down list. Then configure your action, for example by specifying the recipient of an automated email message.', [':actions' => \Drupal::url('entity.action.collection')]) . '</dd>';
      $output .= '</dl>';

So it looks like the tasks here are:
- Viewing available actions
- Configuring advanced actions

This is fairly short, so I wrote it up in one topic called "Viewing and managing actions". Since there is not yet a top-level topic that this belongs in, I have put it as top-level for now. Added a note to #3031642: Deprecate hook_help() and combine with Topics that after this whole project is done, we may need to reorganize the topics.

Anyway, here's a patch. Obviously won't do anything until #2920309: Add experimental module for Help Topics is committed.

Good catch! I guess I named it "actions" instead of "action". Thanks for testing!

I will add a note to the meta issue with the file name concern.

Updating issue summary as per new issue template from the parent issue.

Updated summary from template.

Thanks for reviewing! That link for configuring the Action module permissions is generated automatically on all hook_help() module overview pages. It will not be generated automatically in the help topics.

So, that is something we need to think about...

I created an issue to discuss this question of what to do about the permissions links.

Guess this needs to be postponed until that decision is made.

I have un-postponed most of the issues for conversion, but this one is still blocked (see #12).

We are combining this issue with several other modules.

Patches to be added and people to credit:
#3043460: Convert automated_cron module hook_help() to topic(s) - vadim.hirbu , shwetaneelsharma
#3047585: Convert ban module hook_help() to topic(s) - lisagodare@gmail.com

The other modules had not been patched yet.

Updated issue summary with better instructions/guidelines

I don't think we need to make links to the permissions i n the tasks. But these topics need to be revisited based on our new guidelines (see issue summary). Also I'm not currently working on this issue.

We've migrated the help topic standards to https://www.drupal.org/docs/develop/documenting-your-project/help-topic-... so updating issue summary again.

We just found out that all topic Twig files currently need to go into core/modules/help_topics/help_topics (with their finalized module-based file names), for the time being until the Help Topics module is stable. Updating issue summary. Patch will need to be updated too.

I'm going to work on this module. First thing: as a starting point, here's a not working patch that combines the patches for the related issues that were combined into this one with the previous patch on this issue.

And I updated the issue summary to make sure people from the other issues are credited here.

Here's a new patch -- still not done. What I did this time:
- Updated the meta-data for the three topics that were in the last patch to the new format, so that they would actually load.
- Wrote topics for the User module (and updated the one User module topic that was already committed)
- Made the Ban module topic be related to the User overview topic, instead of top-level
- The topics in this patch can at least be viewed now.

Still to do:
- Review the Action and Automated Cron topics. They probably shouldn't be top-level but right now there is nothing obvious to Relate them to.
- Write topics for dblog, syslog, system, and update.
- This should probably include an overview topic on cron that would mention automated cron and other ways to run cron. We might not need a whole topic on automated cron actually.
- Probably the topics for dblog and syslog can be combined into a topic about logging.
- Maybe we'll need a top-level topic about maintenance and troubleshooting (we have a chapter on that in the user guide) -- that would probably be a good grouping for the logging, cron, and update topics.

Anyway, I'll upload this now and continue to work on this the next few days, but leaving at Needs Work because it is not done yet.

triggering tests, then I'll set this back.

Here's a new patch, which fixes a couple of minor things, and adds new topics on Cron and a (currently mostly empty) top-level Maintaining topic. I got rid of the automated cron topic; the Cron topic covers this.

System module functionality that still needs to be documented:
- Maintenance mode
- Installing/uninstalling modules
- Updating modules, themes, and core [needs to be Related to existing Maintaining and Security topics]
- Themes: installing/uninstalling, setting default, admin theme -- or could add this to #3055055: Convert appearance-related modules: breakpoint, color, layout_builder, layout_discovery module hook_help() to topic(s), which is all about theme-related stuff? I think that would be better actually. This patch will already be big enough. I'll do that (updating summary here also).
- Reports and logging (syslog and dblog, plus other reports. See also system.config_error -- which covered logging settings and visiting the dblog page.)

Also still need to figure out what to do with Actions. I'm trying to figure out what core functionality actually uses actions or why someone would want to configure them.

I had a discussion with berdir and xjm in Slack. I decided the Actions module should be in its own patch, as in Core it's really mostly used in Views. So I created #3094482: Convert action module hook_help() to topic(s), including views bulk operations and am taking Actions out of this issue (the patch still needs to have that topic removed).

Here's another iteration, which documents clearing the cache and maintenance mode.

Still to do in this patch:
- Installing/uninstalling modules
- Updating modules, themes, and core [needs to be Related to existing Maintaining and Security topics]
- Reports and logging (syslog and dblog, plus other reports. See also system.config_error -- which covered logging settings and visiting the dblog page.)

OK, here it is! I think this patch is actually ready for a review now.

One note: I did not write topics about updating Drupal Core or modules. I think this is pretty complicated, depends a lot on your hosting, and should be left to the User Guide, which covers all the contingencies.

Oh wait, I forgot -- the actions topic is not supposed to be in this patch. I didn't make an interdiff -- same patch but without the file action.configuring.html.twig [that is moved to the related issue].

We should wait for the other issue to be fixed definitely.

Thanks for the thorough review! Here's a new patch with the fix to add core.cron as related in the search topic. Also added a link to the text of that step (since it's a core-namespace topic, it will always be available).

Unrelated random fails.

Test error this time is "Unable to start the web server", unrelated to this patch.