Allow using the readmehelp for all modules with no module help.

Open on Drupal.org →

Created on 22 February 2018, over 6 years ago

Updated 3 March 2023, over 1 year ago

Currently, the dependency should be put in the MODULE.info.yml file to automatically display module's README file on the admin/help/MODULE page. The readmehelp configuration form will allow to use it by any module even if it has no dependency.

TODO:

1. Create config form with the list of all enabled modules to assign for automatic displaying their README on the help page. By default, any module which don't implement hook_help() in the MODULE.module file should be checked. Example:

https://cgit.drupalcode.org/securitytxt/tree/securitytxt.info.yml#n6
https://cgit.drupalcode.org/securitytxt/tree/config/schema/securitytxt.s...
https://cgit.drupalcode.org/securitytxt/tree/config/install/securitytxt....
http://cgit.drupalcode.org/securitytxt/tree/src/Form/SecuritytxtConfigur...

2. Implement appropriate hooks in the readmehelp.module file, so when a module is uninstalled then clean up the config for the module. Or, check the readmehelp config for the module when it is installed (if hook_help() not implemented).

3. Make appropriate changes:

https://cgit.drupalcode.org/readmehelp/tree/src/Controller/ReadmeHelpCon...
https://cgit.drupalcode.org/readmehelp/tree/src/Plugin/HelpSection/Readm...
https://cgit.drupalcode.org/readmehelp/tree/README.md

4. Adjust tests for the changes:

https://cgit.drupalcode.org/readmehelp/tree/tests/modules/readmehelp_test

5.

6. Implement uninstall hook in the readmehelp.install so when the readmehelp is uninstalled then clean up all the saved configuration.

📌 Task

Status

Fixed

Version

2.0

Component

Code

Created by

🇪🇪Estonia drugan

Live updates comments and jobs are added and updated live.

Incomplete comments

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment almost 2 years ago →
🇦🇹Austria mvonfrie
An option to make this module optional for xnumber etc. is by suggesting it in composer.json. You just have to add:

"suggest": { "drupal/readmehelp": "Allows automatically to display module's README file on the admin/help/your_module page." }
This way it will be easier to upgrade the modules to Drupal 10 as well, because the readmehelp module can be upgraded seperately.
Comment over 1 year ago →
🇪🇪Estonia drugan
@drugan opened merge request.
@drugan opened merge request.
Comment over 1 year ago →
System Message

drugan → committed 42bc0f02 on 8.x-1.x
Issue #2946807 by drugan: Allow using the readmehelp for all modules...
Comment over 1 year ago →
System Message

drugan → committed 542844cb on 2.0.x
Issue #2946807 by drugan: Allow using the readmehelp for all modules...
Status changed to Fixed over 1 year ago5:18pm 3 March 2023
Comment over 1 year ago →
🇪🇪Estonia drugan
Fixed both for the 2.0.x and 8.x-1.x versions.
Comment over 1 year ago →
System Message
Automatically closed - issue fixed for 2 weeks with no activity.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024