User Tools

Site Tools


evergreen-docs:documentation_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
Next revisionBoth sides next revision
evergreen-docs:documentation_needs [2019/04/11 10:55] – [High level workflow for documenting new EG features] rjs7evergreen-docs:documentation_needs [2019/07/11 13:49] rjs7
Line 13: Line 13:
  
 **Bitesize (simple) documentation bugs on [[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|Launchpad]]**: **Bitesize (simple) documentation bugs on [[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|Launchpad]]**:
- 
-  * **"Delete record" option missing from OPAC view**  
-    * [[https://bugs.launchpad.net/evergreen/+bug/1803415|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_working_with_the_marc_editor.html|Current Docs]] (no mention of Delete yet) - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/cataloging/MARC_Editor.adoc|Edit on GitHub]] 
-    * Possible places to link to the new section: 
-      * [[http://docs.evergreen-ils.org/dev/_record_buckets.html|Record Buckets]] 
-      * [[http://docs.evergreen-ils.org/dev/_deleting_copies_from_the_catalogue.html|Deleting Copies from the Catalogue]] 
  
   * **Documentation needed for adjustable font size in the catalog**   * **Documentation needed for adjustable font size in the catalog**
Line 28: Line 22:
   * **Add tips for using the browser bookmarks toolbar in place of the XUL button bar**   * **Add tips for using the browser bookmarks toolbar in place of the XUL button bar**
     * [[https://bugs.launchpad.net/evergreen/+bug/1751146|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_best_practices_for_using_the_browser.html|Current Docs]] - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/admin/web-client-browser-best-practices.adoc|Edit on GitHub]]     * [[https://bugs.launchpad.net/evergreen/+bug/1751146|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_best_practices_for_using_the_browser.html|Current Docs]] - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/admin/web-client-browser-best-practices.adoc|Edit on GitHub]]
 +      * [[https://support.google.com/chrome/answer/188842?hl=en&co=GENIE.Platform=Desktop|Managing Bookmarks in Google Chrome]]
 +      * We may want to include tips about [[https://support.google.com/chrome/answer/2391819?co=GENIE.Platform%3DDesktop&hl=en|Managing Tabs in Google Chrome]]
  
   * **Update "Holds Management" section for web client**   * **Update "Holds Management" section for web client**
Line 38: Line 34:
 **Pull Requests ready for review** (according to [[https://bugs.launchpad.net/evergreen/+bugs?field.searchtext=&orderby=-importance&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&field.tag=documentation+pullrequest&field.tags_combinator=ALL|Launchpad]]): **Pull Requests ready for review** (according to [[https://bugs.launchpad.net/evergreen/+bugs?field.searchtext=&orderby=-importance&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&field.tag=documentation+pullrequest&field.tags_combinator=ALL|Launchpad]]):
  
-  * Replace screenshots in "Circulating Items" chapter+  * **Replace screenshots in "Circulating Items" chapter**
     * [[https://bugs.launchpad.net/evergreen/+bug/1778712|Details on Launchpad]], [[http://docs.evergreen-ils.org/dev/_circulating_items.html|Current Docs]], [[http://git.evergreen-ils.org/?p=working/Evergreen.git;a=commit;h=60617734450f9891462a850534ab08ae31444c34|Git Working Branch]]     * [[https://bugs.launchpad.net/evergreen/+bug/1778712|Details on Launchpad]], [[http://docs.evergreen-ils.org/dev/_circulating_items.html|Current Docs]], [[http://git.evergreen-ils.org/?p=working/Evergreen.git;a=commit;h=60617734450f9891462a850534ab08ae31444c34|Git Working Branch]]
 +
 +  * **"Delete record" option missing from OPAC view**
 +    * [[https://bugs.launchpad.net/evergreen/+bug/1803415|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_working_with_the_marc_editor.html|Current Docs]] (no mention of Delete yet) - [[https://github.com/evergreen-library-system/Evergreen/pull/80|GitHub Pull Request]]
 +    * Possible places to link to the new section:
 +      * [[http://docs.evergreen-ils.org/dev/_record_buckets.html|Record Buckets]]
 +      * [[http://docs.evergreen-ils.org/dev/_deleting_copies_from_the_catalogue.html|Deleting Copies from the Catalogue]]
  
  
Line 58: Line 60:
  
  
-<html><div style="background:#FFCC00; padding:0.3em">+<html><div style="background:#FFDDDD; padding:0.3em">
 <h3>TIPS</h3> <h3>TIPS</h3>
 Check Sitka's documentation, especially when documenting older features: Check Sitka's documentation, especially when documenting older features:
Line 67: Line 69:
 </div></html> </div></html>
  
 +===== Quick Start Guides =====
 +
 +We would like to provide an "Evergreen Quick Start" guide for the most common functions of Evergreen.  The intended audience is library volunteers, student workers, and staff who are new to libraries.  Learn more about the [[evergreen-docs:quickstarts|initial idea]].
 +
 +  * [[http://www.sandbox.lbcc.linnlibraries.org/Evergreen/docs/quickstarts/check_out.html|Proof of concept]]
 +  * Some key features of such a guide would be:
 +    * Short (hopefully fitting on a single page printout)
 +    * Simple (no library jargon, no extra explanations)
 +    * Generic (not specific to any library or consortium)
 +    * Includes a short video
 +  * See [[https://www.youtube.com/playlist?list=PLdwlgwBNnH4rSKEJPA3Q_vz7QO-h4JN0P|Sitka's short videos]] for examples.
 +
 +Here's a list of the guides we think we need.  Feel free to add more!
 +
 +==== Check In ====
 +
 +==== Check Out ====
 +
 +  * See the [[evergreen-docs:quickstarts#check_out|draft of a video script]].
 +
 +==== Adding Holdings ====
 +
 +Adding call numbers and items to a bibliographic record.
 +
 +  * How would you say "bibliographic record" without library jargon?
 ===== Undocumented Features/Changes, Taken From Release Notes ===== ===== Undocumented Features/Changes, Taken From Release Notes =====
  
Line 150: Line 177:
     * [3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Spine label sheet printing]]     * [3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Spine label sheet printing]]
     * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Printing spine labels]] (see [[https://bugs.launchpad.net/evergreen/+bug/1704873|bug #1704873]]) - Some very basic documentation exists, but it needs more content about how to work with the templates, etc.     * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Printing spine labels]] (see [[https://bugs.launchpad.net/evergreen/+bug/1704873|bug #1704873]]) - Some very basic documentation exists, but it needs more content about how to work with the templates, etc.
-  * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Support for Last Inventory Date]] +  * <del>[3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Support for Last Inventory Date]] <html><span style="color: green;font-weight: bold">COMPLETE!</span></html> [[https://github.com/evergreen-library-system/Evergreen/pull/82|Pull request 82]]</del> 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Track Record Merges]]+  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Track Record Merges]] <html><span style="color: green;font-weight: bold"> COMPLETE! Pull request #83</span></html> [[https://github.com/evergreen-library-system/Evergreen/pull/83|Pull request 83]] FIXME
   * <del>[3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Authority Record and Headings Browse Improvements]] - **[[https://github.com/evergreen-library-system/Evergreen/pull/71|GitHub PR #71]]**</del>   * <del>[3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Authority Record and Headings Browse Improvements]] - **[[https://github.com/evergreen-library-system/Evergreen/pull/71|GitHub PR #71]]**</del>
   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Include Call Number Prefixes and Suffixes in Export and Z39.50 output]] -- added to Export documentation, not yet in Z39.50 documentation   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Include Call Number Prefixes and Suffixes in Export and Z39.50 output]] -- added to Export documentation, not yet in Z39.50 documentation
Line 205: Line 232:
   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Transit Cancel Time and Terminology Change]]   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Transit Cancel Time and Terminology Change]]
   * [2.11] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_11.html|Staff Client Honors Aged Circulations]]   * [2.11] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_11.html|Staff Client Honors Aged Circulations]]
-  * [2.11] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_11.html|"Canceled Transit" Item Status]] - <html><span style="color:blue;font-weight:bold">Debbie</span></html> <html><span style="color: green;font-weight: bold">in progress</span></html>+  * [2.11] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_11.html|"Canceled Transit" Item Status]] - <html><span style="color:blue;font-weight:bold">Debbie</span></html> <html><span style="color: green;font-weight: bold"> COMPLETE!</span></html> **[[https://github.com/evergreen-library-system/Evergreen/pull/81|GitHub PR #81]]** FIXME
   * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|non-active status copy transit message]]   * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|non-active status copy transit message]]
   * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|selectively disallow opt-in based on patron's home library]]   * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|selectively disallow opt-in based on patron's home library]]
Line 217: Line 244:
   * <del>[3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Option to Enable Experimental Angular Staff Catalog]]</del>   * <del>[3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Option to Enable Experimental Angular Staff Catalog]]</del>
   * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Disabling of legacy XUL client]]   * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Disabling of legacy XUL client]]
-  * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Browser Client Settings & Preferences Stored on the Server]]+  * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Browser Client Settings & Preferences Stored on the Server]] -- also see this IRC discussion: http://irc.evergreen-ils.org/evergreen/2019-06-03#i_408119
   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Add Circ Modifier to Record Detail Page in Staff TPAC]]   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Add Circ Modifier to Record Detail Page in Staff TPAC]]
   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Date+Time Format Settings for Web Client]]   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Date+Time Format Settings for Web Client]]
evergreen-docs/documentation_needs.txt · Last modified: 2024/03/07 17:36 by dluchenbill

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.