While I was evaluating this module, I noticed it lacked a readme. 


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

I will add a patch with the readme, thanks!

CommentFileSizeAuthor
#6 cognito-add-readme-2988696-4.patch3.4 KBleon kessler
#4 cognito-add-readme-2988696-3.patch3.35 KBleon kessler
#2 cognito-add-readme-2988696-2.patch2.26 KBlegaudinier

Comments

legaudinier created an issue. See original summary.

legaudinier’s picture

legaudinier commented
Assigned: legaudinier » Unassigned
Status: Active » Needs review
StatusFileSize
new cognito-add-readme-2988696-2.patch2.26 KB

Patch includes readme. Thanks!

dani3lr0se’s picture

dani3lr0se commented
Status: Needs review » Reviewed & tested by the community

The patch applied successfully. Formatting, spelling and grammar all look good. It also aligns with Drupal standards. Thanks for the patch @legaudinier.

leon kessler’s picture

leon kessler commented
Status: Reviewed & tested by the community » Needs review
StatusFileSize
new cognito-add-readme-2988696-3.patch3.35 KB

I've added in setup instructions from #2947748: Document User pools setup (these are pretty important for being able to use the module).

benjy’s picture

benjy commented 
+++ b/README.txt
@@ -0,0 +1,114 @@
+The best way to achieve this currently is to install OpenID Connect and assign

"achieve this"? I'm not sure what that's referring to?

leon kessler’s picture

leon kessler commented
StatusFileSize
new cognito-add-readme-2988696-4.patch3.4 KB

Yep that parts a bit confusing (was just straight copypasted from the module page). I've edited it a bit to make more sense.

benjy’s picture

benjy commented
Status: Needs review » Fixed

Committed and pushed, thanks.

  • benjy committed 54c0f4d on 8.x-1.x authored by Leon Kessler 
    Issue #2988696 by Leon Kessler, legaudinier: README missing

Status: Fixed » Closed (fixed)

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