Skip to content

hitobito/user_documentation

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
.tx
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Hitobito User Documentation

Maintenance Documentation Status GitHub

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:

Contribute generic user documentation (this repo)

This will be built with https://readthedocs.org/

A helpful overview over the restructured syntax that we use can be found here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Manual building:

Ensure that you have virtualenv and rake installed. Then:

rake build:all

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