evergreen-docs:quickstarts
This is an old revision of the document!
Evergreen Quick Starts
This project was discussed at the 2019 Northwest Evergreen Users Symposium and Evergreen International Conference Documentation Hackfest.
Andrea Buntz Neiman thought of the name!
The goal is to meet the needs of volunteers, student workers, and others without a library background who find themselves using Evergreen. Each quickstart consists of a jargon-free video and an accompanying one-page reference sheet. Ideally, we would have a quickstart for each of the most common tasks in the library. Each quickstart would not refer to any local policies or customization, but individual libraries could definitely link to them or adapt them.
Choosing a platform
Asciidoc version proof-of-concept: example, git branch
Pros | Cons | |
---|---|---|
Asciidoc | easy to re-use existing screenshots, built-in version control, system for managing access already exists, review process already exists, open source technologies | intimidating for new contributors, not built for one-pagers, less flexible in terms of layout, no visual cue when content goes over one page |
Google docs | easy and familiar interface for contributing, lower bar for entry | Adds another technology for DIG to manage, version control might be challenging, contributors would be free to change things in ways that don't fit with our vision, not open source |
evergreen-docs/quickstarts.1559334298.txt.gz · Last modified: 2022/02/10 13:34 (external edit)