Koha Documentation Team

The Koha Documentation Team is responsible for maintaining and improving the official documentation for the Koha community.

We welcome new participants and invite anyone interested to attend meetings, volunteer for tasks, and join the koha-docs mailing list.

About the Documentation Team

How to contribute
Meetings: previous meetings ~ next meeting
Office hours (experiment, Fridays, 17:00 UTC)
Documentation plan
Roles and participants

Documentation

To do lists and projects

To do lists

Documentation tasks are now managed in Bugzilla.

Documentation tasks
Manual keyword: 21.11 | 22.05
Tracking of release changes (see linked spreadsheets with all changes pushed, and identifies doc changes required): 21.11 ~ 22.05

Easy, medium and hard tasks

Easy tasks to get started with. Relatively easy things to fix, such as formatting, capitalisation, or typos.
- Academy documentation tasks: in Bugzilla this keyword is used to identify relatively straight forward tasks (and is also a two week event normally held annually in Wellington, NZ to teach high school students about free and open source software)
- Bug 27382 - [DOCS] [Omnibus] Spelling errors in the manual: links to individual tasks are under 'Depends on'
- TO ADD

Medium tasks to get started with. Things like enhancements where updates to existing content is required, new system preferences, updating screenshots, updating lists and reference information. Some work is required to figure out what needs updating or how it works, but generally it is straight forward to update.
- System preference changes - new preferences or need updating because of changes
- Mana knowledge base section - new feature in 19.05: Bug 17047
- New features for releases:
  - 20.11
  - 21.05
  - 21.11
  - 22.05
- TO ADD LINKS

Hard tasks include new sections, new features, and reviewing a sections. Will need to do some planning to work out what is required - including identifying tasks and reference material to develop. Or it might be a complete rewrite or edit!
- TO ADD

Section reviews

If you have experience in a particular area and intend to review the complete section, create a documentation task in Bugzilla and link to it from here.

Installation section/guide (David)
.. add the section and your name here ..

Projects

Projects about improving how we manage and deliver our documentation:

29712 - Content development guide
29714 - Git guide for documentation
29716 - Automated screenshots
Installation guide
Getting started guide
Reorganising manual contents
23073 - Wiki update
Add how-to's at the end of each chapter with common workflows
Create a landing page with links to common sections

Content development guide

Draft outline (WIP)
Current content:
- Editing the Koha Manual
- ReStructuredText - Tips and Tricks
- Translating the Koha Manual
- Koha Manual - more technical information about how the manual is generated
- Git guide for documentation - Quick reference guide for those new to Git and who are not developers
- Terminology
- Documentation management

Contents