User Tools

Site Tools


evergreen-docs:3.1_needs

Evergreen 3.1 Documentation Needs

Documentation needs based on the Release Notes entries that were submitted with new features during the 3.1 release cycle.

Copy the HTML code below to update the status of an item:

  • Assign yourself: <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!)

TIPS

Check Sitka's documentation, especially when documenting older features: Regular Manual and Acquisitions Manual. Also, consider adding links to their YouTube video.
There is also a rough draft of the AsciiDoc version of Sitka docs, (thanks Dan Scott!).

High level workflow for documenting new EG features

These are the high-level steps we take to document new features:

  1. Look at the new feature docs to do list (this page) and sign yourself up for documenting a new feature
    1. You will need a EG community wiki account to edit wiki pages, just email docs@evergreen-ils.org for access.
  2. Look over the release notes entry for the feature you picked and decide
    1. if the feature warrants a new section in one or more of the official manuals (http://docs.evergreen-ils.org) to explain the new feature
    2. or just a bit of new content in an existing section that is related to the new feature.
    3. Maybe what is needed is to replace an existing screenshot in the docs with a newer screenshot that shows off or demonstrates the new feature
  3. Once you decide how the new feature should be documented follow the standard steps to contribute documentation to DIG

NOTE: Sometimes you can reuse almost all of the text in the new feature release note for use in the official docs, but sometime you have to come up with significant edits to the original release notes text.

Style Guide

Bugs/Minor Problems in the Documentation

Web Client docs needs

ALL VERSIONS documentation needs (by category)

Acquisitions

Administration

Notification / Action Triggers

Credit Card Processing

Other (or not categorized yet)

API

Architecture

Cataloging

Circulation

Billing

Holds

Patrons

Self Check Out

Other (or not categorized yet)

Client

Infrastructure

Public catalog

Reports

SIP

Other Requested Documentation

  • Inventory
    • Elaine Hardy of PINES wrote some instructions that can be adapted into the official docs.
  • Patron penalty color-codes (colored border around patron name) (see Bug 1759357)
  • 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 is working on it)
  • 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?)
  • Administration
    • Local Administration
      • Copy Template Editor
      • Field Documentation
      • Group Penalty Thresholds
      • Hold Policies
      • Patrons with Negative Balances Lynn Floyd
      • Search Filter Groups
      • Surveys Lynn Floyd
      • Transit List Lynn Floyd
      • Hold Targeting and Hold Targeting script
    • Acquisitions
      • Patron Requests/Acquisition requests - Notes Gist FIXME
    • Server Administration
      • Actor Stat Cat Sip Fields
      • Age Hold Protect Rules
      • Asset Stat Cat Sip Fields
      • Billing Types
      • Circulation Matchpoint Weights - use wiki page
      • Custom Org Unit Trees
      • Global Flags
      • Hold Matchpoint Weights
      • User Setting Types [Stompro]
      • Database Backup and Restore Documentation Notes/In Progress Gist FIXME
      • Loop-Based Hold Targeting & Pickup Location Weight Notes/In Progress Gist FIXME
      • Override Permissions - need docs that explain that any event can have an override permission created.
  • Circulation

Non-Docs Tasks

  • Improve docs testing/building via the automated testing server (aka buildbot)
    • Currently, the docs are built (HTML, PDF and ePub) whenever the tests are run (every day around 6am and 6pm EST). If there is any warning or error output, it should signal a failure of the tests.
    • Ideas to improve this include:
  • Improve the PDF version of the built documentation (ask community for usage, ideas, etc.)
  • Setup/use Google analytics to improve docs website design
  • Incorporate relevant docs links into Web Staff Client screens (i.e. contextual help)
  • UI improvements
evergreen-docs/3.1_needs.txt · Last modified: 2018/04/19 15:30 by rjs7

© 2008-2017 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a member of Software Freedom Conservancy.