Closed (fixed)
Project:
Views (for Drupal 7)
Version:
7.x-3.x-dev
Component:
Documentation
Priority:
Minor
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
31 Aug 2013 at 23:49 UTC
Updated:
13 Feb 2021 at 00:04 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
scflmark commentedSuggested update for README.txt is attached.
Comment #2
ultimikeMark,
This looks like a good start, but I have a few of questions/comments:
1. You mentioned that the current README "is not formatted to current standards" - to which standards are you referring? Are you talking about some basic best practices as mentioned on https://drupal.org/node/447604?
2. In the summary/description section, you may want to add something about there being many other modules that extend Views. It could be interpreted by some that out-of-the-box Views does all the things mentioned in this section.
2. Looking at your patch, you're missing a closing paren in the "REQUIREMENTS" section.
3. In the INSTALLATION section, it shouldn't be recommended to install the module at /modules.
4. Also, I'm not crazy about the wording of "Place the entirety of the Views directory in sites/all/modules/views".
5. I've never been a fan of putting a CONTACTS section in a README - it signals that it is accepted practice to contact the module maintainers directly for support (when the issue queue is the appropriate place).
-mike
Comment #3
scflmark commentedMike,
Yes, the edited README.txt file is base on Drupal's guidelines for readme files. The specific format this patch is based on is sun's README.txt style with some adjustments based on specific requirements of the Views module and suggestions you made in your previous comment.
The attached patch file takes the previous observations into consideration and provides some additional resource links and clarification of module details.
Comment #4
damienmckennaComment #5
WebbehGiven the age of the patch being 6 years old, I suppose it's no surprise that the patch in #3 fails to apply with 7.x-3.x. Re-rolled patch with the latest 7.x-3.x branch.
Additional changes made:
- Introduction was expanded to include the additional modules extending Views.
- Configuration was expanded to include Permissions setting and locating Views settings.
- Advanced Help clarification was added to TROUBLESHOOTING.
For review.
Comment #6
renatog commented#5 really makes sense for me. +1 to it
Comment #8
renatog commentedCommitted to the dev branch: 7.x-3.x
Thank you so much, everyone
Comment #9
renatog commented