The README.txt file needs to be updated for at least three reasons:

  1. The Apache Solr PHP Client library is no longer required.
  2. sarnia.make is now named sarnia.make.example.
  3. At some point the 'Solr property' Views field was renamed to 'Data'.

Comments

dcam’s picture

BTW, I've already made these changes to the online documentation.

jmdeleon’s picture

Patch working for me.

  • jmdeleon committed 9044777 on 7.x-1.x authored by dcam
    Issue #2496765 by dcam: Update README.txt
    
dcam’s picture

Status: Needs review » Fixed
jmdeleon’s picture

Status: Fixed » Needs work
jmdeleon’s picture

The images in the documentation don't accurately reflect the latest version of the module, so they (and the documentation) should be updated.

jason1234’s picture

Updating Images.

dcam’s picture

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

dcam’s picture

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

dcam’s picture

Oops, sorry for the double-post.

jmdeleon’s picture

dcam: 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.

jmdeleon’s picture

StatusFileSize
new1.43 KB

Attached 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

jason1234’s picture

StatusFileSize
new4.52 KB
new2.25 MB

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

jmdeleon’s picture

StatusFileSize
new996.91 KB

jason1234: I reduced the color depth on your screen shots and clipped them slightly, to reduce the file size of each of the images.

  • jmdeleon committed feea4d8 on 7.x-1.x
    Issue #2496765 by jmdeleon: Remove unused images
    
jmdeleon’s picture

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

jmdeleon’s picture

StatusFileSize
new4.85 KB

In 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 :)

jason1234’s picture

The handbook text and images have been updated.

  • jmdeleon committed b1b3ff8 on 7.x-1.x authored by jason1234
    Issue #2496765 by jmdeleon, jason1234: Update README.txt and images
    

  • jmdeleon committed f266c3e on 7.x-1.x
    Issue #2496765 by jmdeleon: Update README.txt - enhance hook_help to...
jmdeleon’s picture

Status: Needs work » Fixed
jmdeleon’s picture

Status: Fixed » Closed (fixed)

Now in beta5.