I wrote the D8 README awhile back.
I have since learned more about documentation standards since first working on this README. I have updated the README to address formatting issues
Thanks!

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

Assigned: volkswagenchick » Unassigned
Status: Needs work » Needs review
FileSize
3.35 KB

Updated formatting for README and uploaded patch.
Thanks for your patience with my learning curve!

mkdok’s picture

Status: Needs review » Needs work

First of all check the spelling of the some words. Secondly, thanks for removing me from maintainers section (sarcasm).

volkswagenchick’s picture

Oh no! My copy and paste has failed me (and you), I will review. Thanks for the quick feedback

volkswagenchick’s picture

Status: Needs work » Needs review
FileSize
3.28 KB

Updated patch as per suggestions in comment 3. I did not find any spelling errors after running patch through spell checker. Added @mkdok to maintainer list (Sorry!)

Meenu Kansal’s picture

Reviewed looks good to me

Meenu Kansal’s picture

Status: Needs review » Reviewed & tested by the community
mmjvb’s picture

Status: Reviewed & tested by the community » Needs work

Either Max or mkdoc should be listed as maintainer. Now it reads mdoc.

volkswagenchick’s picture

Status: Needs work » Needs review
FileSize
3.49 KB
678 bytes

Oooops! I have uploaded a patch fixing the typo on the maintainer list. Comment #8 asked to have Max added to the list, but I do not see that party listed as a maintainer or having made any commits. If you provide the info for that user, I can add them to the README as well. If they are currently a maintainer to the project, the project page should be updated.
Thanks for the review!

I also uploaded an interdif between patches 5 and 9.

mmjvb’s picture

Status: Needs review » Reviewed & tested by the community

#8 asked for correctly mentioning mkdoc, either Max or mkdoc, instead of mdoc. When you follow the link for mkdoc, you'll see that his name is Max. Considering the others have their names mentioned, it would have made more sense to put Max there, but the line shouldn't have been removed in the first place. So, sticking to mkdoc as it was before is fine as well.

Neslee Canil Pinto’s picture

Hello all, i am the new maintainer of this module. So i have updated my info in this patch.

Neslee Canil Pinto’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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