[OPEN-ILS-DOCUMENTATION] docs.evergreen-ils.org (yay!) and bug reporting / feedback process

Soulliere, Robert robert.soulliere at mohawkcollege.ca
Wed Oct 20 15:29:10 EDT 2010


Hi,

I added a links to launchpad with the text:
"Report errors in this documentation using Launchpad." with the word Launchpad being linked. This is in the page footer of both the HTML and PDF versions of the documentation.

Let me know if you have a preference for different text.

We will add a link to this as well in the "More Information" appendix as well once it is written.

Thanks,
Robert




Robert Soulliere, BA (Hons), MLIS
Systems Librarian
Mohawk College Library
robert.soulliere at mohawkcollege.ca
Telephone: 905 575 1212 x3936
Fax: 905 575 2011
________________________________________
From: Soulliere, Robert
Sent: October 20, 2010 8:43 AM
To: Documentation discussion for Evergreen software; open-ils-dev at list.georgialibraries.org
Subject: RE: [OPEN-ILS-DOCUMENTATION] docs.evergreen-ils.org (yay!) and bug     reporting / feedback process

Thanks Dan,

Great idea about using launchpad and adding links in the documentation. Several DIG folks are registered in the Evergreen launchpad instance so I think it is not a big leap to use the same instance. I wasn't sure if there are any concerns among the developers about bug report overload once reports about all my spelling errors and typos in the documentation start rolling in. On the other hand, I was surprised about the silence in feedback so far regarding documentation so hopefully this will generate more feedback from users and other DIGers.

I will add the links to the bug reporting mechanism to the footer of the documentation pages and a note on the landing page as well.

Regards,
Robert

Robert Soulliere, BA (Hons), MLIS
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 Dan Scott [dan at coffeecode.net]
Sent: October 19, 2010 11:21 PM
To: open-ils-documentation at list.georgialibraries.org
Subject: [OPEN-ILS-DOCUMENTATION] docs.evergreen-ils.org (yay!) and bug reporting / feedback process

Thanks tons to the DIG for getting that nice landing page up at
docs.evergreen-ils.org! I've updated
http://evergreen-ils.org/documentation.php to get the DIG-produced docs
listed as the official documentation of the Evergreen project -
suggestions to tweaking that page further would be welcome, I just
wanted to start getting people to the draft manual for 1.6. It's coming
along quite nicely!

Of course, with greater visibility possibly comes a little more
complexity in processes. I'm not sure if the DIG has set up a process
for handling documentation bug reports / feedback as of yet, but it
might be a good time to hammer that out and add a link to that process
from the footer of each page of the HTML documentation. It might be nice
to use the same http://bugs.launchpad.net/evergreen instance that we use
for the code so that we can easily collaborate between code developers
and doc writers if necessary. If the bug reporting process is a part of
the documentation itself, then I suppose even the PDF version could
include it (in an appendix or a preface possibly?)

Dan
_______________________________________________
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.


More information about the OPEN-ILS-DOCUMENTATION mailing list