[OPEN-ILS-DOCUMENTATION] 2.4 documentation needs

Tue Apr 2 15:54:39 EDT 2013

Hi Robert,

I would be happy to add the accompanying documentation for development done
by Equinox directly to the repository.  If this is a workflow that DIG
would like to adapt for the 2.4 documentation, just let me know.

Thanks!
Angela

On Tue, Apr 2, 2013 at 2:07 PM, Soulliere, Robert <
robert.soulliere at mohawkcollege.ca> wrote:

> Hi Kathy,
>
> I can update those.
>
> Long term, I wonder if it would be possible to make the documentation
> work-flow more efficient for adding new feature documentation to the
> official documentation?
>
> If new features are added to the code base (the official Evergreen
> repository) by a particular group, organization or company, would it be
> possible to have the group add the accompanying documentation (if they are
> already producing documentation in asciidoc format) directly into the
> official documentation since it goes into the same official Evergreen
> repository as the code and follows similar steps to contributing the code?
> By having the authors/owners of the documentation directly add to the
> repository, it will also allow updating to be more timely since the
> original authors will be more intimately linked to the info in the official
> docs and will not have to nudge or remind others to update the repository
> docs to keep up to the same docs stored in other places.
>
> I know that in some cases there are technical challenges which might block
> direct access to the repository for authors and in some cases where we will
> need to convert from other formats for the authors, but I just wonder of it
> would be possible to develop a work-flow to promote more direct access to
> the repository? Or, is that too dangerous?
>
> The "hiding fields in the copy editor" documentation  is an example of how
> things can slip through the cracks with the current system since the
> availability of that documentation was unknown or forgotten.
>
> Regards,
> Robert
>
>
>
> Robert Soulliere, BA (Hons), MLIS
> Digital Systems Librarian
> Mohawk College Library
> robert.soulliere at mohawkcollege.ca
> Telephone: 905 575 1212 x3936
> Fax: 905 575 2011
>
> ________________________________________
> From: open-ils-documentation-bounces at list.georgialibraries.org [
> open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of
> Kathy Lussier [klussier at masslnc.org]
> Sent: April 2, 2013 11:19 AM
> To: Documentation discussion for Evergreen software
> Subject: [OPEN-ILS-DOCUMENTATION] 2.4 documentation needs
>
> Hi all!
>
> Evergreen 2.4 beta has been out for a couple of weeks and brings with it
> some nice new features that need documentation. I took some time to go
> through the release notes and identify new features that would benefit
> from some documentation. I've identified those documentation needs at
> http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:2.4_needs.
>
> The new features that came through Equinox development already have
> documentation on its way - thank you ESI!
>
> We need volunteers to document several other features that came from
> other developers. Some may just require a couple of sentences to be
> added to existing docs while others might require a chapter on their
> own. In many cases, I identified places in the documentation where I
> thought the feature could be incorporated. Some of these new features
> offer a great opportunity for those who are new to DIG to provide a
> contribution. If you would like to volunteer, please add your name to
> the wiki in blue so that we don't have people duplicating efforts. If
> you don't have a wiki account, you can get one by sending an e-mail to
> docs at evergreen-ils.org.
>
> Although DIG uses AsciiDoc as the format for documentation, you can
> contribute your documentation in any format, such as Word or Open Office.
>
> I also have a question for the larger group regarding the Evergreen in
> Action manual. I identified a couple of new features that should make it
> into the manual if we decide to offer a 2.4 version of the manual. It
> doesn't look like it will take a lot of work - there were a couple of
> OPAC features, something for Vandelay, and possibly a couple of
> acquisitions features. Is there any interest in keeping this manual up
> to date for 2.4? If so, I'll be happy to update the sections for
> acquisitions and Vandelay; we would then just need a volunteer to handle
> the two OPAC features.
>
> Robert, ESI already has documentation for the link checker that is
> available in 2.4 -
>
> http://www.esilibrary.com/esi/docs/asciidoc/2.4_Link_Checker_doc/2.4_Link_Checker.txt
> .
> I also noticed that the documentation for hiding fields in the copy
> editor (2.2) did not appear to make it into the official docs. Would you
> be willing to add those?
>
> Thanks!
> Kathy
>
> --
> Kathy Lussier
> Project Coordinator
> Massachusetts Library Network Cooperative
> (508) 343-0128
> klussier at masslnc.org
> Twitter: http://www.twitter.com/kmlussier
>
> _______________________________________________
> 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.
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
>

-- 
Angela Kilsdonk
Education Manager
Equinox Software Inc. / The Open Source Experts
Phone: 770-709-5592 | 1-877-OPEN-ILS (673-6457) x5592
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://list.georgialibraries.org/pipermail/open-ils-documentation/attachments/20130402/5311d796/attachment.htm>