User Tools

Site Tools


evergreen-docs:dig_participation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
evergreen-docs:dig_participation [2013/09/20 11:33]
rjs7 [How to Participate in the Evergreen Documentation Interest Group]
evergreen-docs:dig_participation [2022/02/10 13:34] (current)
Line 3: Line 3:
 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, testingtranslating 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, reviewingconverting 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 **[[http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation|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 documentation outline for [[evergreen-docs_2.5:outline|version 2.5]] (DIG's current focus) 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 one or more 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.  Content coordinators and the AsciiDoc coordinator can convert your files to AsciiDoc and add them to the official documentation.   [[:Adding 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 [[evergreen-docs:how-to-contribute-documentation|contribute documentation directly]]. 
-  * If you'd like to learn more about AsciiDoc and documentation in general you can check out our [[evergreen-docs:digresources|documentation resources]].  
  
 ==== Volunteer roles ==== ==== Volunteer roles ====
Line 21: Line 20:
 We're looking for volunteers to work on the following: We're looking for volunteers to work on the following:
  
-**Writing** -- Producing the documentation ("from scratch," and/or revised +**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! 
- 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://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]]   * [[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]] +  * [[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) +
-  * [[http://www.methods.co.nz/asciidoc/userguide.html|Cheat Sheet]] -- Quick reference for AsciiDoc formatting. (methods.co.nz) +
- +
-* **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 styleguide conventions+**General Review** -- Comparing the documents with the functions they describe (i.e. testing the step-by-step instructions with the matching version of Evergreen)
  
-* **CSS Design** -- Making the pages more attractive and user-ful+**Editorial Review** -- Ensuring the documentation is clear and follows Evergreen DIG style guide conventions
  
-* **XML Transform and Committers** -- Converting the files to HTML and PDF, making permanent changes, and uploading the files+**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]]
  
-==== Current Needs ==== +<html><!-- 
-Last Updated 9/19/2013+**XML Transform and Committers** -- Converting the files to HTML and PDF, making permanent changes, and uploading the files 
 +--></html>
  
-* We need people to review the draft 2.5 documentation available at http://docs.evergreen-ils.org/ and provide feedback on the discussion list or via the Launchpad bug reporting system.  There are links to Launchpad throughout the documentation for this purpose. 
  
-* We need people to submit any documentation that may be out there on features new to version 2.2 to the documentation discussion list.  Any format is okay. 
  
-* We need people willing to revise older documentation (1.6, 2.0, 2.1, 2.2, 2.3, 2.4) to reflect any changes in 2.5 and write new documentation on features new to version 2.5.  You may want to check the [[evergreen-docs_2.5:outline|2.5 outline]] and mention what you want to work on via the documentation discussion list to ensure you're not working on something someone else has already done, or in case there's the possibly of working with another volunteer on your topic. 
evergreen-docs/dig_participation.1379691238.txt.gz · Last modified: 2022/02/10 13:34 (external edit)

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.