User Tools

Site Tools


evergreen-docs:dig_participation

How to Participate in the Evergreen Documentation Interest Group

Contributing to documentation is an excellent way to support Evergreen, even if you are new to documentation. In fact, beginners often have a distinct advantage over the experts, more easily spotting the places where documentation is lacking or where it is unclear.

We welcome your contribution with planning, writing, editing, testing, converting to AsciiDoc, and other tasks. Whatever your background or experience we are keen to have your help!

First Steps

  • Join the Evergreen documentation listserv: http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation. This is the primary way we communicate with each other. Please send an email introducing yourself to the list.
  • Add yourself to the participant list if you have an Evergreen DokuWiki account, or send a request to docs@evergreen-ils.org.
  • Check out the documentation to-do list to see which areas need work, and mention on the listserv which areas you're interested in working on. For large chunks of documentation you may want to see if there are other people who would like to team up with you.
  • Attend a DIG meeting in IRC. Meetings are announced on the listserv.
  • Write documentation in any format. Content coordinators and the AsciiDoc coordinator can convert your files to AsciiDoc and add them to the official documentation. This process ensures that the community is aware of your documentation and that it is integrated into the documentation repository.
  • Once you are comfortable with AsciiDoc formatting, you can contribute documentation directly.

Volunteer roles

We are now looking for people to help produce the documentation. If you interested in participating, email the DIG facilitators at docs@evergreen-ils.org or speak up on the documentation mailing list.

We're looking for volunteers to work on the following:

Writing – Producing the documentation ("from scratch," and/or revised from existing materials). We're open to receiving content in any formats, such as Word or Open Office, but of course, we'd be delighted if you produced it in AsciiDoc!

Testing – Comparing the documents with the functions they describe

AsciiDoc conversion – For existing files that are not already in AsciiDoc, and new ones created by people writing in other formats

Editorial review – Ensuring the documentation is clear and follows Evergreen DIG style guide conventions

CSS Design – Making the pages more attractive and user-friendly

evergreen-docs/dig_participation.txt · Last modified: 2017/10/25 08:44 by rjs7

© 2008-2017 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a member of Software Freedom Conservancy.