| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| evergreen-docs:dig_participation [2018/02/06 10:02] – [Volunteer roles] rjs7 | evergreen-docs:dig_participation [2025/04/09 12:33] (current) – Fixing mailing list link bmagic |
|---|
| 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. | 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! | 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! |
| |
| ==== First Steps ==== | ==== 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. | * Join the Evergreen **[[https://list.evergreen-ils.org/mailman3/lists/evergreen-documentation.list.evergreen-ils.org/|documentation discussion list]]**. This is the primary way we communicate with each other. Please send an email introducing yourself to the list. |
| | * Check out the **[[evergreen-docs:documentation_needs|documentation to-do list]]** (especially the EASY section). If you want help with a task, just ask on the [[http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation|documentation discussion list]]. |
| | * Attend a **[[evergreen-docs:dig_meetings|DIG meeting]]** in IRC. Meetings are on the [[calendar:start|community calendar]] and announced on the listserv. |
| | * Write documentation in **any format** and send it to the [[evergreen-documentation@list.evergreen-ils.org|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 [[evergreen-docs:how-to-contribute-documentation|contribute documentation directly]]. |
| * Add yourself to the [[evergreen-docs:DIGParticipants|participant list]] if you have an Evergreen DokuWiki account, or send a request to [[docs@evergreen-ils.org]]. | * Add yourself to the [[evergreen-docs:DIGParticipants|participant list]] if you have an Evergreen DokuWiki account, or send a request to [[docs@evergreen-ils.org]]. |
| * Check out the newest [[evergreen-docs:3.0_needs|documentation to-do list]] to see which areas need work, and mention on the [[http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation|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 [[evergreen-docs:dig_meetings|meeting]] in IRC. Meetings are announced on the [[http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation|listserv]]. | |
| * Write documentation in any format and send it to the [[open-ils-documentation@list.georgialibraries.org|documentation email 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 formatting, you can [[evergreen-docs:how-to-contribute-documentation|contribute documentation directly]]. | |
| |
| ==== Volunteer roles ==== | ==== Volunteer roles ==== |
| **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! | **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! |
| * [[https://powerman.name/doc/asciidoc|Cheat Sheet]] -- Quick reference for AsciiDoc formatting. (powerman.name) | * [[https://powerman.name/doc/asciidoc|Cheat Sheet]] -- Quick reference for AsciiDoc formatting. (powerman.name) |
| * [[https://docs.google.com/presentation/pub?id=1o8HruJayUSEvXQlU_IjU6xN3cJbuw3yagENlcUM7sUU&start=false&loop=false&delayms=3000|DIG AsciiDoc tutorial]] | |
| * [[https://docs.google.com/document/pub?id=17KpO9tMYBObec3coijFAxFDjDCrOIfoVDMa3Q1k8_lE|DIG AsciiDoc cheat sheet]] | * [[https://docs.google.com/document/pub?id=17KpO9tMYBObec3coijFAxFDjDCrOIfoVDMa3Q1k8_lE|DIG AsciiDoc cheat sheet]] |
| | * [[https://docs.google.com/presentation/pub?id=1o8HruJayUSEvXQlU_IjU6xN3cJbuw3yagENlcUM7sUU&start=false&loop=false&delayms=3000|DIG AsciiDoc tutorial]] |
| * [[http://www.methods.co.nz/asciidoc/userguide.html|User Guide]] -- Detailed guide for AsciiDoc syntax. (methods.co.nz) | * [[http://www.methods.co.nz/asciidoc/userguide.html|User Guide]] -- Detailed guide for AsciiDoc syntax. (methods.co.nz) |
| |
| **Testing** -- Comparing the documents with the functions they describe | **General Review** -- Comparing the documents with the functions they describe (i.e. testing the step-by-step instructions with the matching version of Evergreen) |
| |
| **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 |
| | |
| **Editorial review** -- Ensuring the documentation is clear and follows Evergreen DIG style guide conventions | |
| |
| **CSS Design** -- Making the pages more attractive and user-friendly | **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 |
| | *[[https://alldocs.app/convert-word-docx-to-asciidoc|Word to AsciiDoc]] |
| | |
| <html><!-- | <html><!-- |
| **XML Transform and Committers** -- Converting the files to HTML and PDF, making permanent changes, and uploading the files | **XML Transform and Committers** -- Converting the files to HTML and PDF, making permanent changes, and uploading the files |
