[OPEN-ILS-DOCUMENTATION] Help on Documentation

[Dananji Liyanage]

Thank you for the quick reply.

I fixed the bitesize doc bug (Link:
https://bugs.launchpad.net/evergreen/+bug/1371598) and proposed the file
change ( docs/admin/MARC_RAD_MVF_CRA.txt).

It would be great if you can provide feedback.

On Wed, Oct 15, 2014 at 9:38 PM, Remington Steed <rjs7 at calvin.edu> wrote:

>  Hi Dananji,
>
>
>
> I would suggest first trying to use AsciiDoc format for the table data.  I
> don’t think it will be very hard to maintain.  Here is an example of how
> the syntax could look (click “Raw” to see the code):
>
>
>
> https://gist.github.com/remocrevo/98156bcca7c15353e128
>
>
>
> Remington
>
>
>
> --
>
> Remington Steed
>
> Electronic Resources Specialist
>
> Hekman Library, Calvin College
>
> http://library.calvin.edu/
>
>
>
> *From:* open-ils-documentation-bounces at list.georgialibraries.org [mailto:
> open-ils-documentation-bounces at list.georgialibraries.org] *On Behalf Of *Dananji
> Liyanage
> *Sent:* Wednesday, October 15, 2014 10:04 AM
> *To:* Documentation discussion for Evergreen software
> *Subject:* Re: [OPEN-ILS-DOCUMENTATION] Help on Documentation
>
>
>
> Hi Kathy,
>
> Thank you for the detailed reply.
>
> I did start on working on the bitesize doc bug (Link:
> https://bugs.launchpad.net/evergreen/+bug/1371598), following your
> instructions. But I'm a bit stuck at deciding what method I would choose to
> input data to the table.
>
> I could use a .csv file as well as write in them in AsciiDoc itself,
> whereas the .csv file would be more feasible in making further changes.
>
> Since I didn't come across any .csv files in the docs, I was wondering
> whether I could use that.
>
> It would be great if you could give your opinion on this.
>
>
>
> On Tue, Oct 14, 2014 at 9:48 PM, Kathy Lussier <klussier at masslnc.org>
> wrote:
>
>  Hi Dananji,
>
> Thank you for reaching out and for working on one of our bitesize doc
> bugs. You might want to take a look at
> http://wiki.evergreen-ils.org/doku.php?id=evergreen-docs:how-to-contribute-documentation
> for some guidelines on contributing documentation. In particular, you might
> want to start with the intermediate-level instructions.
>
> When looking in the docs directory on GitHub (
> https://github.com/evergreen-library-system/Evergreen/tree/master/docs),
> the directory structure closely follows the chapters of our Evergreen
> documentation - http://docs.evergreen-ils.org/2.7/. If you can see which
> chapter your documentation lives in, then you should be able to find the
> file in the corresponding directory in the GitHub repository.
>
> For this project, it generally is a good idea to become familiar with that
> directory structure and to see how the files in the repository relate to
> the HTML output you see on the Evergreen documentation site. If you still
> have trouble finding the correct file, feel free to send a follow-up e-mail
> or to drop into the #evergreen IRC channel. We usually have a lot of
> helpful people there between 9 a.m. and 4 p.m. Eastern Monday through
> Friday. It tends to be very quiet in the IRC channel during other
> days/times, so e-mail may be the best option if you're working during our
> off-hours.
>
> Kathy
>
>  Kathy Lussier
>
> Project Coordinator
>
> Massachusetts Library Network Cooperative
>
> (508) 343-0128
>
> klussier at masslnc.org
>
> Twitter: http://www.twitter.com/kmlussier
>
> #evergreen IRC: kmlussier
>
>  On 10/12/2014 11:54 PM, Dananji Liyanage wrote:
>
>
>   ​ Hi all,
>
> I'm hoping to contribute ​
>
> ​ to documentation of the Evergreen project.
>
> I have already decided on a bit-size bug I'm gonna work on. Can you please
> explain me the basic steps to start, like how could I find the relevant
> documents in GitHub?
> ​
>
>
> --
>
> Regards,
> Dananji Liyanage
>
>
>
> _______________________________________________
>
> 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
>
>
>
>
> --
>
> Regards,
> Dananji Liyanage
>
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
>
>


-- 
Regards,
Dananji Liyanage
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://list.georgialibraries.org/pipermail/open-ils-documentation/attachments/20141016/261f5cab/attachment-0001.htm>