Attached is a README.txt for inclusion in the repo. This README is in sync with the external documentation page located here: https://www.drupal.org/node/2918525.

CommentFileSizeAuthor
#10 add_readme_to_repo-2918530-10.patch4.28 KBdhruveshdtripathi
#9 README.txt3.98 KBafireintheattic
#7 README.txt4 KBafireintheattic
#5 README.txt3.98 KBafireintheattic
#2 README.txt3.09 KBafireintheattic
README.txt2.96 KBafireintheattic

Comments

afireintheattic created an issue. See original summary.

afireintheattic’s picture

afireintheattic commented
StatusFileSize
new README.txt3.09 KB

Update README to better follow Drupal standards.

dhruveshdtripathi’s picture

dhruveshdtripathi commented
Status: Needs review » Needs work

Hi Eric,

How about listing ADDING BROWSERS, ADDING GROUPS, ASSIGNING PARAGRAPH TYPES TO GROUPS under Configurations section as per README standard?

Also add Installation and Maintainers sections as per README Template

Thank you!

afireintheattic’s picture

afireintheattic commented
Assigned: Unassigned » afireintheattic
afireintheattic’s picture

afireintheattic commented
StatusFileSize
new README.txt3.98 KB

Updated this to include Installation, Configuration, and Maintainers section.

afireintheattic’s picture

afireintheattic commented
Assigned: afireintheattic » Unassigned
Status: Needs work » Needs review
afireintheattic’s picture

afireintheattic commented
StatusFileSize
new README.txt4 KB
dhruveshdtripathi’s picture

dhruveshdtripathi commented
Status: Needs review » Needs work

Content seems OK. Just 2 small changes to be made according to README Template :

  • Add "*" before Maintainers' names
  • Bullets denoted by asterisks (*) with hanging indents

Thank you!

afireintheattic’s picture

afireintheattic commented
Status: Needs work » Needs review
StatusFileSize
new README.txt3.98 KB

Added asterisks next to maintainer names and adjusted bullet indentation.

dhruveshdtripathi’s picture

dhruveshdtripathi commented
StatusFileSize
new add_readme_to_repo-2918530-10.patch4.28 KB

Bullets denoted by asterisks (*) with hanging indents

This point was not followed in patch #9.

Created a patch with all necessary changes.

Thank you.

Aanal.addweb’s picture

Aanal.addweb commented
Status: Needs review » Reviewed & tested by the community

@dhruveshdtripathi, Thanks for the patch, it seems perfect to me, as per the mentioned standards !..

mojiferous’s picture

mojiferous
he/him
commented
Status: Reviewed & tested by the community » Fixed
Aanal.addweb’s picture

Aanal.addweb commented

@Mojiferous, Thanks for committing the patch, but I think you forgot to provide me the RTBC Credit. Can you please do the needful.

  • Mojiferous committed 234f94c on 8.x-1.x 
    Issue #2918530 by dhruveshdtripathi, afireintheattic: Add README to repo

Status: Fixed » Closed (fixed)

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