[OPEN-ILS-DEV] followup from dev meeting - documentation wiki notes

[Soulliere, Robert]

Hi Everyone,

This is just a follow up from the Developer meeting on the IRC channel yesterday.

Dan made an important suggestion to add pointers to the documentation from wiki pages which have been converted.

I went ahead and added notes on the wiki pages which I have converted to the Evergreen documentation. The notes look like this:

"NOTE: This documentation is also available in the Evergreen documentation at http://libdog.mohawkcollege.ca/evergreen_documentation/draft/html/. In github: http://github.com/rsoulliere/Evergreen-DocBook/blob/master/1.6/admin/z3950.xml."

I included a link to the documentation and a link to the specific github page. The link to the documentation will hopefully get people to test and use the documentation. The Github reference will let wiki editors and authors know where the docbook xml file is, if they would like to update it. Once the documentation is out of draft mode, perhaps the wiki page could have just a link to the documentation instead of duplicating the content in 2 formats in 2 places. I don't think we can remove content form the wiki until the following happen:

1) Documentation is out of draft mode and considered complete enough to be "stable".
2) The chapters to replace wiki pages are tested.
3) The documentation finds a permanent home with permanent links.

I also added notes on the documentation outline indicating which wiki pages were used for specific sections:
http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:outline

Thanks,
Robert





This E-mail contains privileged and confidential information intended
only for the individual or entity named in the message.  If the reader
of this message is not the intended recipient, or the agent responsible
to deliver it to the intended recipient, you are hereby notified that
any review, dissemination, distribution or copying of this communication
is prohibited.  If this communication was received in error, please
notify the sender by reply E-mail immediately, and delete and destroy
the original message.