The README.txt file is out of date and is not formatted to current standards.

Comments

scflmark’s picture

StatusFileSize
new2.7 KB

Suggested update for README.txt is attached.

ultimike’s picture

Mark,

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

scflmark’s picture

StatusFileSize
new2.91 KB

Mike,

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.

damienmckenna’s picture

Assigned: scflmark » Unassigned
Issue summary: View changes
Status: Active » Needs review
Webbeh’s picture

StatusFileSize
new2.97 KB

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

renatog’s picture

Version: 7.x-3.7 » 8.x-3.x-dev
Status: Needs review » Reviewed & tested by the community

#5 really makes sense for me. +1 to it

  • RenatoG committed ff4cbe3 on 7.x-3.x authored by scflmark
    Issue #2078661 by scflmark, Webbeh, ultimike, DamienMcKenna, RenatoG:...
renatog’s picture

Version: 8.x-3.x-dev » 7.x-3.x-dev
Status: Reviewed & tested by the community » Fixed

Committed to the dev branch: 7.x-3.x

Thank you so much, everyone

renatog’s picture

Status: Fixed » Closed (fixed)

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