User Tools

Site Tools


evergreen-docs:3.0_needs

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
evergreen-docs:3.0_needs [2017/11/17 00:32] – [2.11] sandbergjaevergreen-docs:3.0_needs [2022/02/10 13:34] (current) – external edit 127.0.0.1
Line 1: Line 1:
-=====Evergreen 3.0 Documentation Needs=====+<del>Evergreen 3.0 Documentation Needs</del> (deprecated, see [[evergreen-docs:documentation_needs|Evergreen 3.1 Documentation Needs]])
  
 Documentation needs based on the [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Release Notes]] entries that were submitted with new features during the 3.0 release cycle as well as [[https://launchpad.net/evergreen/3.0 | Launchpad bugs]] targeted to 3.0. Documentation needs based on the [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Release Notes]] entries that were submitted with new features during the 3.0 release cycle as well as [[https://launchpad.net/evergreen/3.0 | Launchpad bugs]] targeted to 3.0.
- 
-Also, based on earlier release notes. 
  
 Copy the HTML code below to update the status of an item: Copy the HTML code below to update the status of an item:
Line 22: Line 20:
 These are the high-level steps we take to document new features: These are the high-level steps we take to document new features:
   - Look at the new feature docs to do list (this page) and sign yourself up for documenting a new feature   - Look at the new feature docs to do list (this page) and sign yourself up for documenting a new feature
-    - You will need a EG community wiki account to edit wiki pages, just email docs@evergreen-ils.org for access. +    - You will need a EG community wiki account to edit wiki pages, just email [[docs@evergreen-ils.org]] for access. 
   - Look over the release notes entry for the feature you picked and decide   - Look over the release notes entry for the feature you picked and decide
     - if the feature warrants a new section in one or more of the official manuals (http://docs.evergreen-ils.org) to explain the new feature     - if the feature warrants a new section in one or more of the official manuals (http://docs.evergreen-ils.org) to explain the new feature
Line 30: Line 28:
  
 NOTE: Sometimes you can reuse almost all of the text in the new feature release note for use in the official docs, but sometime you have to come up with significant edits to the original release notes text. NOTE: Sometimes you can reuse almost all of the text in the new feature release note for use in the official docs, but sometime you have to come up with significant edits to the original release notes text.
 +
 +==== Style Guide ====
 +
 +  * Remember to follow (and improve) the [[evergreen-docs:dig_style_guide|DIG Style Guide]]
 +
 +===== Bugs/Minor Problems in the Documentation =====
 +  * [[https://bugs.launchpad.net/evergreen/?field.searchtext=&orderby=-importance&search=Search&field.status%3Alist=NEW&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&field.status%3Alist=FIXCOMMITTED&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&assignee_option=any&field.tag=bitesize-doc+&field.tags_combinator=ANY|Bitesize (simple) documentation bugs]] on Launchpad
 +  * [[https://bugs.launchpad.net/evergreen/?field.searchtext=&orderby=-importance&search=Search&field.status%3Alist=NEW&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&field.status%3Alist=FIXCOMMITTED&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&assignee_option=any&field.tag=documentation+&field.tags_combinator=ANY|All documentation bugs]] on Launchpad
 +
 +===== Web Client docs needs =====
 +  * [[evergreen-docs:webclient|Web Staff Client Documentation Project]]
  
 ===== 3.0 documentation needs ===== ===== 3.0 documentation needs =====
Line 35: Line 44:
 ==== Upgrade notes ==== ==== Upgrade notes ====
   * Change to Names of Shared Libraries   * Change to Names of Shared Libraries
-  * SIP Bugfix Requires SIPServer Upgrade 
   * open-ils.auth.login   * open-ils.auth.login
-  * RTL CSS Stylesheet 
   * Multi-Time Zone Installations   * Multi-Time Zone Installations
  
Line 71: Line 78:
  
 ==== Circulation ====  ==== Circulation ==== 
-  * Batch Editing of Patron Records (already in 3.0 circulation and staff-client sysadmin manuals, but could benefit from screenshots and editing)+  * Batch Editing of Patron Records 
 +    * NOTE: Seems to be finished in [[http://docs.evergreen-ils.org/3.0/_user_buckets.html|3.0 manuals]] 
 +    * CONSIDER removing earlier draft section: [[http://docs.evergreen-ils.org/reorg/3.0/circulation/_user_buckets_2.html|XI. User buckets]]
   * Honor timezone of the acting library   * Honor timezone of the acting library
   * Enhancements to Hard Due Date Functionality   * Enhancements to Hard Due Date Functionality
Line 107: Line 116:
  
 ==== SIP ====  ==== SIP ==== 
-  * SIP Bugfix Changes How Encoding Is Determined in Configuration+  * SIP Bugfix Changes How Encoding Is Determined in Configuration - done, pushed to 3.0 and above
  
  
Line 123: Line 132:
   * Controlling how holds are fulfilled   * Controlling how holds are fulfilled
   * Managing patron penalties and alerts   * Managing patron penalties and alerts
-  * Sending reminders to your users 
   * Care and feeding of Evergreen   * Care and feeding of Evergreen
   * <del>Preparing for disaster: saving your data</del> - done (committed to 3.0 and above)   * <del>Preparing for disaster: saving your data</del> - done (committed to 3.0 and above)
Line 183: Line 191:
     * Add Date Header to Action Trigger Email/SMS Templates     * Add Date Header to Action Trigger Email/SMS Templates
     * <del>Tablefunc Extension No Longer Required</del> (No change needed)     * <del>Tablefunc Extension No Longer Required</del> (No change needed)
-    * SIP Renewals +    * SIP Renewals -- done, pushed to 3.0 and above 
-    * Treat SIP Location Field as Login Workstation+    * Treat SIP Location Field as Login Workstation -- done, pushed to 3.0 and above
  
 ** Cataloging ** ** Cataloging **
Line 199: Line 207:
  
     * Additional Fields Available for Display in Some Interfaces     * Additional Fields Available for Display in Some Interfaces
- 
-** OPAC ** 
- 
-    * Removal of Advanced Hold Options link when part holds are expected - <html><span style="color:blue;font-weight:bold"></span></html> 
  
 ==== 2.10 ==== ==== 2.10 ====
Line 253: Line 257:
     * [[http://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_9.html#_pre_expiration_a_t_event_definition|Pre-Expiration A/T Event Definition]] <html><span style="color:blue;font-weight:bold"> Stompro</span><span style="color: green;font-weight: bold"> in progress</span></html> [[https://gist.github.com/stompro/5574d7e4587d3c3e7587|Gist]] FIXME     * [[http://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_9.html#_pre_expiration_a_t_event_definition|Pre-Expiration A/T Event Definition]] <html><span style="color:blue;font-weight:bold"> Stompro</span><span style="color: green;font-weight: bold"> in progress</span></html> [[https://gist.github.com/stompro/5574d7e4587d3c3e7587|Gist]] FIXME
     * [[http://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_9.html#_upgrade_notes_2|Upgrade Notes]]     * [[http://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_9.html#_upgrade_notes_2|Upgrade Notes]]
-      * Remove Script-Based Circulation Configuration +      * Remove Script-Based Circulation Configuration -- done, pushed to 3.0 and above
-        * **EASY:** Remove minor reference ("legacy circ scripts") from [[http://docs.evergreen-ils.org/2.7/_sip_communication.html]]+
     * [[http://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_9.html#_improved_caching_of_web_server_templates|Improved caching of web server templates]]     * [[http://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_9.html#_improved_caching_of_web_server_templates|Improved caching of web server templates]]
       * **EASY:** Add to "Configure the Apache Web server" (within [[http://docs.evergreen-ils.org/dev/_configure_the_apache_web_server.html|Chapter 8. Installing the Evergreen server]])       * **EASY:** Add to "Configure the Apache Web server" (within [[http://docs.evergreen-ils.org/dev/_configure_the_apache_web_server.html|Chapter 8. Installing the Evergreen server]])
Line 289: Line 292:
     * Support Reader Address Information in Routing Slip Template      * Support Reader Address Information in Routing Slip Template 
   * SIP   * SIP
-    * Support SIP Hold Cancellation - Looks like this adds a configuration option which should probably be incorporated when SIP Server docs are moved up.+    * Support SIP Hold Cancellation -- done, pushed to 3.0 and above
     * Return Hold ID to SIP - Probably requires some documentation since the use cases it support may not be immediately apparent.     * Return Hold ID to SIP - Probably requires some documentation since the use cases it support may not be immediately apparent.
  
Line 306: Line 309:
  
 ==== Older or Unknown Release ==== ==== Older or Unknown Release ====
 +
 +  * Inventory
 +    * Elaine Hardy of PINES wrote [[http://pines.georgialibraries.org/inventory|some instructions]] that can be adapted into the official docs.
 +  * Patron penalty color-codes (colored border around patron name) ([[https://bugs.launchpad.net/evergreen/+bug/1759357|see Bug 1759357]])
 +  * Cataloging (needs to be reorganized)
 +    * <del>Marc Editor ([[https://bugs.launchpad.net/evergreen/+bug/954213|see bug report]])</del>
 +    * Need a new "Volume/Copy Editor" section (borrow from [[http://docs.evergreen-ils.org/dev/_monograph_parts.html|"Monograph Parts"]])
 +  * Intro to SQL (Based on Dan Scott content) Yamil still needs to make some edits like proper attribution, and test that its addition does not break the full docs
 +  * Library Settings Editor - (Lynn Floyd, SCLENDS is working on it)
 +  * OpenSRF/Evergreen Installation Guide (two PDFs linked from email below, useful but need updating)
 +    * http://markmail.org/thread/uitwopkmbv2nqlhs
 +  * Archiving of Circulation Transactions (new section)
 +  * Addresses on Routing List (missing?)
  
   * Administration   * Administration
Line 338: Line 354:
       * A great start in the wiki by phasefx - http://wiki.evergreen-ils.org/doku.php?id=scratchpad:holds       * A great start in the wiki by phasefx - http://wiki.evergreen-ils.org/doku.php?id=scratchpad:holds
       * There is a presentation by Equinox - http://evergreen-ils.org/~corinne/Hippos_Final.ppt       * There is a presentation by Equinox - http://evergreen-ils.org/~corinne/Hippos_Final.ppt
 +
 +==== Non-Docs Tasks ====
 +  * Setup a mechanism for testing/building the master docs (as part of buildbot?)
 +    * yboston will email Dev list for feedback on this preliminary plan
 +    * include [[http://georgialibraries.markmail.org/thread/l5ttj5rqmgndsrek|checks for common mistakes]] (incorrect image references, unused image files, etc.)
 +  * Improve the PDF version of the built documentation (ask community for usage, ideas, etc.)
 +  * Setup/use Google analytics to improve docs website design
 +  * Incorporate relevant docs links into Web Staff Client screens (i.e. contextual help)
 +  * UI improvements
 +    * [[http://georgialibraries.markmail.org/thread/kjddts4zod2uwbe6|OPW intern ideas]]
evergreen-docs/3.0_needs.1510896767.txt.gz · Last modified: 2022/02/10 13:34 (external edit)

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.