Add content to about this documentation chapter.
[working/Evergreen.git] / 1.6 / appendices / about_this_documentation.xml
1 <?xml version='1.0' encoding='UTF-8'?>\r
2 <appendix xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"\r
3 xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="about_this_documentation">\r
4         <info>\r
5                 <title>About this Documentation</title>\r
6         </info>\r
7         <section xml:id="aboutDIG">\r
8                 <title>About the Documentation Interest Group (DIG)</title>\r
9                 <para>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, \r
10                 standards-based documentation for Evergreen. Since then, the DIG has been actively working toward that goal.</para>\r
11                 <table>\r
12                         <title>Evergreen DIG Participants</title>\r
13                         <tgroup align="left" cols="2" colsep="1" rowsep="1">\r
14                                 <colspec colnum="1" colwidth="1.0*"/>\r
15                                 <colspec colnum="2" colwidth="1.0*"/>\r
16                                 <thead>\r
17                                         <row>\r
18                                                 <entry>Name</entry>\r
19                                                 <entry>Organization</entry>\r
20                                         </row>\r
21                                 </thead>\r
22                                 <tbody> \r
23                                         <row>\r
24                                                 <entry>Jeremy Buhler</entry>\r
25                                                 <entry>SITKA</entry>\r
26                                         </row>                                  \r
27                                         <row>\r
28                                                 <entry>Paula Burton </entry>\r
29                                                 <entry>King County Library System</entry>\r
30                                         </row>\r
31                                         <row>\r
32                                                 <entry>Matt Carlson</entry>\r
33                                                 <entry>King County Library System </entry>\r
34                                         </row>\r
35                                         <row>\r
36                                                 <entry>Sarah Childs</entry>\r
37                                                 <entry>Hussey-Mayfield Memorial Public Library</entry>\r
38                                         </row>\r
39                                         \r
40                                         <row>\r
41                                                 <entry>Anton Chuppin</entry>\r
42                                                 <entry>Nova Scotia Provincial Library</entry>\r
43                                         </row>\r
44                                         <row>\r
45                                                 <entry>Marlene Coleman</entry>\r
46                                                 <entry>Beaufort Country Library</entry>\r
47                                         </row>\r
48                                         <row>\r
49                                                 <entry>Karen Collier</entry>\r
50                                                 <entry>Kent County Public Library </entry>\r
51                                         </row>\r
52                                         <row>\r
53                                                 <entry>Shannon Dineen</entry>\r
54                                                 <entry>SITKA</entry>\r
55                                         </row>\r
56                                         <row>\r
57                                                 <entry>George Duimovich</entry>\r
58                                                 <entry>NRCan Library</entry>\r
59                                         </row>\r
60                                         <row>\r
61                                                 <entry>Jennifer Durham</entry>\r
62                                                 <entry>Statesboro Regional Library System</entry>\r
63                                         </row>\r
64                                         <row>\r
65                                                 <entry>Jennifer Finney</entry>\r
66                                                 <entry>Florence County Library</entry>\r
67                                         </row>  \r
68                                         <row>\r
69                                                 <entry>Lynn Floyd</entry>\r
70                                                 <entry>Anderson County Library</entry>\r
71                                         </row>\r
72                                         <row>\r
73                                                 <entry>Tina Ji</entry>\r
74                                                 <entry>SITKA</entry>\r
75                                         </row>\r
76                                         <row>\r
77                                                 <entry>Catherine Lemmer</entry>\r
78                                                 <entry>Indiana State Library</entry>\r
79                                         </row>\r
80                                         <row>\r
81                                                 <entry>Roma Matott</entry>\r
82                                                 <entry>Pioneer Library System</entry>\r
83                                         </row>\r
84                                         <row>\r
85                                                 <entry>Andrea Neiman</entry>\r
86                                                 <entry>Kent County Public Library</entry>\r
87                                         </row>\r
88                                         <row>\r
89                                                 <entry>Kevin Pischke</entry>\r
90                                                 <entry>William Jessup University </entry>\r
91                                         </row>\r
92                                         <row>\r
93                                                 <entry>Tara Robertson</entry>\r
94                                                 <entry>N/A</entry>\r
95                                         </row>\r
96                                         <row>\r
97                                                 <entry>Rod Schiffman</entry>\r
98                                                 <entry>Alpha-G Consulting</entry>\r
99                                         </row>\r
100                                         <row>\r
101                                                 <entry>Chris Sharp</entry>\r
102                                                 <entry>Georgia Public Library Service</entry>\r
103                                         </row>\r
104                                         <row>\r
105                                                 <entry>Steve Sheppard</entry>\r
106                                                 <entry>Open</entry>\r
107                                         </row>\r
108                                         <row>\r
109                                                 <entry>Ben Shum</entry>\r
110                                                 <entry>Bibliomation</entry>\r
111                                         </row>\r
112                                         <row>\r
113                                                 <entry>Robert Soulliere</entry>\r
114                                                 <entry>Mohawk College</entry>\r
115                                         </row>\r
116                                         <row>\r
117                                                 <entry>Lindsay Stratton</entry>\r
118                                                 <entry>Pioneer Library System</entry>\r
119                                         </row>\r
120                                         <row>\r
121                                                 <entry>Jenny Turner</entry>\r
122                                                 <entry>PALS</entry>\r
123                                         </row>\r
124                                         <row>\r
125                                                 <entry>Repke de Vries</entry>\r
126                                                 <entry>International Institute for Social History</entry>\r
127                                         </row>\r
128                                         <row>\r
129                                                 <entry>D. Ceabron Williams</entry>\r
130                                                 <entry>Flint River Regional Library System </entry>\r
131                                         </row>\r
132                                 \r
133                                 </tbody>\r
134                         </tgroup>\r
135                 </table>\r
136                 <table>\r
137                         <title>Past DIG Participants</title>\r
138                         <tgroup align="left" cols="2" colsep="1" rowsep="1">\r
139                                 <colspec colnum="1" colwidth="1.0*"/>\r
140                                 <colspec colnum="2" colwidth="1.0*"/>\r
141                                 <thead>\r
142                                         <row>\r
143                                                 <entry>Name</entry>\r
144                                                 <entry>Organization</entry>\r
145                                                 \r
146                                         </row>\r
147                                 </thead>\r
148                                 <tbody> \r
149                                         <row>\r
150                                                 <entry>Paul Weiss </entry>\r
151                                                 <entry>Consultant/Sage Library System</entry>\r
152                                         </row>                                  \r
153                                         <row>\r
154                                                 <entry>Karen Schneider</entry>\r
155                                                 <entry>Equinox Software </entry>\r
156                                         </row>\r
157                                 </tbody>\r
158                         </tgroup>\r
159                 </table>        \r
160                 <para>Special thanks goes to:</para>\r
161                 <itemizedlist>\r
162                         <listitem>Jeremy Buhler and SITKA for providing DocBook style sheets, style guides and large portions of content for this documentation.</listitem>\r
163                         <listitem>Dan Scott from Laurentian University for providing large portions of content and many helpful tips.</listitem>\r
164                         <listitem>Mike Rylander, Grace Dunbar, Galen Charleton, Jason Etheridge, Bill Erickson, Joe Atzberger, Scott McKellar and all the other folks at Equinox Software for \r
165                         contributing large portions of content on the wiki.</listitem>\r
166                 </itemizedlist>         \r
167                 <para>There have been many other who have contributed there time to the Book of Evergreen project. Without their contributions to this community driven project, this documentation \r
168                 would not be possible.</para>   \r
169         </section>\r
170         <section xml:id="howtoParticipate">\r
171                 <title>How to Participate</title>\r
172                 <para>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 \r
173                 experts, more easily spotting the places where documentation is lacking or where it is unclear.</para>\r
174                 <para>We welcome your contribution with planning, writing, editing, testing, translating to DocBook, and other tasks. Whatever your background or experience we are keen to \r
175                 have your help!</para>  \r
176                 <para>What you can do:</para>\r
177                 <itemizedlist>\r
178                         <listitem>Join the Evergreen  documentation listserv: <link xl:href="http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation" \r
179                         xl:title="Join the DIG listserv">list.georgialibraries.org/mailman/listinfo/open-ils-documentation</link> . This is the primary way we communicate with each other. \r
180                         Please send an email introducing yourself to the list.</listitem>\r
181                         <listitem>Add yourself to the <link xl:href="http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:digparticipants"> participant list</link> \r
182                         if you have an Evergreen DokuWiki account, or send a request to <email>docs@evergreen-ils.org</email>.</listitem>\r
183                         <listitem>Check out the <link xl:href="http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:outline">documentation outline</link> to see which areas need work, \r
184                         and let the DIG list know in which areas you would like to work.</listitem>\r
185                         <listitem>Review the documentation and report any error or make suggestion using <link xl:href="https://bugs.launchpad.net/evergreen/+filebug">Launchpad</link>.</listitem>\r
186                 </itemizedlist>\r
187                 <simplesect>\r
188                         <title>Volunteer Roles</title>\r
189                         <para>We are now looking for people to help produce the documentation. If you interested in participating, email the DIG facilitators at <email>docs@evergreen-ils.org</email> \r
190                         or post on the documentation mailing list. We're looking for volunteers to work on the following:</para>\r
191                         <itemizedlist>\r
192                                 <listitem>Writing – Produce the documentation (<quote>from scratch,</quote> and/or revised from existing materials). We're open to receiving content in any formats, such as \r
193                                 Word or Open Office, but of course, would be most delighted with DocBook xml format.</listitem>\r
194                                 <listitem>Testing – Compare the documents with the functions they describe and ensuring that the procedures accomplish the desired results. Even if you are not \r
195                                 officially in the DIG, we would appreciate any suggestions you may have for Evergreen documentation.</listitem>\r
196                                 <listitem>XML conversion – Convert existing documentation to DocBook format.</listitem>\r
197                                 <listitem>Editorial review – Ensuring the documentation is clear and follows <link xl:href="http://docs.evergreen-ils.org/style_guide/html/">Evergreen DIG style \r
198                                 guide</link> conventions.</listitem>\r
199                                 <listitem>Style and Design – Edit the DocBook style sheets or post style tips and suggestions on the DIG list.</listitem>\r
200                         </itemizedlist>\r
201                 </simplesect>\r
202         </section>              \r
203 </appendix>\r
204 \r
205 \r