Your README.txt does not follow best practices (headings need to be uppercase). See https://www.drupal.org/node/2181737 .

The INTRODUCTION section is missing.
The REQUIREMENTS section is missing.
The INSTALLATION section is missing.
The CONFIGURATION section is missing.

Comments

rksyravi’s picture

Hi,
Can use the patch to fix all the documentation issue.

rksyravi’s picture

Status: Needs work » Needs review
Webbeh’s picture

StatusFileSize
new8.93 KB
new1.7 KB

Thanks for the work, u/rksyravi. I've applied some small grammatical changes based on #2.

firfin’s picture

Status: Needs review » Needs work

I would remove the part about the alternative. MCC is very abandoned. See #2667688: Remove MCC link from project page

Probably best to remove this :

+
+ * MCC (http://drupal.org/project/mcc):
+ An alternative campaign creation tool.
+

Also see #3086948: Documentation updates, which I just closed as a duplicate. It's a bit older, but still has some valid points.

Webbeh’s picture

Status: Needs work » Needs review
StatusFileSize
new7.28 KB
new8.31 KB

I wonder if the related issue might be re-opened and scoped to in-module documentation updates?

- 'This module has not yet been ported to Drupal 8' , strange for a README.md in the d8-1.11 version.

Removed deprecated mention of Drupal 8 port, as there is a solid release in D8. Don't know how I missed that in the last patch.

I would remove the part about the alternative. MCC is very abandoned.

Done.

- is there a reason to mention mailchimps' competitors? Also this line crosses the 80 char border.

Agreed. Removed.

Patch and interdiff attached.

firfin’s picture

Wow, that was quick ;-)
Gonna try it out ASAP ( working on another issue ATM) and will also try to make it a .md instead of .txt. So much easier on the eyes ;-)

firfin’s picture

firfin’s picture

StatusFileSize
new10.14 KB

Made it into a README.md, so much easier to read (on github or an IDE).
Same for the others README files in the submodules.
No interdiff, it's just filename changes.

mshaver’s picture

Assigned: Unassigned » aprice42
Pastenes’s picture

Assigned: aprice42 » Pastenes

  • firfin authored d164667 on issue-3105040
    Issue #3105040 by Webbeh, firfin, rksyravi, Pastenes: Documentation...

  • firfin authored d164667 on 8.x-1.x
    Issue #3105040 by Webbeh, firfin, rksyravi, Pastenes: Documentation...
Pastenes’s picture

Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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