User Tools

Site Tools


evergreen-docs:documentation_needs

Evergreen Documentation Needs

High level workflow for documenting new EG features

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

  1. Look at the to do list below and sign up for a task
    1. Need a wiki account? Just email docs@evergreen-ils.org for access.
  2. Review the release notes entry for the feature (or the details on the Launchpad bug, if applicable)
    1. It may warrant a new section in one or more of the official manuals (http://docs.evergreen-ils.org)
    2. It may fit within an existing section
    3. It may only require updating a screenshot
    4. You may be able to simply copy the release note into the appropriate section
  3. Make corrections in any format (perhaps by editing on GitHub) and share with the community (perhaps via the email list)

Style Guide

EASY Tasks for New Contributors

Add Index Terms Throughout the Docs

Bitesize (simple) documentation bugs on Launchpad:

Update references to XUL for web client

Other Documentation Tasks

TIPS

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

Features Needing Documenting, 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:

  • 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!)

Acquisitions

Administration

Notification / Action Triggers

Credit Card Processing

Installation / Upgrade / Build / Translation

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

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?)
  • 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

  • Incorporate relevant docs links into Web Staff Client screens (i.e. contextual help)
  • 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
  • UI improvements
evergreen-docs/documentation_needs.txt · Last modified: 2018/05/22 10:50 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.