This is an old revision of the document!
Evergreen Documentation Needs
High level workflow for documenting new EG 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
- Need a wiki account? 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 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 email list
- Learn more about ways to contribute your changes
EASY Tasks for New Contributors
Bitesize (simple) documentation bugs on Launchpad:
Pull Requests ready for review
Add Index Terms Throughout the Docs
Add Terms and Definitions to the Glossary
Documentation Re-Organization Clean Up Tasks
Other Documentation Tasks
Check Sitka's documentation, especially when documenting older features:
Also, consider adding links to their YouTube videos
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 initial idea.
Here's a list of the guides we think we need. Feel free to add more!
Adding call numbers and items to a bibliographic record.
Undocumented Features/Changes, Taken From Release Notes
Many of these will be easy changes. Some will need no changes at all.
Copy the HTML code below to update the status of an item:
<html><span style="color:blue;font-weight:bold">[your name]</span></html> ([your name])
Add a status:
<html><span style="color: green;font-weight: bold"> COMPLETE!</span></html> (COMPLETE!)
Notification / Action Triggers
Credit Card Processing
Installation / Upgrade / Build / Translation
Integration with other software
Other (or not categorized yet)
Borrow from Shared Docs
Other Requested Documentation
Cataloging (needs to be reorganized)
Intro to SQL (Based on Dan Scott content) Yamil still needs to make some edits like proper attribution, and test that its addition does not break the full docs
Library Settings Editor - (Lynn Floyd, SCLENDS)
OpenSRF/Evergreen Installation Guide (two PDFs linked from email below, useful but need updating)
Archiving of Circulation Transactions (new section)
Addresses on Routing List (missing?)
Wrong Cover Art, and what to do.
Actor Stat Cat Sip Fields
Age Hold Protect Rules
Asset Stat Cat Sip Fields
Custom Org Unit Trees
Hold Matchpoint Weights
User Setting Types [Stompro]
Override Permissions - need docs that explain that any event can have an override permission created.
Incorporate relevant docs links into Web Staff Client screens (i.e. contextual help)
Improve docs testing/building via the automated testing server (aka buildbot)
Improve the PDF version of the built documentation (ask community for usage, ideas, etc.)
Setup/use Google analytics to improve docs website design