Create repo wiki or put in README?

[ruebot]

Lots of system should be conveyed to a user getting up and running with the recipe. We just a bit different than the traditional install documentation. Should this live in the README, or should we create a wiki? Also, is this what the 'Attributes' section in the README is intended to convey?

I'm thinking of stuff like:

• How to start and stop the Fedora
• Where each pertinent log lives
• Where does Fedora, Solr, Drupal, etc., live?
• JAVA OPTS -- where can they be tweaked?

[mjsuhonos]

The 'Attributes' section in the README is for documentation on relevant cookbook-level attributes, see eg. https://github.com/opscode-cookbooks/tomcat#attributes

So in this case we would include node['islandora']['version'], node['php']['upload_max_filesize'], etc. In particular, some that are ideally set at the VM/Vagrantfile level should be highlighted, eg. node['tomcat']['java_options'].

Common practice is to delegate documentation on components (Fedora, Solr, etc.) to those respective cookbooks, though in this case we've broken from practice by including the cookbooks within the same repo. I would propose that this type of internal documentation go into a wiki page.

[ruebot]

Sounds good!