Document all the things!
Not in the manual? You can change that!
This sphinx is not talking in riddles!
AKA
AKA
Chris
- One of the original Koha developers
- Work for Catalyst IT
- Current member of the QA team
- @ranginui, chrisc@catalyst.net.nz
Katrin
- Working on Koha since 2008
- Works for BSZ
- Currently QA manager
- katrin.fischer@bsz-bw.de
Before: DocBook
- XML
- One big file
- Hard to edit
- Required XML editor
- Easy to break
Now: Sphinx (17.05+)
-
reStructured Text
-
Easy to provide different formats:
HTML, PDF, epub -
More modular,
multiple smaller files -
Easy to read
-
Requires no software for editing
-
Hard to break
Demo!
Translations
A big
THANK YOU
to all writers and translators!
How can you help out?
- File bugs for documentation issues (component: Documentation)
- Attend Documentation IRC meetings
- Be a manual writer!
https://wiki.koha-community.org/wiki/Editing_the_Koha_Manual - Be a manual translator!
https://wiki.koha-community.org/wiki/Translating_the_Koha_Manual
Document all the things! Not in the manual? You can change that! This sphinx is not talking in riddles! AKA AKA