While evaluating this module, while it has a readme, I noticed the readme could use some helpful links (permalinks as opposed to aliases) and configurations. Also, the formatting does not align to Drupal standards for documentation. There should be a clear table of contents and lines should be hard wrapped at 80 characters for better accessibility.
According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....
https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
Patch to follow, thanks!
Comment | File | Size | Author |
---|---|---|---|
#25 | google_analytics-README_configs_and_useful_links-3007939-25-D8.patch | 2.79 KB | thalles |
| |||
#17 | google_analytics-README-3007939-17.patch | 4.25 KB | alonaoneill |
|
Comments
Comment #2
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedI uploaded a patch that adds some useful configurations and links.
Thanks for the work on this project!
Comment #3
hass CreditAttribution: hass commentedThis module requires no other modules.
Budda is not maintaining anything.
Comment #4
dhirendra.mishra CreditAttribution: dhirendra.mishra at Srijan | A Material+ Company commentedAlong with solving from #3 Also removing whitespace at line no 86 after applying above patch.
Comment #5
hass CreditAttribution: hass commentedComment #6
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedI uploaded the patch, that fixes module list and maintainers.
Inderdiff added
Thanks.
Comment #7
hass CreditAttribution: hass commentedREADME.txt is left behind.
Comment #8
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedComment #9
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedComment #10
hass CreditAttribution: hass commentedSee #7 and the links to drupal documentation are not working. It is also new to me that we have a rule to create .md files and I‘d like to review these rules. No idea what the benefit of this changes is.
Comment #11
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedWhile READMEs can be written in any text file format, the most common one that is used nowadays is Markdown. It allows you to add some lightweight formatting.
Also all links work for me, please check again.
Thanks
Comment #12
hass CreditAttribution: hass commentedNothing from feedback has been addressed. And let me know where it is written that Drupal readme files should be markdown style, please. This is totally new to me.
Comment #13
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedAccording Drupal README standarts:
"During the Drupal project's lifetime, there has never been a clear consensus about what a README-file should look like, and many different styles exists as a result (see links below). However, we prefer new projects to use the format described on this page, or a format recognized by the Markdown filter module. If you use Markdown, your file should be named README.md (and use valid Markdown syntax), otherwise it should be named README.txt."
Link to follow.
https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
Marking needs review.
Thanks.
Comment #14
dhirendra.mishra CreditAttribution: dhirendra.mishra at Srijan | A Material+ Company commentedi Agree with alonaoneill
Comment #15
hass CreditAttribution: hass commentedSince this is not a new project we can stick with the old readme. Thanks for confirmation.
Comment #16
hass CreditAttribution: hass commentedsection is missing
Comment #17
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedAdded Usage part.
Thanks
Comment #20
hass CreditAttribution: hass commentedComment #21
hass CreditAttribution: hass commentedThe output does not really look right. See https://git.drupalcode.org/project/google_analytics/blob/8.x-3.x/README.md
[current-user:role-names]
should be CODE style.Comment #22
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedPatch I provided doesn't have "Index: 1 Value: [current-user:role-names]" in one line, but I can add empty line after "Google Analytics test page".
How do want to me change it? Is that "Index: 1 Value: [current-user:role-names]" necessary or should I remove it?
Thanks!
Comment #23
hass CreditAttribution: hass commentedA line break is required.
Comment #24
thallesFollow a patch on markdown format. I alter url of user maintainer because de username can change, but the id never change.
Comment #25
thallesComment #26
thallesComment #29
hass CreditAttribution: hass commented