The 2026 Drupal Business Survey is open. Your response will help shape the future of the Drupal business ecosystem.According to Drupal standards, modules should include a useful README.file.
While this project has a readme, it is lacking useful configurations and links.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu...
Patch to follow. Thanks!
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | interdiff-2978345-2-5.txt | 467 bytes | volkswagenchick |
| #5 | insert-add-readme-2978345-5.patch | 3.34 KB | volkswagenchick |
| #2 | insert-add-readme-2978345-2.patch | 3.19 KB | volkswagenchick |
Comments
Comment #2
volkswagenchickI have uploaded a patch that aligns with Drupal documentation standards and include useful links and configurations.
Thanks for your work on this project!!
Comment #3
legaudinier commentedPatch applied using simplytest.me
Readme file is more useful. Grammar and spelling look good. Links are correct.
Marking RTBC.
Comment #4
snater commentedThanks. Would it be OK to have the configuration section just point to https://www.drupal.org/docs/8/modules/insert/configuration in order to avoid having to maintain documentation in two places?
Comment #5
volkswagenchickI do see your point. I have a link to the external documentation in the Introduction section.
The only problem I see to ONLY linking to external documentation is that you have to be on-line to access the information. There are several use cases where this might not work: working locally with no internet access, can only view whitelisted urls, etc.
Could we add something like
"For the most up to date configurations, please visit the external documentation pages at:
https://www.drupal.org/docs/8/modules/insert/configuration"
Patch uploaded with an interdiff for easy review.
I appreciate your feedback. If you want it some other way, let me know. :)
Comment #6
snater commentedOK, not having any Internet access at all may be a use-case, but it is a quite narrow one as the module has to be downloaded somewhere to get started. While I try to document as good as possible, I neither want to have the obligation to maintain documentation in more than one place, nor that the user might accidentally be reading outdated documentation. If drupal.org had a system like GitHub where the content of the readme is integrated into the software's presentation, I would very well be fine with putting all the documentation into the readme instead of somewhere else. Under the given circumstances, in my opinion, it is a good idea to have the readme file be some kind of index to all necessary information (which is what your change does), but I would prefer to not copy specific documentation into that file.
That said, I do not have a problem uploading your patch. I just do not want to be impolite by silently making a major change to your change in a subsequent commit, which is what I would do for the current patch set. But if you are fine with that, I will just go ahead and upload your change set.
Comment #7
volkswagenchickThanks for asking. I see your point of view.
Go ahead and make the changes you feel necessary. No offense will be taken :)
Comment #9
snater commentedOK, thanks a lot. :)
Comment #10
volkswagenchickThankyou for all the work you do!!
I am encouraging team mates to help out on Drupal.org, could you go back and give legaudinier a credit for his RTBC?? She took the time to test and make sure the configs, link, etc were correct.
The box next to her name just gets ticked and she gets a credit! I see it as a way of incentive to help get involved it the community! It takes a village.
Cheers!
AmyJune - volkswagenchick
Comment #11
snater commented(Sorry, I am still having trouble with those credit mechanics.) I am not able to amend the commit, but I did tick her name in the credit section when I set the issue to fixed (as she, of course, deserves credit). According to her user page, she received credit on that issue.