evergreen-docs:reorg:clean_up
Table of Contents
Documentation Re-Organization Clean Up
DIG is moving the community documentation to a new structure for 3.0. This page is for tracking the clean-up needed after the initial split of the documentation into new books. Sign up to check a book, or section of a book!
ALL MANUALS
- Manually create unique section anchors for every section heading (down to H3, which usually means AsciiDoc headings with an underline of
^^^^
) - Convert all internal links from auto-created anchor names to the manual equivalent (which usually means renaming links from
_section_name
tosection_name
, if we follow that convention)
Local Library System Administrator
- Add more step-by-step information about setting up credit card payments.
- Add information about negative balances
- Add information about age-to-lost
Fill in the library hours and closed dates information under "Library closures"- More detailed information about report templates that contain call numbers
- Troubleshooting guide for circulation policies
Command-line System Administrator
- Best practices for making .tt2 changes upgrade-friendly (like using Git for version control)
- Best practices on what features to enable first, and which can wait
- More insights about the database schema
Circulation Desk Staff
- Add a brief glossary: copy/item, volume, MARC record
- Suggestion: add documentation for running reports based on pre-existing templates
Add chapter "Using the Public Access Catalog" (from book "Public Catalog")- done!Add most of chapter "Self checkout" (from book "System administration from the staff client")- done!
Cataloguing Staff
- Add a brief glossary: copy/item, volume, MARC record
Add chapter "Using the Public Access Catalog" (from book "Public Catalog")- done!Add a chapter about record buckets, including the query syntax
Acquisitions Staff
Add chapter "Using the Public Access Catalog" (from book "Public Catalog")- done!- Add most of chapter "Ordering materials" (from book "System administration from the staff client")
Serials Staff
Add chapter "Using the Public Access Catalog" (from book "Public Catalog")- Done!
Integrating Evergreen With Other Tools
Public Catalog
- Add a chapter "Catalog data on social media" about open graph protocol in catalog records
All Manuals
- On PDF version, include the name of the manual and the Evergreen version on every page, either in header or footer
- Also, the filename should include the name and version (instead of the current name "Evergreen_Documentation.pdf")
- On HTML version, include breadcrumbs, TOC, or some other navigational help to each page
evergreen-docs/reorg/clean_up.txt · Last modified: 2022/02/10 13:34 by 127.0.0.1