Both sides previous revisionPrevious revisionNext revision | Previous revision |
evergreen-docs:documentation_needs [2021/05/28 13:58] – [High level workflow for documenting new EG features] dluchenbill | evergreen-docs:documentation_needs [2024/11/12 16:37] (current) – [3.14 Documentation Still Needed] smorrison |
---|
* Remember to follow (and improve) the [[evergreen-docs:dig_style_guide|DIG Style Guide]] | * Remember to follow (and improve) the [[evergreen-docs:dig_style_guide|DIG Style Guide]] |
| |
===== EASY Tasks for New Contributors ===== | ====3.12 Documentation Still Needed==== |
| |
**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]]**: | List here all extant documentation needed for Evergreen version 3.12: |
| |
* **IDL acronym used, but never defined**<html><span style="color:blue;font-weight:bold">Lynn and Blake</span></html> <html><span style="color: green;font-weight: bold"> COMPLETE!</span></html> | * Hatch Print Config Angular Port ([[https://bugs.launchpad.net/evergreen/+bug/1965326|LP1965326]]) - there's not a lot on Hatch in general in the documentation. |
* [[https://bugs.launchpad.net/evergreen/+bug/1857917|Details on Launchpad]] | * Shelving Locations Editor: Hide deleted shelving locations by default ([[https://bugs.launchpad.net/evergreen/+bug/1917092|LP1917092]]) - //(Done 11.12.24 - SM)// |
* Simply add term to glossary (can use suggested definition on bug report) | * Staff can now set a default item alert type for new item alerts ([[https://bugs.launchpad.net/evergreen/+bug/2017673|LP2017673]]) |
| * Two new filter combo boxes have been added to the Holds Pull List ([[https://bugs.launchpad.net/evergreen/+bug/1968070|LP1968070]]) - //(Done 5.31.24 - SM)// |
| * Grids throughout the staff client now have an option to print only rows that the user has selected, rather than printing all rows in the grid([[https://bugs.launchpad.net/evergreen/+bug/2037128|LP2037128]]) - //(Done 5.31.24 - SM)// |
| * Adds display of upcoming closures (as entered in the Closed Dates Editor) to the library information pages in the OPAC. ([[https://bugs.launchpad.net/evergreen/+bug/2017913|LP2017913]]) - //(Done 11.12.24 - SM)// |
| * Holdings Editor - call number attributes as part of holdings templates and change in template buttons ([[https://bugs.launchpad.net/evergreen/+bug/1983156|LP1983156]]) - also noting that existing section for the [[https://docs.evergreen-ils.org/docs/latest/cataloging/volcopy_editor.html|holdings editor]] is out of date |
| |
* **Docs use acronym TLD without defining it** | ====3.13 Documentation Still Needed==== |
* [[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** | * Grids - [[https://docs.evergreen-ils.org/docs/latest/admin/staff_client-angular_grid_tools.html| existing docs]], [[https://bugs.launchpad.net/evergreen/+bug/1615781/comments/3 | new info from LP]], [[https://wiki.evergreen-ils.org/doku.php?id=dev:eg-grid:styling | new info from wiki]] - **Andrea** |
* [[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]] | * shelving location filter - **Andrea** |
* To fix this, let's add a section about browser font size controls to the "Using the Browser Staff Client" chapter | * SIP |
* [[https://support.mozilla.org/en-US/kb/font-size-and-zoom-increase-size-of-web-pages|Mozilla Firefox]] | * Enhanced MARC Editor - **Andrea** |
* [[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** | ====3.14 Documentation Still Needed==== |
* [[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]] | * Collapsible facets in staff catalog search - [[https://bugs.launchpad.net/evergreen/+bug/2073988 | LP 2073988]] - //(Done 11.12.24 - SM)// |
* 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]] | * support for EDI ASN Receiving via X12 - [[https://bugs.launchpad.net/evergreen/+bug/2003106 | LP 2003106 ]] - <html><span style="color:blue;font-weight:bold">Andrea</span></html> |
| * Export public copy notes and tags in marc_export - [[https://bugs.launchpad.net/evergreen/+bug/2045440 | LP 2045440 ]] - <html><span style="color:blue;font-weight:bold">Ruth</span></html> |
| * Export public copy tags in SuperCat/unAPI -[[ https://bugs.launchpad.net/evergreen/+bug/2047442 | LP 2047442]] |
| * Option to require other libraries to add monograph parts if one library has added a part to an item on the bib record - [[https://bugs.launchpad.net/evergreen/+bug/2018014 | LP 2018014 ]] - //(Done..ish 11.12.24 - SM; only added to Monograph Parts page for now, not Library Settings page)// |
| * Rename Any Parts label - [[https://bugs.launchpad.net/evergreen/+bug/1902120 | LP 1902120]] - <html><span style="color:blue;font-weight:bold">Andrea</span></html> - **DONE** |
| * Add a support script for importing patrons [[https://bugs.launchpad.net/evergreen/+bug/1786524 | LP 1786524]] [[https://git.evergreen-ils.org/?p=working/Evergreen.git;a=blob;f=docs/RELEASE_NOTES_NEXT/Administration/patron_loader_support_script.adoc;h=10392b8f4a97696b861354b31cf62bc5008a0630;hb=942290e9fc7b40ba15309adabe538ba72e65b7ab | Release Note]] |
| * Merge monograph parts should transfer holds to resulting part - [[https://bugs.launchpad.net/evergreen/+bug/1533316 | LP 1533316]] - <html><span style="color:blue;font-weight:bold">Ruth</span></html> |
| * Renewals based on hold-ratio doesn't take age protection into account - [[https://bugs.launchpad.net/evergreen/+bug/1989740 | 1989740]] - <html><span style="color:blue;font-weight:bold">Lena</span></html> |
| * Toast accessibility new library setting - [[https://bugs.launchpad.net/evergreen/+bug/1836686 | LP 1836686]] - <html><span style="color:blue;font-weight:bold">Jennifer</span></html> |
| * Angularize the Self-Check Interface - [[https://bugs.launchpad.net/evergreen/+bug/1840773 | LP 1840773]] [[https://docs.google.com/document/d/191G7UKAr7ShPaZ1J-YXW43TRbJjH79C_GNbjSI9nJv8/edit#heading=h.yo0bvp6lgi71 | Working Doc]] - <html><span style="color:blue;font-weight:bold">Jennifer in 2025</span></html> |
| * Quick Receive added to angular catalog serials menu - [[https://bugs.launchpad.net/evergreen/+bug/1906462 | LP 1906462]] needs to be added to [[https://docs.evergreen-ils.org/docs/latest/staff_catalog/bibliographic_records.html#record_actions | this page]] |
| |
| |
| |
| \\ |
| ===== EASY Tasks for New Contributors ===== |
| |
| **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]]**: |
| |
* **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** | * **Move images into dedicated page subfolder** |
* [[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]] | * [[https://bugs.launchpad.net/evergreen/+bug/2060219|Details on Launchpad]] |
| |
* **Give example for importing stat cats via Holdings Import Profile** | * **Give example for importing stat cats via Holdings Import Profile** |
| |
* [[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 | * [[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 |
| * [[https://docs.google.com/document/d/12PcHVY5VmUqkjIfcAfO-3ZD1vAqIpF2kVem1T0lKkdI/edit|Clean up errors from 'generate docs' logs]] |
| |
| |
* [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 |
* [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]] |
* [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 ==== |