Hi, Robert -- Asciidoc is fine with me: I'm partial to ascii-based markup languages, also (I use markdown to write most of my docs).
As far as creating a branch goes, I have rights to push to the working repo, but not to the documentation repo (as far as I know). Which repo is it where current work is being done (is it still Evergreen-DocBook)? Would you prefer that I clone the repo to my area in github, and let everyone know when I have a document ready? (That's the way I did most of my work for the statistical category enhancements.) I see that the SITKA document is a bit more current: http://docs.sitka.bclibraries.ca/Sitka/current/html/lsa-statcat.html Do you have a contact name/email for someone at SITKA I could reach? thanks, -- Scott On Mon, Mar 26, 2012 at 9:03 AM, Soulliere, Robert <[email protected]> wrote: > Hi Scott, > > Creating a branch and having us merge your changes as you have described is > definitely a good way to go. > > One note on our documentation. As of version 2.2 we have changed to asciidoc > (http://www.methods.co.nz/asciidoc/manpage.html) as the official > documentation format base. If you are writing docs specific to version 2.2 or > later, you might want to write your documentation in ascidoc format. > You will notice that the master branch of our documentation is all in ascidoc > when you clone our repo, so you might want to write the documentation in > asciidoc if possible. We will accept docBook format if that is your > preference and that is still the official format of for documentation > contributions for 2.1 and earlier as you have seen in the branches. > > I am not sure about whom to collaborate with for updating content. SITKA was > the original source for the documentation for that chapter and they have > since updated their documentation, so they might be a good starting point. > Perhaps, those more familiar with the content of this chapter can provide > more guidance? > > > Thanks, > Robert > > > > > > > > > > > > Robert Soulliere, BA (Hons), MLIS > Systems Librarian > Mohawk College Library > [email protected] > Telephone: 905 575 1212 x3936 > Fax: 905 575 2011 > ________________________________________ > From: [email protected] > [[email protected]] On Behalf Of Scott > Prater [[email protected]] > Sent: March 25, 2012 3:46 PM > To: [email protected] > Subject: [OPEN-ILS-DOCUMENTATION] proposal: update "Statistical Categories > Editor" document > > I've made some changes to the Statistical Categories Editor interface, > documented here: > > http://evergreen-ils.org/dokuwiki/doku.php?id=dev:proposal:patron_statistical_categories > > and I'd like to contribute documentation for the new features. > > It looks like the latest public version of the document is here: > > http://docs.evergreen-ils.org/2.0/draft/html/lsa-statcat.html > > and it appears to be out-of-date, as there are more fields now, and > the layout has changed somewhat. > > What would be the best approach for submitting an updated document? I > see that there's a git documentation repository, with > Docbook-formatted documentation in it. Should I clone that > repository, create a branch, update the document in the branch, and > open a Launchpad bug when the updated document is available? > > Also, the work I did is for patron statistical categories; there have > been other changes made to the statistical categories editor besides > mine since this draft version of the documentation. With whom should > I collaborate to get an updated version of this document together? > > thanks, > > -- Scott > _______________________________________________ > OPEN-ILS-DOCUMENTATION mailing list > [email protected] > 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 > [email protected] > http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation _______________________________________________ OPEN-ILS-DOCUMENTATION mailing list [email protected] http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
