Hitobito User Documentation

This is the source of https://hitobito.readthedocs.io a generic user documenation about Hitobito.

Die Benutzerdokumentation von Hitobito bringt einige Herausforderungen mit sich. So kann aufgrund der Struktur und Wagon die jeweilige Kundeninstanz unterschiedlich funktioniern. Dieser Herausforderung muss in der Dokumentation adressiert werden. Wir haben uns entschieden, gemeinsam eine generische Dokumentation zu führen welche einen Überblick von Hitobito gibt. Kundenspezifische Dokumentation und Anleitungen mit spezifischen Usecases werden durch die jeweiligen Organisation geführt.

Generische Dokumentation

• Ziel: Allgemeine Dokumentation mit einem Überblick, was Hitobito alles kann. Ohne die spezifischen Anpassungen an den Wagons.
• Zielgruppe: Personen welche mehr über Hitobito wissen wollen und einen Überblick was alles möglich ist
• Diese Doku wird gemeinsam gepflegt
• Bemerkungen oder eine Infobox falls das Modul in mehreren Wagons oft oder gross abweicht. Analog der Dokumentation der Rechnungen

Kundenspezifische Dokumentation

• Ziel: Usecase spezifische Anleitung (z.b. Wie erstelle ich als Scharleiterin ein Lager)
• Zielgruppe: Endbenutzer
• Gepflegt durch entsprechende Organisationen in ihren Hilfsmittel
• Verweis oder Kopie von der generische Doku möglich

Hier eine Sammlung von User Dokumentation/Dokumente von den Community Mitgliedern:

• Hitobito generische User Dokumentation
• SBV: Benutzerhandbuch und Erklärvideos
• Cevi: Wiki Seite Cevi.DB
• Jubla: Allgemeine Infos und Handbuch Jubladb
• PBS: Einstieg in Deutsch oder Franzöisch oder Italienisch
• Die Mitte: Wir zur Zeit noch erstellt (Mehrsprachig)

Contribute generic user documentation (this repo)

The readthedocs page is rebuilt with each merged PR. You can check whether the build was successful here. If you are unsure, you can first merge into the beta branch. This is also built and can be reached in the beta page A helpful overview over the restructured syntax that we use can be found here

Manual building:

Ensure that you have virtualenv and rake installed. Then:

rake build:all

We use transifex to translate the documentation.

Use rake sources:update to update po files and push to transifex. Next use transifex web ui for translation. With translations:update will pull from transifex and create a git commit. To update readthedocs push your changes to github.

In case the translations cannot be pulled, you need to configure transifex correctly. rake tx:status can help

Developer documentation for Hitobito

If you are looking for the docs for development of hitobito head over to https://github.com/hitobito/hitobito/tree/master/doc