Closed (fixed)
Project:
Sarnia
Version:
7.x-1.x-dev
Component:
Documentation
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
28 May 2015 at 22:00 UTC
Updated:
3 Jul 2015 at 17:07 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
dcam commentedBTW, I've already made these changes to the online documentation.
Comment #2
jmdeleon commentedPatch working for me.
Comment #4
dcam commentedComment #5
jmdeleon commentedComment #6
jmdeleon commentedThe images in the documentation don't accurately reflect the latest version of the module, so they (and the documentation) should be updated.
Comment #7
jason1234 commentedUpdating Images.
Comment #8
dcam commentedI would remove the images from the module files. While I don't look at every module's README file, I'm not aware of any other module that packages documentation images in its files like this. That's just my opinion though.
Comment #9
dcam commentedI do acknowledge that the images need to be updated. Whether or not we choose to keep them in the module files, the online documentation images must be updated.
Comment #10
dcam commentedOops, sorry for the double-post.
Comment #11
jmdeleon commenteddcam: I was thinking of removing the images from the module as well, and had committed a change at one point. But the README.txt currently still makes reference to them, which is why I returned the images to the module. Including the images does bloat the module size considerably.
One of the reasons I had left the release in beta was that the documentation and help really needed to be upgraded.
I had been looking into a way of making the images visible if the README was written in Markdown, but not made a lot of progress in that area.
The online images definitely need to be updated.
Comment #12
jmdeleon commentedAttached here is a patch, enhancing the module's hook_help() call, that enables the README.txt to be displayed within the basic Drupal Help mechanism. It is based on code similar to that which is suggested in the Module Documentation Guidelines:
https://www.drupal.org/node/161085
Comment #13
jason1234 commentedThe images for the README file in the module and the handbook needed to be updated. Some of the text has also been modified in order to make the text consistent with the new images.
Comment #14
jmdeleon commentedjason1234: I reduced the color depth on your screen shots and clipped them slightly, to reduce the file size of each of the images.
Comment #16
jmdeleon commentedI noted that the online handbook and the README.txt included two images (image-9.png and image-11.png) that were not referred to anywhere. Those images were removed and a commit done for the removal.
Comment #17
jmdeleon commentedIn checking the Wikipedia link cited in the documentation, I noted that the Sarnia Photovoltaic Plant is no longer the world's largest, but still the largest in Canada. Updating that claim in the documentation :)
Comment #18
jason1234 commentedThe handbook text and images have been updated.
Comment #21
jmdeleon commentedComment #22
jmdeleon commentedNow in beta5.