[OPEN-ILS-DOCUMENTATION] Where to put reviewers notes .. Re: Evergreen DIG Test Server Available

[Roma Matott]

Hi -

I haven't added any notes yet.  To be honest, the process of making notes of the upgrade process generated a lot of questions about how the technical side should be documented.  
The upgrade was a two step process for me - I had to upgrade OpenSRF and Evergreen.  The instructions for upgrading OpenSRF seemed to be more if you were installing the software from scratch than an upgrade. So, below is what was running through my mind:

Question 1:  How do we determine what to document?  Do I document a separate page for if you are upgrading OpenSRF?  Or do I amend the current documentation so that it is clear that some steps only relate to a new install?  

Question 2:  I am using Ubuntu 8.10, so my commands were (very) slightly different.  Do I just state that these instructions are for Ubuntu operating system and hope that if someone is using Debian they know the difference?  Or do I add the different commands in the same step indicating which operation system they are for?  I guess, the underlying question here is should we only be documenting in the preferred/most widely used os or should we try to accommodate both?

While the current documentation is good, I do think it requires that the user has a solid foundation in Linux commands.  I might be over thinking this, but I would like to create documentation that is easy enough for a person with average technical skills to follow.  I have the feeling that this is important for the growth of the Evergreen community.  So, if anyone has any thoughts on this, please share!

Roma
Systems Librarian
Pioneer Library System
Canandiagua, NY



----- Original Message -----
From: "Repke de Vries" <repke at xs4all.nl>
To: "Documentation discussion for Evergreen software" <open-ils-documentation at list.georgialibraries.org>
Sent: Thursday, September 24, 2009 10:25:29 AM GMT -05:00 US/Canada Eastern
Subject: [OPEN-ILS-DOCUMENTATION] Where to put reviewers notes .. Re: Evergreen DIG Test Server Available

Dear Roma, hi all

Roma: great. It will only be late October before IISH will do the  
same -  are doing warming up presently with 1.4.0.4 and a minor  
upgrade to 1.4.0.6 next week.

Did you put up your notes yet on the DIG wiki pages ? At least: can't  
find it.

Question to the list:  is it an idea to have a wiki area where  
reviewers / writers can put anything rough in any format ... or  is  
it better to go straight into the habit of producing any contributing  
material in the DocBook format ?

Apologies if we *have* discussed this at length - I am just trying to  
be practical, will also have notes soon (trying migration right now  
on the 1.6 Test Server), need to share with fellow DIG-gers and want  
to know if I should learn the DocBook route first.

Greetings, Repke, IISH

Op 21-sep-2009, om 15:03 heeft Roma Matott het volgende geschreven:

> I have run through the upgrade process of 1.4 to 1.6 and made notes  
> to add to the existing documentation.  But that is about as far as  
> I have gotten :(
>
> Roma
> PLS
> ----- Original Message -----
> From: "Karen Schneider" <kgs at esilibrary.com>
> To: "Public Open-ILS documentation discussion" <open-ils- 
> documentation at list.georgialibraries.org>
> Sent: Friday, September 18, 2009 4:44:14 PM GMT -05:00 US/Canada  
> Eastern
> Subject: [OPEN-ILS-DOCUMENTATION] Evergreen DIG Test Server Available
>
>
..............
> Anyone get started yet on their chunk of the documentation effort?

_______________________________________________
OPEN-ILS-DOCUMENTATION mailing list
OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation