[OPEN-ILS-DOCUMENTATION] "Address Alert" feature not documented

Thu Aug 28 17:39:01 EDT 2014

Thanks Yamil, this makes sense.  I'll work on a docs/admin/address_alert.txt asciiDoc format file.  I think we should reorder things so they are in menu order if there is no stigma attached to doing that.

I would also suggest that the "Action Triggers" section be renamed to "Notifications / Action Triggers" so it matches up with the menu exactly, or the menu should be renamed to remove the "Notifications".

Should I send my docs to you, or I could create a branch on github and submit them that way.

Josh

-----Original Message-----
From: open-ils-documentation-bounces at list.georgialibraries.org [mailto:open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of Yamil Suarez
Sent: Thursday, August 28, 2014 12:51 PM
To: Documentation discussion for Evergreen software
Subject: Re: [OPEN-ILS-DOCUMENTATION] "Address Alert" feature not documented

Josh,

Thanks for your offer to help. Your questions are great, so I will explain a few things for you and those following along to share how DIG works. The way that DIG (or developers) specify where a piece of documentation appears is dictated by the content of a file called "root.txt" inside the "docs" directory in the EG codebase. AsciiDoc then handle the numbering based ont he order used in root.txt.

Here is how that file looks like on the "master Git branch (where the EG code is stored).
http://git.evergreen-ils.org/?p=Evergreen.git;a=blob;f=docs/root.txt;h=efcfecf26e00925d92c75409d366cf131dc1a641;hb=HEAD

(Note, the numbers on the left are line numbers that are not actually stored in root.txt. and the file is using AsciiDoc syntax.)

<snip>
 230 Local Administration
 231 ====================
 232
 233 Introduction
 234 ------------
 235
 236 This part covers the options in the Local Administration menu found in the staff
 237 client.
 238
 239 // Follow structure from staff client local admin menu.
 240
 241 // Push titles down one level.
 242 :leveloffset: 1
 243
 244 include::admin/hold_driven_recalls.txt[]
 245
<snip>

Josh, I see that in the comments placed on line 239 it says that someone wanted to follow the menu order. As far as I can tell, that section is not in that order, but going forward we can decide to follow the order or pick a different order based on concepts/features.

I can help you prepare the PINES documentation so that it can be added to the "Local Administration" section. BTW, we might want to consider changing the question and answer format used by PINES because I am not sure if that is done in other parts of the official documentations.
Though I could be wrong about that.

Eventually we would create a text file called something like "message_alerts.txt," using AsciiDoc syntax. Then we would reference the new file in root.txt around line 243. We would used the following syntax...

include::admin/address_alerts.txt[]

Josh, let me know if I am making sense to you.

Thanks,
Yamil

On Thu, Aug 28, 2014 at 12:53 PM, Josh Stompro <stomproj at exchange.larl.org> wrote:
> Terran, this is great, you did all the work already.  I would be happy to work on submitting your documentation to the official documentation.
>
> It looks like it should go under Part VII. Local Administration 
> http://docs.evergreen-ils.org/2.6/_local_administration.html
>
> I'll check out the DIG documentation to see if how to number subsections Is handled.  It looks like some things are in alpha order, but other things are not.  My first instinct would be to place it first in the list(56), since it shows up first in the menu of local admin items.  But that would renumber the other sections, and maybe that is frowned upon.
>
> Josh
>
> -----Original Message-----
> From: open-ils-documentation-bounces at list.georgialibraries.org 
> [mailto:open-ils-documentation-bounces at list.georgialibraries.org] On 
> Behalf Of McCanna, Terran
> Sent: Thursday, August 28, 2014 11:11 AM
> To: Documentation discussion for Evergreen software
> Subject: Re: [OPEN-ILS-DOCUMENTATION] "Address Alert" feature not 
> documented
>
> Josh and documentation group -
>
> You are welcome to use any of the instructions I wrote up for our staff if they are at all helpful:
>
> http://pines.georgialibraries.org/address-alerts
>
> (I haven't had time to help contribute to the evergreen documentation, 
> sorry!)
>
>
> Terran McCanna
> PINES Program Manager
> Georgia Public Library Service
> 1800 Century Place, Suite 150
> Atlanta, GA 30345
> 404-235-7138
> tmccanna at georgialibraries.org
>
> ----- Original Message -----
> From: "Josh Stompro" <stomproj at exchange.larl.org>
> To: open-ils-documentation at list.georgialibraries.org
> Sent: Thursday, August 28, 2014 11:47:42 AM
> Subject: [OPEN-ILS-DOCUMENTATION] "Address Alert" feature not 
> documented
>
>
>
>
>
> Hello, I’ve just been playing around with an evergreen test system and came across the Admin->local admin-> address alert config page. I was curious about how exactly this works, so I went to look for documentation. But I couldn’t find anything about it in the official documentation. Or on any of the mailing lists, or the wiki, or the open-ils site using the google site search.
>
>
>
> I started to file a Launchpad bug about it and came across the original feature request https://bugs.launchpad.net/evergreen/+bug/898248 It looks like it was included in the 2.0 release, and has been around since 2012. It seem like a shame that a nice feature like this doesn’t have more visibility.
>
>
>
> Is this something that should be in the official documentation? Which section should it go in? I would be happy to try and document the feature. Should I start a bug report to just have a place to document the progress?
>
>
>
> I’ve seen the list of new features that need to be documented, is there a list of old features that need to be documented also?
>
>
>
> Thanks
>
> Josh
>
>
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentati
> on _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentati
> on _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentati
> on

-- 

--------------------------------

Yamil Suarez, MCS
Library System Administrator/Developer

Stan Getz Library
Berklee College of Music
1140 Boylston St
Boston, MA 02215

ysuarez at berklee.edu
617-747-2617
_______________________________________________
OPEN-ILS-DOCUMENTATION mailing list
OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation