Koha, what is it?

How can you help?

 

Who am I?

  • Kai Tahu, Kati Mamoe, Waitaha
  • BSc Compsci, BA Maths and Māori Studies
  • One of the original Koha developers
  • Working at Catalyst IT
  • Documenation manager for the 17.11.x branch

CC-BY-SA Kristina D.C. Hoeppner

  • Started in September 1999 as a y2k fix
  • Went live January 3 2000
  • 1.0 released June 2000

What is Koha?

  •  17,776,764 lines of code (including translations)
  • 1000s of features
  • 0ver 10,000 installs
  • 50+ support companies

Anthony Mao Lins - By Permission

CC-BY-SA Ramón

Paul Poulain - By Permission

Chris Hammond Thrashor

Koha Gruppo Italiano

Delhi Public Library

Tomas Cohen Arazi - By Permission

Nicole Engard

CC-BY-SA Kristina D.C. Hoeppner

CC-BY-SA Kristina D.C. Hoeppner

  • From 4 libraries in the Horowhenua to 15,000+ around the world
  • Automating libraries never before automated
  • Facilitating access to information
  • Providing employment

That's great, but now what?

Write documentation, that's what

Sphinx

http://www.sphinx-doc.org/en/stable/

Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

Docbook XML

Sphinx

Easy - Editing with gitlab

The easiest way to contribute to the manual is making your changes using the following workflow with gitlab. You don't have to download or install anything for this to work, it can all be done in the browser!

  1. Gitlab account:
  2. Navigate manual files: Once you are logged in, you can navigate to the Koha manual on gitlab and get yourself a bit familiar with it's file structure.
  3. Start editing: Once you have located the file you want to change, you can use the Edit button on top of viewed file to start the editing process.
  4. Save your changes: Saving your changes will create a merge request to be seen by the documentation team. You can see your open merge requests on your gitlab account.

 

Check out this video for a demonstration on how to edit using gitlab!

Advanced editing

 

https://wiki.koha-community.org/wiki/Editing_the_Koha_Manual

Tasks

 

  • Fix broken links due to changes in headings and anchors
  • Fix capitalisation (should follow guidelines for the Koha interface everywhere: first word and names are capitalised)
  • Document new features
  • Document old features
  • Remove old/wrong documentation

 

https://annuel2.framapad.org/p/KohaManualTodo

Questions?