While evaluating this module, while it has a readme, I noticed the readme could use some helpful links and configurations.
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!

I uploaded a patch that adds a useful readme as per documentation standards, thanks!!

CommentFileSizeAuthor
#5 varbase_media-readme-3013288-2.patch2.46 KBvolkswagenchick
#5 interdiff-3013288-2-5.txt345 bytesvolkswagenchick
#2 varbase_media-readme-3013288-2.patch2.46 KBvolkswagenchick

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: volkswagenchick » Unassigned
Status: Active » Needs review
StatusFileSize
new varbase_media-readme-3013288-2.patch2.46 KB

I uploaded a patch that aligns the readme to Drupal documentation standards. Added requirements section. Thanks!!

alonaoneill’s picture

alonaoneill commented

Looks good, but 

+++ b/README.md
@@ -1,11 +1,76 @@
+   Drupal module. Visit ¶

An extra space.
Thanks

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Status: Needs review » Needs work
volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Status: Needs work » Needs review
StatusFileSize
new interdiff-3013288-2-5.txt345 bytes
new varbase_media-readme-3013288-2.patch2.46 KB

Let's try this again... Included an interdiff for easy review. Thanks

alonaoneill’s picture

alonaoneill commented
Status: Needs review » Needs work

Looks like it's the same patch ? I still see a space.
Thanks

+++ b/README.md
@@ -1,11 +1,76 @@
+   Drupal module. Visit ¶

Extra space.

rajab natshah’s picture

rajab natshah
he/him
commented
Version: 8.x-6.x-dev » 8.x-7.x-dev
rajab natshah’s picture

rajab natshah
he/him
commented

rajab natshah’s picture

rajab natshah
he/him
commented
Title: README - formatting, configs and useful links » Change [Varbase Media] README - formatting, configs and useful links
Assigned: Unassigned » mohammed j. razem
Status: Needs work » Needs review
Issue tags: +varbase-8.7.0
rajab natshah’s picture

rajab natshah
he/him
commented
Assigned: mohammed j. razem » Unassigned
rajab natshah’s picture

rajab natshah
he/him
commented
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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