[OPEN-ILS-GENERAL] Technical Documentation

[Lori Bowen Ayre]

David,

That would be awesome.  We've already got some good info up there and I'm
sure you have another level of "what we need" stuff since you are further
along.

Thomas Berezansky (tsbere) is going to work on the overview of the four
main sections that make up Evergreen including:


   - OpenSRF layer itself, the basic communication framework that Evergreen
   is built on. Sometimes a feature requires extending it, or bugs can be
   traced back to it. This is mainly C and Perl.
   - Evergreen server-side, which is mostly Perl, but includes other things
   like C. This would also, IMO, include the OPAC as we go into the age of the
   Template Toolkit OPAC.
   - Evergreen database, which can be as simple as tables and columns, or
   can get into things like stored procedures and triggers. Postgresql,
   PLPGSQL, Perl.
   - Staff Client, which can to a limited extent cover the Javascript OPAC
   as well. This is currently mostly XUL and Javascript.

In looking at the notes on the wiki so far, this is going to help address
some things already.  I've added a section to the wiki that will allow
those who will be writing the documentation that will help new developers
can indicate what they'll be contributing.

As both contributors of documentation and contributors of wish list items
get going, we can update the wiki so we don't have any duplicate effort.

And now that we have gone this far, I think we need to get the DIG involved
since we are really doing work that belongs there ultimately.  I'll check
in with them to make sure we don't go too far afield!

Lori

Lori


On Mon, Feb 6, 2012 at 1:35 PM, David Busby <david.busby at edoceo.com> wrote:
> Lori,
>  I'm currently working with KCLS on some Evergreen stuffs; I have
> extra availability to assist on this.  I also have a guy on staff who
> does docs and QA type stuff; so he maybe another resource for this?
>
> --
> David Busby
> Edoceo, Inc.
> http://edoceo.com/
> 206.282.6500
>
>
>
> On Fri, Feb 3, 2012 at 10:52 AM, Lori Bowen Ayre <lori.ayre at galecia.com>
wrote:
>> Greetings All,
>>
>> I am looking for someone to develop some technical documentation that
>> is needed for new developers.  I have funding for this work (via the
>> KCLS IMLS grant).  I will need help both identifying what is needed
>> (based on what new developers are reporting is lacking) and may need
>> help from both experienced developers to help us find the info so it
>> can then be documented.
>>
>> So, anyone available for a few hours a week to work on this?  Not a
>> huge budget but there is something!  If you are interested, send a
>> note. Ideally, I'll get one experienced and one newbie developer (or
>> even developer wannabe) and get you to work a bit together.
>>
>> Lori
>>
>> =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=
>> Lori Bowen Ayre //
>> Library Technology Consultant / The Galecia Group
>> Oversight Board & Communications Committee / Evergreen
>> (707) 763-6869 // Lori.Ayre at galecia.com
>> Availability:  http://tungle.me/lori.ayre
>>
>> Specializing in open source ILS solutions, RFID, filtering,
>> workflow optimization, and materials handling
>> =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://libmail.georgialibraries.org/pipermail/open-ils-general/attachments/20120207/e63eb511/attachment-0001.htm>