Hi jhodgdon,
I would love to see the module released as official module.
My wish is to have an opportunity to write 'editor manuals' in config. In the site. Without new content types an placed at the help section.
I think config_help ftits my basic needs and there is a potential for more.
My colleague @webflo made a patch on my wish, to have better control on the topics. Maybe you need it, it's attached.
Bye, Frank
| Comment | File | Size | Author |
|---|---|---|---|
| config-help-86-2.patch | 1.9 KB | B00N |
Issue fork config_help-2901802
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
Comments
Comment #2
jhodgdonHI there!
So this seems to be two issues:
a) Convert this sandbox project into a real project and make a release.
b) Add a patch to the module.
Please make the patch as a separate issue.
So... Regarding making this a full module, there is an alternative proposal to get this into Core -- see #2592487-28: [meta] Help system overhaul and following comments.
Comment #3
jhodgdonComment #4
jhodgdonActually, my preference would be to get this in as part of Drupal Core, so if you'd like to help with that... I think that would be a better route than leaving it as a contributed module. Thanks!
Comment #5
jhodgdonJust to clarify...
I don't think that making this a full Contrib module is the right solution. The right solution is to get this into Core.
The reason I say that is remembering the "Advanced Help" module, and various other contrib modules that have been present in past versions of Drupal (and may still be going today). They, like this module, proposed new ways for making help within a Drupal site, but because they were not in Core, only a limited number of people and other modules adopted them, so we ended up with many help "solutions".
So I think we need to get one better solution for help into Core, rather than adding to the problem of having multiple solutions in contrib-land.
If either you or webflo would like to help get this module into Core, that would be great. It's really about ready... The main thing it needs is someone to volunteer to be its Core Subsystem Maintainer. I am not willing to do it, due to plenty of other Drupal volunteer commitments, but I will help with the effort needed to get it into Core, such as making/reviewing patches, writing help topics, etc.
If you'd like to help on that, please comment on #2592487: [meta] Help system overhaul.
Anyway, you can continue to use this as a Sandbox. It just won't be security-reviewed or have releases.
Comment #6
jhodgdonUpdate: A group of us is actively working on getting this into Core. There's an Ideas issue queue proposal to get it to be an official Community Initiative, which is just waiting for Core Maintainer approval:
#2592487: [meta] Help system overhaul
And there's an issue where we're working on making the Core patch:
#2920309: Add experimental module for Help Topics
We are also actively working in this issue queue on cleaning up various things in the module. See
https://www.drupal.org/project/issues/2369943
Help is welcome on all of the above!
Since I cannot be sure this will end up in Core (although I think that would be much better than having it be its own contrib module), I will leave this issue open for a while, but I prefer that it be in Core. I will mark this as Postponed though -- if the Core issues get closed as "won't fix" then we should revisit making this a Contrib module.
Thanks again for your interest!
Comment #7
andypostProbably better to change title of the issue according added patch - Make permissions for topics more granular
Comment #8
jhodgdonNo, I requested on comment #2 to make a separate issue for the permissions change. We should do that since the original reporter did not do it.
Comment #9
jhodgdonI put the patch on a separate issue
#2921026: More granular permissions
Comment #10
jhodgdonUpdate: The Help Topics module was added to Drupal Core 8.8.x, and is available if you download the development version.
That core module allows modules/themes to define help topics in Twig files.
So, the plan for this module is to fix it up (see issue I just marked as related) (which is almost done), and then turn it into a contrib module instead of just being a sandbox. This module will give site admins a user interface for creating/editing their own site-specific topics.
I hope to have it turned into a full module sometime within about a week. But I don't think I'll be making a security-aware release until the core Help Topics module gets into an actual release (see the Roadmap issue for that -- it is still a pre-Beta experimental module, so I don't think it makes sense to have a real release of this module until it is more stable).
As a note, it may actually be preferable for knowledgeable site admins to make a custom module on their site and put their help files in that as Twig templates, using the core Help Topics experimental module, rather than using the UI to put them into the configuration system as in this module.
Comment #11
jhodgdonUpdate: I have updated this module and it works now with the core experimental Help Topics module. This module's project page has more details. I'll probably leave this as a Sandbox until the core module gets a bit more stable...
Comment #12
andypostI gonna update codebase and release it as full project.
Since 10.2 help topics are part of help module https://www.drupal.org/node/3382015
Comment #15
andypostPublished https://www.drupal.org/project/config_help/releases/3.0.0-beta1