[OPEN-ILS-DOCUMENTATION] A simple sys-admin doc addition.

[Soulliere, Robert]

Hi Steve,

The current version of Evergreen being converted to DocBook is 1.6. At this time it is 1.6.0.x since features in 1.6.1 have not been added yet (booking module and auto password reset from OPAC).

I did have a question as to whether we wanted to separate 1.6.0 and 1.6.1 into 2 versions of the documentation or keep them in the same manual  version with notes regarding features specific to 1.6.1? I am not quite sure about the implications of doing it either way in regards to merging changes to these documents across branches in the repository.

In regards to reorganizing the wiki pages, here is my understanding or assumptions:

1) One of the goals of the DocBook documentation project was to make our documentation nicely organized based on version (like the PostgreSQL documentation).

2) Docbook makes this easier to do this by being able to maintain several distinct documentation manuals and being able to publish the same content  in multiple formats (HTML, PDF, etc).

3) The DocBook documentation will eventually replace most wiki based documentation. (at least for documentation which exists in the documentation) Wiki should be used for fresh content not yet converted to DocBook and  old content not found in documentation (e.g documentation for 1.4)
(may be some question about supported versions and unsupported versions).

 In short, I would prefer to invest more time in getting the DocBook documentation completed and improved and not invest time in reorganizing the wiki content. When the DocBook documentation is up to speed, I am hoping that more people will use it as apposed to the wiki.

We do need ways to keep the DocBook documentation up to the rapid pace of software development. That may be the biggest challenge.


Robert


________________________________________
From: open-ils-documentation-bounces at list.georgialibraries.org [open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of Steve Wills [steve.wills at lyrasis.org]
Sent: September 15, 2010 12:20 PM
To: Documentation discussion for Evergreen software
Subject: Re: [OPEN-ILS-DOCUMENTATION] A simple sys-admin doc addition.

Thank you Robert.

The page I added includes (Evergreen 1.6) in the title as an attempt to help organize what the information applies to.  Do we have a convention for how to make it clear that documentation is for a specific version of Evergreen?   One of the things I really like about PostgreSQL docs is the way they organize a set of documentation for the various releases.  Would it be helpful to setup the wiki with pages like:

http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-admin:version-1.4:cron_services
http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-admin:version-1.6:cron_services
http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-admin:version-2.0:cron_services

With the pages that apply to each put on their proper page?  By the way, what version is the docbook representing?  1.6?

Stev3

________________________________________
From: open-ils-documentation-bounces at list.georgialibraries.org [open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of Soulliere, Robert [robert.soulliere at mohawkcollege.ca]
Sent: Friday, September 10, 2010 3:30 PM
To: Documentation discussion for Evergreen software
Subject: Re: [OPEN-ILS-DOCUMENTATION] A simple sys-admin doc addition.

One note of caution. Some of the links on the the Evergreen Administration Documentation page seem to lead to older information.

For example: the link: Organization and Policy Editing
leads to this: http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-admin:policies

which discusses the CGI method of setting up org units and has links to other older documents. I thought that in 1.6 the CGI method is the non-preferred method of setting this up and that this will be discontinued in 2.0?
There is information on some of these pages which could be misleading for new Evergreen users installing Evergreen 1.6+.
For example, this statement in from the org units policy page at http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-admin:policies:ou: "The current stable (1.2.x) bootstrap interfaces provide no facility for removing organizational units. To remove an organizational unit, you must use SQL to delete the organizational unit directly from the database...."
In 1.6, I believe one can delete org units from the staff client.


Robert


From: open-ils-documentation-bounces at list.georgialibraries.org [open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of Steve Wills [steve.wills at lyrasis.org]
Sent: September 10, 2010 2:33 PM
To: Documentation discussion for Evergreen software
Subject: [OPEN-ILS-DOCUMENTATION] A simple sys-admin doc addition.

All,

I have added a link to the Evergreen Administration Documentation page at:

http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-admin

The example crontab used to run backend scheduled processes is posted off this link at:

http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-admin:cron_services

I hope that helps,
Stev3

P.S. Sorry I don't have bandwidth to do the whole docbook thing on it right now.
_______________________________________________
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
_______________________________________________
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.