[OPEN-ILS-DOCUMENTATION] ***SPAM*** RE: Pull request - Address Alert feature + plus a few other

[Josh Stompro]

Thanks Yamil,

Thanks for fixing the image.  Can you tell me how to build the complete documentation tree?  Are the commands included in the repository somewhere,  ‘make docs’?  That would help me do a better job with testing.  Gist is great but I cannot test images and intra documenation links.

If the development section doesn’t belong in the official docs I’ll leave that off of the other documentation I’m working on also.  I was hoping to just save someone else time in tracking down the files… but the more I use git and the other tools, the less time it is taking me to find the development notes about features, so maybe it won’t save anyone else time if they are already familiar with things.

Josh


From: open-ils-documentation-bounces at list.georgialibraries.org [mailto:open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of Yamil Suarez
Sent: Tuesday, September 09, 2014 3:10 PM
To: Documentation discussion for Evergreen software
Subject: Re: [OPEN-ILS-DOCUMENTATION] Pull request - Address Alert feature + plus a few other

Josh,

Today I was just able to process your documentation changes stored on Github, and push them to the main Git repository that stores the EG code and documentation. I split off you changes into three separate commits and updated the commit messages, including making sure you got credit for the changes within Git.

Here are the 3 commit diff's

http://git.evergreen-ils.org/?p=Evergreen.git;a=commitdiff;h=d86f4706131fa8b6a313535b7d1939ad155f71f7

http://git.evergreen-ils.org/?p=Evergreen.git;a=commitdiff;h=bfc7eed20626889e8aadce024f93931a712cb722

http://git.evergreen-ils.org/?p=Evergreen.git;a=commitdiff;h=7c1aea0e7d88162b504f0371b2b4e51d00a63028


BTW, I had a couple of comments.

- I noticed that an image that you added to docs/admin/lsa-address_alert.txt did not show up because apparently AsciiDoc needs an empty line between an image and a sentence that may appear before it.

So I change it from...


     Here is an example of what staff would see.
     image::media/lsa-address_alert_staff_view.png[Address Alert Staff View]

To this...

     Here is an example of what staff would see.
     image::media/lsa-address_alert_staff_view.png[Address Alert Staff View]



Also, you added a link the launchpad bug URL for the feature you documented (Address Alerts)...

     Links to resources with more information on how and why this feature was developed and where the various source files are located.
     - Launchpad ticket for the feature request and development of address alerts - https://bugs.launchpad.net/evergreen/+bug/898248

I did not think that was a common practice in the official docs, so I did a search for mentions of Launchpad in the docs. There were only a couple, mostly dealing with translating EG into different languages, though one mention of 'launchpad' was to refer to a bug where it was agreed to shut off OPAC "auto suggest" by default. Not sure what others think about linking back to the original Launchpad bug, but I did not want to divide for the group (DIG).


Thanks again for the contributions,
Yamil








On Sat, Sep 6, 2014 at 4:02 PM, Josh Stompro <stomproj at exchange.larl.org<mailto:stomproj at exchange.larl.org>> wrote:
Thanks Yamil, I accidentally added a few more commits to that pull request… I’m still learning about git, and using branches to separate things.  Please ignore those for now, I want to submit those separately.  The ones that have to do with the offline.properties and adding the tab name for the address alerts feature.

Josh



-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://list.georgialibraries.org/pipermail/open-ils-documentation/attachments/20140910/cd717b86/attachment.htm>