[OPEN-ILS-DOCUMENTATION] IRC meeting 9/7

[Soulliere, Robert]

Just a few of things that might be of interest to them:

1) We began working on the development part of the documentation. I added several chapters from documentation written by developers including:

- Chapters on OpenSRF, Evergreen Data Models and Access, Evergreen Data Models and Access - from Dan Scott (thanks Dan!)
- Section on BibTemplate (part of the OPAC Customization Chapter) - combination of Dan Scott's presentation and Mike Rylander's Wiki documentation in BibTemplate
- Chapter on JSON - converted from Scott McKellar's tutorial on JSON located on wiki: http://open-ils.org/dokuwiki/doku.php?id=documentation:technical:jsontutorial
- Chapter on SuperCat - from Wiki documentation

Under Administration
SIP Server stuff from wiki
SRU and Z39.50 Server from wiki (I recently asked a technical question regarding Z39.50 testing on the DEV list a few weeks back but didn't get a reply.)


2) I am using autodoc to generate a Docbook document for chapter or appendix of the Evergreen database schema. I have left this chapter out of the draft documentation for now since it takes too long to process during Docbook conversion. I will add it back during more final testing stages.

3) The repository for the code is in a github repository not attached to other Evergreen repositories - Are they are comfortable with that for now or do they want to move a master repository more coupled with the Evergreen code?

4) The documentation home is on a server at Mohawk College. We do not mind hosting it especially during the draft stages but they need to be aware of the following:
- The server is a virtual server with 2GB of RAM running several other applications including an entire test Evergreen system. Lots of experimentation and learning occurs on this server. Do they think we need a permanent home for the documentation or a plan to migrate to a more stable and more central server for the Evergreen community?

5) Perhaps a plan on documentation for future versions of documentation needs to be discussed? Moving from 1.6.0 to 1.6.1 to 2.0.... There might not be a big leap between 1.6 and 1.6.1, but I imagine 1.6 to 2.0 will be a huge jump and massive changes to documentation will be required. How can be produce documentation for 2.0 in the most timely manner? Is there a way to get documentation on new features more quickly from those involved in the development?

Karen, I will leave it up to you in regards to what you want to include in the report. Some of my questions may be resolved before the meeting now that I brought them up here which will save time at the irc discussion.

Thanks,
Robert







-----Original Message-----
From: open-ils-documentation-bounces at list.georgialibraries.org [mailto:open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of Karen Collier
Sent: Wednesday, September 01, 2010 11:02 AM
To: Documentation discussion for Evergreen software
Subject: Re: [OPEN-ILS-DOCUMENTATION] IRC meeting 9/7

Galen,

Thanks for bringing this to the group's attention.  I will plan to attend and speak up for DIG.  If there's anyone else from DIG who plans to attend and would like to contribute to the report let me know and we can coordinate our efforts.

Thanks,
Karen

----- "Galen Charlton" <gmc at esilibrary.com> wrote:

> Ave documenters!
>
> As you may have seen on open-ils-general and open-ils-dev, Dan Scott
> has called an IRC meeting for next Tuesday at 2 p.m. EDT in the
> #evergreen channel.  I would like like to specifically call your
> attention to the draft agenda at
> http://open-ils.org/dokuwiki/doku.php?id=dev:meetings:2010-09.  It has
> a placeholder for a report by DIG, and I would like to encourage and
> invite you all to participate.  If there is a specific person who
> wants to lead the DIG report, or if you have other documentation
> issues to add to the agenda, you can update the wiki page directly.
>
> Regards,
>
> Galen
> --
> Galen Charlton
> VP, Data Services
> Equinox Software, Inc. / Your Library's Guide to Open Source
> email:  gmc at esilibrary.com
> direct: +1 352-215-7548
> skype:  gmcharlt
> web:    http://www.esilibrary.com/
>
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation

--
Karen Collier
Public Services Librarian
Kent County Public Library
408 High Street
Chestertown, MD 21620
410-778-3636
www.kentcountylibrary.org
_______________________________________________
OPEN-ILS-DOCUMENTATION mailing list
OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation

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.