Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
evergreen-docs:documentation_needs [2019/04/10 09:20] – [Cataloging] rjs7 | evergreen-docs:documentation_needs [2019/06/06 16:02] – [Quick Start Guides] rjs7 |
---|
==== High level workflow for documenting new EG features ==== | ==== High level workflow for documenting new EG features ==== |
| |
These are the high-level steps we take to document new features: | ^ **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 | | \\ - 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]] | |
- Need a wiki account? Just email [[docs@evergreen-ils.org]] for access. | |
- Review the release notes entry for the feature (or the details on the Launchpad bug, if applicable) | |
- It may need a new section in one or more of the official manuals (http://docs.evergreen-ils.org) | |
- It may fit within an existing section | |
- It may only require updating a screenshot | |
- 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 community (via the [[open-ils-documentation@list.georgialibraries.org|email list]]) | |
- You may want to read the [[evergreen-docs:how-to-contribute-documentation|detailed steps for contributing your docs changes]] | |
| |
==== Style Guide ==== | ==== Style Guide ==== |
| |
===== EASY Tasks for New Contributors ===== | ===== EASY Tasks for New Contributors ===== |
| |
**Add Index Terms Throughout the Docs** | |
* [[evergreen-docs:adding_indexterms|Documentation files that are missing index terms]] | |
| |
**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 | * **Documentation needed for adjustable font size in the catalog** |
* [[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 | |
* [[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]] | * [[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 | * To fix this, let's add a section about browser font size controls to the "Using the Browser Staff Client" chapter |
* [[https://support.google.com/chrome/answer/96810?hl=en|Google Chrome]] | * [[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 | * **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]] |
| |
* 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 | * **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]] | * [[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]] |
| |
**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]] |
| |
**Documentation Re-Organization Clean Up Tasks** | |
* Help improve the various new [[evergreen-docs:reorg:clean_up|documentation manuals]] | **Add Index Terms Throughout the Docs** |
| * [[evergreen-docs:adding_indexterms|Documentation files that are missing index terms]] |
| |
**Add Terms and Definitions to the Glossary** | **Add Terms and Definitions to the Glossary** |
* [[evergreen-docs:glossary|Glossary wiki page (draft)]] | * [[evergreen-docs:glossary|Glossary wiki page (draft)]] |
| |
| **Documentation Re-Organization Clean Up Tasks** |
| * Help improve the various new [[evergreen-docs:reorg:clean_up|documentation manuals]] |
| |
| |
===== Other Documentation Tasks ===== | ===== Other Documentation Tasks ===== |
| |
| |
| |
<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: |
</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 |
| |
| 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 ===== |
| |
* [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 |
* [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]] |
* <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]] |