Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
evergreen-docs:documentation_needs [2019/04/24 13:49] – [EASY Tasks for New Contributors] katiegmartin | evergreen-docs:documentation_needs [2019/07/31 09:54] – rjs7 |
---|
| |
**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** <html><span style="color:blue;font-weight:bold">Derek from OhioNet</span></html> | |
* [[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** |
* **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** |
**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]] |
| |
| |
</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 ===== |
| |
| |
=== Other (or not categorized yet) === | === Other (or not categorized yet) === |
* <del>[3.3] ([[https://bugs.launchpad.net/bugs/1805897|Bug #1805897]]) [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Include Item Status in marc_export Items Export]]</del> | |
* <del>[3.3] ([[https://bugs.launchpad.net/bugs/1805897|Bug #1805897]]) [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Ability to Reingest Certain Record Attributes In pingest.pl]]</del> | |
* [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]] |
* [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.0] <del>[[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Fix COPY_STATUS_LONGOVERDUE.override Permission Typo]]</del> <html><span style="color:blue;font-weight:bold">katiegmartin</span></html> <html><span style="color: green;font-weight: bold"> correct in circulating_items_web_client.adoc</span></html> | |
* [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Hold Targeter V2 Repairs and Improvements]] | * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Hold Targeter V2 Repairs and Improvements]] |
* START WITH: [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html#_batch_hold_targeter_speed_up_and_new_features|Batch Hold Targeter Speed-up and New Features]] (just copy the release notes entry to the docs) | * START WITH: [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html#_batch_hold_targeter_speed_up_and_new_features|Batch Hold Targeter Speed-up and New Features]] (just copy the release notes entry to the docs) |
==== Architecture ==== | ==== Architecture ==== |
* [3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Database Support for PostgreSQL 10]] | * [3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Database Support for PostgreSQL 10]] |
* <del>[3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Ubuntu 18.04 Bionic Beaver]]</del> | |
* [3.1] <del>[[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Sample Data Includes Surveys]]</del> -- added to the wiki page about concerto data: https://wiki.evergreen-ils.org/doku.php?id=qa:concerto_logins | |
* <del>[3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Virtual Index Definitions]] - **[[https://github.com/evergreen-library-system/Evergreen/pull/70|GitHub PR #70]]**</del> | |
* [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Pure-SQL catalog searching]] | * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Pure-SQL catalog searching]] |
* NOTE: This was a big change! It may be worth writing more about it, maybe in the developer docs section. | * NOTE: This was a big change! It may be worth writing more about it, maybe in the developer docs section. |
* [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]] | * [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 |
* [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Track Record Merges]] | |
* <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 |
* <del>[2.12] New Access Points for MARC Merge/Overlay Profiles - **[[https://github.com/evergreen-library-system/Evergreen/pull/72|GitHub PR #72]]**</del> | |
* <del>[2.11] Copy Alerts - **Angela COMPLETE!** will commit with 3.0 release</del> | * <del>[2.11] Copy Alerts - **Angela COMPLETE!** will commit with 3.0 release</del> |
* [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Additional fixed fields]] | * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Additional fixed fields]] |
* [2.10] <del>[[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Link personal name/title series added entries]]</del> - COMPLETE and pushed to 3.1 and above | |
| |
| |
* [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|New Patron Billing Statement]] | * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|New Patron Billing Statement]] |
* [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Enhanced Billing Timestamp Support]] | * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Enhanced Billing Timestamp Support]] |
* <del>[2.9] [[http://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_9.html#_conditional_negative_balances|Conditional Negative Balances]]</del> | |
| |
Holds | Holds |
* [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Place Multiple Holds At Once]] | * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Place Multiple Holds At Once]] |
* [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Pickup Library for Staff-placed Holds]] | * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Pickup Library for Staff-placed Holds]] |
* <del>[2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Alternate parts selection display when placing holds]]</del> -- PR here: https://github.com/evergreen-library-system/Evergreen/pull/67 | * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Alternate parts selection display when placing holds]] -- **[[https://github.com/evergreen-library-system/Evergreen/pull/67|Pull Request]]** FIXME |
* [2.5] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_5.html|Wrong-Shelf Holds in Clearable Shelf-Expired Holds List]] - Should be incorporated (with updated screenshots) in newly revived [[http://docs.evergreen-ils.org/dev/_managing_holds.html#_clearing_shelf_expired_holds|Holds documentation]] | * [2.5] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_5.html|Wrong-Shelf Holds in Clearable Shelf-Expired Holds List]] - Should be incorporated (with updated screenshots) in newly revived [[http://docs.evergreen-ils.org/dev/_managing_holds.html#_clearing_shelf_expired_holds|Holds documentation]] |
| |
* Simple text changes | * Simple text changes |
* Needs updated screenshots | * Needs updated screenshots |
* <del>[3.3] ([[https://bugs.launchpad.net/bugs/1714070|Bug #1714070]]) [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Patron Parent/Guardian Field]]</del> | |
* <del>[3.3] ([[https://bugs.launchpad.net/bugs/1715767|Bug #1715767]]) [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Allow Others to Use My Account (Privacy Waiver)]]</del> | |
* [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Patron Preferred Name and Name Search Keywords]] | * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Patron Preferred Name and Name Search Keywords]] |
* [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Patron Email Addresses Now Clickable In Web Staff Client]] | * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Patron Email Addresses Now Clickable In Web Staff Client]] |
* [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]] |
| |
==== Client ==== | ==== Client ==== |
* <del>[3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Booking Administration Moved To Angular]]</del> | |
* <del>[3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Server Administration Moved To Angular]]</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]] |