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!

CommentFileSizeAuthor
#25 google_analytics-README_configs_and_useful_links-3007939-25-D8.patch2.79 KBthalles
#17 google_analytics-README-3007939-17.patch4.25 KBalonaoneill
#6 interdiff-3007939-2-6.txt9.33 KBalonaoneill
#6 google_analytics-d8-README-3007939-6.patch4.03 KBalonaoneill
#4 google_analytics-README-3007939-4.patch5.22 KBdhirendra.mishra
#2 google_analytics-README-3007939-2.patch5.31 KBalonaoneill

Comments

alonaoneill created an issue. See original summary.

alonaoneill’s picture

alonaoneill commented
Assigned: alonaoneill » Unassigned
Status: Active » Needs review
StatusFileSize
new google_analytics-README-3007939-2.patch5.31 KB

I uploaded a patch that adds some useful configurations and links.
Thanks for the work on this project!

hass’s picture

hass commented
Status: Needs review » Needs work

This module requires no other modules.

Budda is not maintaining anything.

dhirendra.mishra’s picture

dhirendra.mishra commented
Status: Needs work » Needs review
StatusFileSize
new google_analytics-README-3007939-4.patch5.22 KB

Along with solving from #3 Also removing whitespace at line no 86 after applying above patch.

hass’s picture

hass commented
Status: Needs review » Needs work
alonaoneill’s picture

alonaoneill commented
Status: Needs work » Needs review
StatusFileSize
new google_analytics-d8-README-3007939-6.patch4.03 KB
new interdiff-3007939-2-6.txt9.33 KB

I uploaded the patch, that fixes module list and maintainers.
Inderdiff added
Thanks.

hass’s picture

hass commented
Status: Needs review » Needs work

README.txt is left behind.

alonaoneill’s picture

alonaoneill commented
alonaoneill’s picture

alonaoneill commented
Status: Needs work » Needs review
hass’s picture

hass commented
Status: Needs review » Needs work

See #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.

alonaoneill’s picture

alonaoneill commented
Status: Needs work » Needs review

While 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

hass’s picture

hass commented
Status: Needs review » Needs work

Nothing 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.

alonaoneill’s picture

alonaoneill commented
Status: Needs work » Needs review

According 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.

dhirendra.mishra’s picture

dhirendra.mishra commented

i Agree with alonaoneill

hass’s picture

hass commented

Since this is not a new project we can stick with the old readme. Thanks for confirmation.

hass’s picture

hass commented 
+++ b/README.md
@@ -0,0 +1,134 @@
+ * Usage

section is missing

alonaoneill’s picture

alonaoneill commented
StatusFileSize
new google_analytics-README-3007939-17.patch4.25 KB

Added Usage part.
Thanks

  • hass committed c5c17dd on 8.x-3.x authored by alonaoneill 
    Issue #3007939 by alonaoneill, dhirendra.mishra: README configs and...

  • hass committed 44cef44 on 8.x-2.x authored by alonaoneill 
    Issue #3007939 by alonaoneill, dhirendra.mishra: README configs and...
hass’s picture

hass commented
Status: Needs review » Fixed
hass’s picture

hass commented
Status: Fixed » Needs work

The output does not really look right. See https://git.drupalcode.org/project/google_analytics/blob/8.x-3.x/README.md

  • CONFIGURATION and CUSTOM DIMENSIONS AND METRICS have a box that should not exists
  • "Index: 1 Value: [current-user:role-names]" is all in one line + [current-user:role-names] should be CODE style.
  • "Title: Google Analytics test page Body:" is in one line, but should have a line feed.
alonaoneill’s picture

alonaoneill commented

Patch 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!

hass’s picture

hass commented

A line break is required.

thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
commented

Follow a patch on markdown format. I alter url of user maintainer because de username can change, but the id never change.

thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
commented
StatusFileSize
new google_analytics-README_configs_and_useful_links-3007939-25-D8.patch2.79 KB
thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
commented
Status: Needs work » Needs review

  • hass committed 8774063 on 8.x-3.x authored by thalles 
    Issue #3007939 by alonaoneill, thalles, dhirendra.mishra, hass: README...

  • hass committed a8a2ebb on 8.x-2.x authored by thalles 
    Issue #3007939 by alonaoneill, thalles, dhirendra.mishra, hass: README...
hass’s picture

hass commented
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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