According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu...

Thankyou. Patch to follow

CommentFileSizeAuthor
#14 admin_views-n2836511-14.patch4.34 KBdamienmckenna
#7 admin_views-d7-add-readme-2836511-7.patch2.78 KBvolkswagenchick
#5 admin_views-add-readme-2836511-5.patch2.46 KBloopduplicate
#4 admin_views-add-readme-2836511-4.patch0 bytesvolkswagenchick
#2 admin_views-add-readme-2836511-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: Needs work » Needs review
StatusFileSize
new admin_views-add-readme-2836511-2.patch2.46 KB

Added patch that includes a README file for the admin_views module.

Thanks!

Status: Needs review » Needs work

The last submitted patch, 2: admin_views-add-readme-2836511-2.patch, failed testing.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Status: Needs work » Needs review
StatusFileSize
new admin_views-add-readme-2836511-4.patch0 bytes

Resubmitting patch after failed testing

Thankyou

loopduplicate’s picture

loopduplicate commented
Component: Documentation » Code
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new admin_views-add-readme-2836511-5.patch2.46 KB

Looks like the patch in #4 is blank for some reason. I am reuploading the patch from #2 and marking as "Do not test" since this patch only affects the README. I'm marking this issue as RTBC as well; the patch looks great. Thanks volkswagenchick :)

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: Unassigned » volkswagenchick
Status: Reviewed & tested by the community » Needs work

I came back and reviewed this issue and realized I did not follow documentation standards.
Text manually word-wrapped within around 80 cols.

+++ b/README.txt
@@ -0,0 +1,57 @@
+* Install the Administrative views module as you would normally install a contributed Drupal module. Visit https://www.drupal.org/docs/7/extending-drupal-7/installing-contributed-modules-find-import-enable-configure-drupal-7 for further information.

Best practices is to avoid using node aliases as they may change over time.
Using a premalink would be more appropriate.

Patch to follow soon, and thanks for your patience with my learning curve!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Status: Needs work » Needs review
StatusFileSize
new admin_views-d7-add-readme-2836511-7.patch2.78 KB

Uploaded a patch with correct formatting and replaced node alias with permalink.
Thanks!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: volkswagenchick » Unassigned
dhruveshdtripathi’s picture

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

Patch #7 looks OK. Changing status to RTBC.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 7: admin_views-d7-add-readme-2836511-7.patch, failed testing. View results

Stevel’s picture

Stevel commented
Status: Needs work » Reviewed & tested by the community

Patch failure is totally unrelated, caused by views update, so back to RTBC for this.

chris matthews’s picture

chris matthews commented
Parent issue: » #3018626: Plan for Administration Views 7.x-1.8 release
damienmckenna’s picture

damienmckenna
Location TN, USA
commented
Status: Reviewed & tested by the community » Needs work

Needs updating after recent commits.

damienmckenna’s picture

damienmckenna
Location TN, USA
commented
Status: Needs work » Needs review
StatusFileSize
new admin_views-n2836511-14.patch4.34 KB

Some improvements.

damienmckenna’s picture

damienmckenna
Location TN, USA
commented
Status: Needs review » Fixed

Committed. Thank you.

Status: Fixed » Closed (fixed)

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