According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-documentation-guidelines

CommentFileSizeAuthor
#11 interdiff.txt2.29 KBamit.drupal
#11 advanced_help-add-readme-2832269-11.patch542 bytesamit.drupal
#9 interdiff-2832269-4-7.txt1.63 KBloopduplicate
#7 advanced_help-add-readme-2832269-7.patch1.89 KBvolkswagenchick
#4 advanced_help-add-readme-2832269-4.patch1.89 KBvolkswagenchick
#2 advanced_help-add-readme-2832269-2.patch1.89 KBvolkswagenchick

Comments

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented

Patch to follow.

volkswagenchick created an issue.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: volkswagenchick » Unassigned
Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new advanced_help-add-readme-2832269-2.patch1.89 KB

Here's a patch for the README.txt file.

loopduplicate’s picture

loopduplicate commented 
+++ b/README.txt
@@ -0,0 +1,54 @@
+  ¶

Extra spaces should be removed.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
StatusFileSize
new advanced_help-add-readme-2832269-4.patch1.89 KB

Thanks Loopduplictae for reviewing.
New patch submitted

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

Thanks for the patch.

  1. +++ b/README.txt
@@ -0,0 +1,54 @@
+  ¶

    I think there might be a weird space here too. 

  2. +++ b/README.txt
@@ -0,0 +1,54 @@
+The advanced help module allows module developers to store their help outside the module system, in pure .html or .md (MarkDown) files.  It provides a framework that allows module and theme developers to integrate help texts in a Drupal site, as well as exposing help to site administrators through the administrative interface.

    Some places have "advanced help", some have "Advanced help", and some have "Advanced Help". It would be good to standardize on one (whatever is used in the .info file).

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Title: Add README file » Add README file for D7

Updating title since there are two readme issues.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
StatusFileSize
new advanced_help-add-readme-2832269-7.patch1.89 KB

Thanks Kristen Pol and Loopduplicate for reviewing.
Here is the revised patch with consistent naming and extra spaces removed.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

Thanks for the update. When updating patches, it's useful to add an interdiff file:

https://www.drupal.org/documentation/git/interdiff

so only the differences need to be reviewed. Thanks.

loopduplicate’s picture

loopduplicate commented
StatusFileSize
new interdiff-2832269-4-7.txt1.63 KB

Here's an interdiff.

loopduplicate’s picture

loopduplicate commented
Status: Needs review » Reviewed & tested by the community

Marking as RTBC as the interdiff shows that you have addressed @Kristen Pol's comments

amit.drupal’s picture

amit.drupal commented
StatusFileSize
new advanced_help-add-readme-2832269-11.patch542 bytes
new interdiff.txt2.29 KB

update Patch and include some more clearly for installation step.

amit.drupal’s picture

amit.drupal commented
Status: Reviewed & tested by the community » Needs review
volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented

There is an existing Installation section in the patch in comment 7. It is above the Configuration section, it has a link to drupal.org that provides details on installation. I believe the patch in comment 7 is adequate.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Status: Needs review » Reviewed & tested by the community

Changed status as per #13. Marked RTBC

  • gisle committed 10072ea on 7.x-1.x authored by volkswagenchick 
    Issue #2832269 by volkswagenchick, amit.drupal: Add README file for D7
gisle’s picture

gisle
he/him
Primary language Norwegian Bokmål
Location Norway
commented
Status: Reviewed & tested by the community » Fixed

Committed to 7.x-1.x-dev.

Status: Fixed » Closed (fixed)

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