Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....
README to follow. Thanks!
Comment | File | Size | Author |
---|---|---|---|
#7 | stage_file_proxy-add_readme-2849596-7.patch | 2.1 KB | mark_fullmer |
#4 | stage_file_proxy-add-readme-2849596-4.patch | 3.31 KB | volkswagenchick |
#4 | interdiff-2849596-2-4.txt | 1.18 KB | volkswagenchick |
#2 | stage_file_proxy-add-readme-2849596-2.patch | 3.31 KB | volkswagenchick |
Comments
Comment #2
volkswagenchickHere is a useful README for the d8 branch. Thanks for this VERY USEFUL module.
Comment #3
loopduplicateLooks good except for:
special character at the end of the sentence needs to be removed.
Special character and extra space at the end of this line should be removed.
Regards,
Jeff
Comment #4
volkswagenchickThanks Loop. Here is a new patch, along with an interdiff, with the extra spaces removed. THANKS again!
Comment #5
loopduplicateLooks good :)
Comment #6
mark_fullmerDrupal 8 doesn't support variable_set and $conf variables as described here. Apologies if I'm missing something, but this Readme seems applicable to 7.x, not 8.x.
I might encourage the OP to do a bit more diligence when creating READMEs. Quality over quantity! https://www.drupal.org/user/3332522/track/code
Comment #7
mark_fullmerThe 8.x configuration is already thoroughly documented by the maintainers in the existing INSTALL.txt file. So, per module documentation guidelines, I feel it can remain there and the README can provide the "basic overview of what the module does and how someone may use it".
The patch attached does that, and moves the INSTALL.txt file to a INSTALL.md file.
Comment #8
loopduplicateSounds good to me :) I wonder what you all think about wrapping consistency? Here's my thoughts:
Some lines break at 80 characters and some don't. Probably best to keep it consistent. Since it's not code, it's ok to extend beyond the 80 character mark but it seems fine to restrict all lines too.
Same as above, this line goes beyond the 80 char mark whereas other lines are wrapped at 80 chars.
When wrapping text, there shouldn't be a space before the wrapped lines.
Regards,
Jeff
Comment #9
BarisW CreditAttribution: BarisW at LimoenGroen commentedThanks all! I fixed the wrapping issues when committing it.
Comment #11
BarisW CreditAttribution: BarisW at LimoenGroen commented