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 revision Previous revision
Next revision
Previous revision
evergreen-docs:documentation_needs [2021/05/27 11:55]
sandbergja [Administration]
evergreen-docs:documentation_needs [2022/01/14 19:10]
sandbergja [Course Materials] Creating some basic documentation and pushed it today
Line 4: Line 4:
  
 ^ **1. Choose a Task** ^ **2. Read Release Notes** ^ **3. Update the Docs** ^ ^ **1. Choose a Task** ^ **2. Read Release Notes** ^ **3. Update the Docs** ^
-| \\  - Look at the task list below and add your name next to a task\\   - Need a wiki account? [[docs@evergreen-ils.org|Just ask]]. | \\ - Review the release notes entry for the feature (and/or the Launchpad bug)\\ - It may need a new section in one or more of the [[http://docs.evergreen-ils.org|official manuals]]\\ - It may fit within an existing section\\ - It may only need updated screenshots\\ - You may be able to simply copy the release note into the appropriate section | \\ - Make corrections in any\\ format (perhaps by editing\\ on GitHub) and share with the [[open-ils-documentation@list.georgialibraries.org|email list]]\\ - Learn more about [[evergreen-docs:how-to-contribute-documentation|ways to contribute your changes]] |+| \\  - Look at the task list below and add your name next to a task\\   - Need a wiki account? [[docs@evergreen-ils.org|Just ask]]. | \\ - Review the release notes entry for the feature (and/or the Launchpad bug)\\ - It may need a new section in one or more of the [[http://docs.evergreen-ils.org|official manuals]]\\ - It may fit within an existing section\\ - It may only need updated screenshots\\ - You may be able to simply copy the release note into the appropriate section | \\ - Make corrections in any\\ format (perhaps by editing\\ on GitHub) and share with the [[evergreen-documentation@list.evergreen-ils.org|email list]]\\ - Learn more about [[evergreen-docs:how-to-contribute-documentation|ways to contribute your changes]] |
  
 ==== Style Guide ==== ==== Style Guide ====
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]]**:
- 
-  * **IDL acronym used, but never defined** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1857917|Details on Launchpad]] 
-    * Simply add term to glossary (can use suggested definition on bug report) 
- 
-  * **Docs use acronym TLD without defining it** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1837753|Details on Launchpad]] 
-    * Add term to glossary (can use suggested definition on bug report) 
-    * Also change first use of "TLD" to "Top Level Domain (TLD)" 
- 
-  * **Documentation needed for adjustable font size in the catalog** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1250528|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_using_the_browser_staff_client.html|Current Docs]] - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/admin/web-client-browser-best-practices.adoc|Edit on GitHub]] 
-    * To fix this, let's add a section about browser font size controls to the "Using the Browser Staff Client" chapter 
-      * [[https://support.mozilla.org/en-US/kb/font-size-and-zoom-increase-size-of-web-pages|Mozilla Firefox]] 
-      * [[https://support.google.com/chrome/answer/96810?hl=en|Google Chrome]] 
- 
-  * **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://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**
     * [[https://bugs.launchpad.net/evergreen/+bug/1775402|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_holds_management.html|Current Docs]] - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/circulation/advanced_holds.adoc|Edit on GitHub]]     * [[https://bugs.launchpad.net/evergreen/+bug/1775402|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_holds_management.html|Current Docs]] - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/circulation/advanced_holds.adoc|Edit on GitHub]]
- 
-  * **Update "Address Alert" section for web client** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1776977|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_address_alert.html|Current Docs]] - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/admin/lsa-address_alert.adoc|Edit on GitHub]] 
  
   * **Give example for importing stat cats via Holdings Import Profile**   * **Give example for importing stat cats via Holdings Import Profile**
Line 164: Line 141:
   * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_server_managed_print_templates_for_angular|Server-Managed Print Templates for Angular]]   * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_server_managed_print_templates_for_angular|Server-Managed Print Templates for Angular]]
   * [3.2] Switching workstation settings to user settings: see [[https://markmail.org/message/hfaogumstphagscy|this email]], [[http://irc.evergreen-ils.org/evergreen/2019-06-03#i_408119|this irc message]], [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html#_browser_client_settings_amp_preferences_stored_on_the_server|these release notes]], and especially [[https://markmail.org/message/njz7qt7lfmhmtjgo|this email]]   * [3.2] Switching workstation settings to user settings: see [[https://markmail.org/message/hfaogumstphagscy|this email]], [[http://irc.evergreen-ils.org/evergreen/2019-06-03#i_408119|this irc message]], [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html#_browser_client_settings_amp_preferences_stored_on_the_server|these release notes]], and especially [[https://markmail.org/message/njz7qt7lfmhmtjgo|this email]]
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|New Latency Tester Tool]]+  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|New Latency Tester Tool]] <html><span style="color:blue;font-weight:bold">[Lynn Floyd]</span></html>
   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Add Description Field to Circulation and Hold Configuration Entries]]   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Add Description Field to Circulation and Hold Configuration Entries]]
   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Configurable Bib Record Display Fields]] -- this would be helpful with an example of how to display these fields in notification templates and/or elsewhere   * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Configurable Bib Record Display Fields]] -- this would be helpful with an example of how to display these fields in notification templates and/or elsewhere
Line 271: Line 248:
   * [3.6] Angular staff catalog is now the default -- probably lots of implications for step-by-step procedures, screenshots, etc.   * [3.6] Angular staff catalog is now the default -- probably lots of implications for step-by-step procedures, screenshots, etc.
   * [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]] -- also see this IRC discussion: http://irc.evergreen-ils.org/evergreen/2019-06-03#i_408119+  * [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  <html><span style="color:blue;font-weight:bold">[Lynn]</span></html>
   * [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]]
Line 280: Line 257:
   * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_angular_grid_improvements|New features for Angular Grids]]   * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_angular_grid_improvements|New features for Angular Grids]]
      
-==== Course Materials ==== +
-  * [3.6] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_circulation|Course Materials Module]] -- [[https://docs.google.com/document/d/1Dy1jcs6Kog8kxuIGg2GfJ4wIr4uKwMuMzd-uGuovaCc/edit#|this test plan]] may be helpful+
  
 ==== Public catalog ==== ==== Public catalog ====
evergreen-docs/documentation_needs.txt · Last modified: 2022/02/10 13:34 (external edit)

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