Table of Contents
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, reviewing, converting to AsciiDoc, and other tasks. Whatever your background or experience we are keen to have your help!
- Join the Evergreen documentation discussion list. This is the primary way we communicate with each other. Please send an email introducing yourself to the list.
- Write documentation in any format and send it to the documentation discussion list. We will review your files, convert them to AsciiDoc format and add them to the official documentation when they are ready.
- If you are comfortable with AsciiDoc, you can contribute documentation directly.
We are now looking for people to help produce the documentation. If you interested in participating, email the DIG facilitators at email@example.com 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!
- Cheat Sheet – Quick reference for AsciiDoc formatting. (powerman.name)
- User Guide – Detailed guide for AsciiDoc syntax. (methods.co.nz)
General Review – Comparing the documents with the functions they describe (i.e. testing the step-by-step instructions with the matching version of Evergreen)
Editorial Review – Ensuring the documentation is clear and follows Evergreen DIG style guide conventions
CSS Design – Making the pages more attractive and user-friendly
AsciiDoc conversion – For existing files that are not already in AsciiDoc, and new ones created by people writing in other formats