Evergreen DokuWiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Evergreen Documentation Interest Group (DIG) ======

The Evergreen DIG was established in May 2009 at the first Evergreen International Conference, where members of the Evergreen community committed to developing single-source, standards-based documentation for Evergreen. Since then, DIG has been actively working toward that goal.

We welcome new participants and invite anyone interested to attend meetings, volunteer for tasks, and join the discussion email list ([[https://list.evergreen-ils.org/mailman3/lists/evergreen-documentation.list.evergreen-ils.org/]]). There's a role for everyone! 

==== About DIG ====

  * [[evergreen-docs:dig_participation|How to participate]]
  * [[evergreen-docs:dig_meetings|Meetings]] - agendas and minutes.
  * [[evergreen-docs:DIGParticipants|Roles and participants]] 
  * [[evergreen-docs:dig_terms_of_reference|Terms of reference]] (mission, scope, principles)
  * [[evergreen-docs:how-to-contribute-documentation|Contributing documentation]]
  * [[docs@evergreen-ils.org|Email the DIG facilitators]] 

==== Official Documentation ====
  * [[http://docs.evergreen-ils.org/|Official Documentation]]
  * [[http://git.evergreen-ils.org/?p=Evergreen.git;a=tree;f=docs;hb=HEAD|AsciiDoc Source Files]]

==== Projects and To-do Lists ====
  * [[evergreen-docs:documentation_needs|TO-DO: All Documentation Needs]] (includes undocumented "new" features from all previous release notes)
  * [[evergreen-docs:reorg:clean_up|Docs Reorganization Cleanup Tasks]]
  * [[evergreen-docs:Glossary|Glossary of terms to define]]
  * [[evergreen-docs:webclient|Web Staff Client Documentation Project]]
  * [[https://docs.google.com/spreadsheets/d/1nPD0_blC51wVcYJsdQqGYFoRrlcGmbmqbZlrlosaHgE/edit#gid=0|Documentation Reorganization Spreadsheet]]
  * [[https://docs.google.com/spreadsheets/d/1gJkFRNIH4tMzr-P2JoOb704uSlUwrcFvdkL5KlnLyrg/edit#gid=1107472678|Library Settings Definitions List]]
  * [[https://bugs.launchpad.net/evergreen/+bug/2022100 | LP 2022100: Writing a page on item statuses]]
  * [[https://docs.google.com/spreadsheets/d/1IjfX9pEIkL3nzlomznNYCS-_fKZftBnFDXzBbwCX8fw/edit?usp=sharing|OU terminology updates using Vale]]

  * ANTORA Project
    * [[https://bugs.launchpad.net/evergreen/+bug/1848524|Launchpad Bug Report]] (for tracking progress)
    * [[https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/collab/blake/LP1848524_antora_ize_docs|Git collab branch]]

==== Evergreen Documentation Guidelines ====

== Liscensing Terms ==

  * [[evergreen-docs:documentation_licensing_terms|Documentation Licensing Terms]]

== DIG Style Guide ==

  * [[evergreen-docs:dig_style_guide|DIG Style Guide]]

== AsciiDoc ==

The preferred format for documentation submissions is AsciiDoc, a plain-text format.

  * AsciiDoc Editing Tools
    * [[https://asciidoclive.com/|Edit and preview in a web browser]]
    * [[http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/|List of editors, browser plugins, and other things]]
    * [[http://powerman.name/doc/asciidoc|Cheat Sheet]] -- Quick reference for AsciiDoc formatting. (powerman.name) 
    * [[http://www.methods.co.nz/asciidoc/userguide.html|User Guide]] -- Detailed guide for ASciiDoc syntax. (methods.co.nz)

  * DIG AsciiDoc Tutorial (by former DIG facilitator Yamil Suarez)
     * [[https://docs.google.com/presentation/pub?id=1o8HruJayUSEvXQlU_IjU6xN3cJbuw3yagENlcUM7sUU&start=false&loop=false&delayms=3000|DIG AsciiDoc tutorial Slides]]
     * [[https://www.youtube.com/watch?v=7uX1NtlJRfU|DIG AsciiDoc training Video]] (1 hour long)

  * Additional DIG AsciiDoc Tutorials and documentation
     * [[https://www.youtube.com/watch?v=0KcfFiqCtP4|2021 Conference presentation]]
     * [[https://docs.evergreen-ils.org/eg/docs/latest/shared/how_to_contribute_docs.html|Integrated "How to contribute documentation"]]

   * Convert Word files to AsciiDoc
     * https://alldocs.app/convert-word-docx-to-asciidoc


==== DIG Test Server ====

 
  * [[:community_servers|community demo servers]]: These are community Evergreen servers available for testing procedures and learning.


==== Community-Created Evergreen Documentation ====

  * [[https://www.biblio.org/documentation/|Bibliomation documentation]]
  * [[https://evergreenindiana.org/?post_type=docs|Evergreen Indiana manuals]]
  * [[https://nccardinalsupport.org/index.php|NC Cardinal support and staff education]]
  * [[https://sparkpa.atlassian.net/servicedesk/customer/portals|PaILS/SPARK support portal]]
  * [[https://pines.georgialibraries.org/docs/doku.php?id=home|PINES documentation]]
  * [[http://asciidoc.libraries.coop/|Sitka asciidoc index]]
  * [[http://docs.libraries.coop/|Sitka manuals]]


==== Other Evergreen Documentation ====

  * [[evergreen-docs:existing_docs_survey|Existing Documentation in the Wild]]

==== Other Tools for Contributors ====
  * See [[evergreen-docs:digresources|Documentation Resources]]