User Tools

Site Tools


evergreen-docs:reorg

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
evergreen-docs:reorg_2014 [2015/03/03 10:47] – [Meetings] rjs7evergreen-docs:reorg [2017/09/07 14:38] – [Current Re-Organization] jpringle
Line 1: Line 1:
-====== Docs Reorganization Project 2015 ======+====== Docs Reorganization Project ======
  
 This page provides a place to discuss how to organize the official documentation. This page provides a place to discuss how to organize the official documentation.
Line 5: Line 5:
 Please add ideas, suggest a new approach, or create a new structure by copying the Table of Contents from below.  Share your changes via your own wiki page, or send a text file (or Word Doc, etc.) to the DIG mailing list ([[open-ils-documentation@list.georgialibraries.org]]). Please add ideas, suggest a new approach, or create a new structure by copying the Table of Contents from below.  Share your changes via your own wiki page, or send a text file (or Word Doc, etc.) to the DIG mailing list ([[open-ils-documentation@list.georgialibraries.org]]).
  
-===== Meetings =====+===== Current Re-Organization ===== 
 +  * [[evergreen-docs:reorg:clean_up | Doc Re-org Clean Up]] 
 +  * [[evergreen-docs:reorg_2014:getting_started | Getting Started Book ]]  
 +  * [[evergreen-docs:reorg_2014:acquisitions | Acquisitions Book ]] 
 +  * [[evergreen-docs:reorg_2014:circulation | Circulation Book ]] 
 +  * [[evergreen-docs:reorg_2014:system_admin | Staff Client System Administration Book ]] 
 +  * [[evergreen-docs:reorg_2014:cli_system_admin | Command Line System Administration Book ]] 
 +    * Copy help files from scripts into official docs? 
 +    * Example cron script: [[evergreen-admin:cron_services]] 
 +  * [[evergreen-docs:reorg_2014:dev_handbook | Evergreen Developer Handbook]] 
 +    * Technical Introduction to Evergreen (similar to [[eg_developer_overview]]) 
 +    * How to Participate in the Evergreen Community (communication channels, getting over initial fears, groups/meetings, etc.) 
 +    * How to contribute code/docs/etc. (intro to launchpad, pull request process, etc.) 
 +  * [[evergreen-docs:reorg_2014:integrating_evergreen | Integrating Evergreen with Other Tools]] 
 +    * [[faqs:evergreen_compatible_products_results_survey_2017]]
  
 +==== Specifications ====
  
-**1st Meeting:** A special meeting was held on [[http://evergreen-ils.org/communicate/irc/|IRC]] to discuss these ideas on Thursday, February 19, 2015 at 1:00 PM EST. [[http://evergreen-ils.org/meetings/evergreen/2015/evergreen.2015-02-19-13.01.html|(Meetbot) Minutes]] [[http://evergreen-ils.org/meetings/evergreen/2015/evergreen.2015-02-19-13.01.log.html|Log]] +  * [[evergreen-docs:reorg_2014:requirements|Draft list of requirements]] 
 + 
 +===== Meetings =====
  
  
 +  * **Initial meeting** (Thursday, February 19, 2015 at 1:00 PM EST)
 +    * [[http://evergreen-ils.org/meetings/evergreen/2015/evergreen.2015-02-19-13.01.html|(Meetbot) Minutes]]
 +    * [[http://evergreen-ils.org/meetings/evergreen/2015/evergreen.2015-02-19-13.01.log.html|Log]]
 +  * **Planning meeting** (Wednesday, February 10, 2016 at 2:00 PM EST)
 +    * [[evergreen-docs:reorg_2014:agenda_2016-02-10|Agenda]] 
 +    * [[http://evergreen-ils.org/meetings/evergreen/2016/evergreen.2016-02-10-14.00.html|Minutes]]
 +    * [[http://evergreen-ils.org/meetings/evergreen/2016/evergreen.2016-02-10-14.00.log.html|Log]]
 +  * **March 2016 meeting** (Monday, March 7, 2016 at 2:00 PM Eastern)
 +    * [[evergreen-docs:reorg_2014:agenda_2016-03-07|Agenda]] 
 +    * [[http://evergreen-ils.org/meetings/evergreen/2016/evergreen.2016-03-07-14.01.html|(Meetbot) Minutes]]
 +    * [[http://evergreen-ils.org/meetings/evergreen/2016/evergreen.2016-03-07-14.01.log.html|Log]]
 +  * **April 2016 meeting** (Date not yet set)
 +    * [[evergreen-docs:reorg_2014:agenda_2016-04|Agenda]] 
 ===== Ideas for Organization ===== ===== Ideas for Organization =====
  
 +  - Focus on [[evergreen-docs:reorg_2014:audience| type of user]] (e.g. Installer, System Admin, Staff Admin, Staff User (by module: circ, cat, acq), etc.)
 +    * [[evergreen-docs:reorg_2014:audience_focused_layout|Ideas for audience-focused layout]]
 +    * One benefit: Each smaller "book" would be easier to read and evaluate for completeness than the current combined docs is.
   - Use the structure of [[http://en.flossmanuals.net/evergreen-in-action/|"Evergreen in Action"]] as the main organizing structure for the docs   - Use the structure of [[http://en.flossmanuals.net/evergreen-in-action/|"Evergreen in Action"]] as the main organizing structure for the docs
     * Some chapters have already been merged from Evergreen in Action. The rest should also be considered.     * Some chapters have already been merged from Evergreen in Action. The rest should also be considered.
Line 19: Line 52:
     * Add a section at the end for developer resources     * Add a section at the end for developer resources
     * Integrate the rest of the docs into the appropriate sections     * Integrate the rest of the docs into the appropriate sections
-  - Focus on [[evergreen-docs:reorg_2014:audience| type of user]] (e.g. Installer, System Admin, Staff Admin, Staff User (by module: circ, cat, acq), etc.) 
-    * [[evergreen-docs:reorg_2014:audience_focused_layout|Ideas for audience-focused layout]] 
   - Design the docs for integration with the web client   - Design the docs for integration with the web client
     * Targeted answers to specific task-based questions     * Targeted answers to specific task-based questions
Line 27: Line 58:
  
 ===== Current Table of Contents ===== ===== Current Table of Contents =====
- 
 (Taken from the 2.7 docs at: http://docs.evergreen-ils.org/2.7/) (Taken from the 2.7 docs at: http://docs.evergreen-ils.org/2.7/)
  
evergreen-docs/reorg.txt · Last modified: 2022/02/10 13:34 by 127.0.0.1

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 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.