hitobito / hitobito/user_documentation

Mehr liebe für die user docu

Open
#41 8 comments 0 reactions 0 assignees View on GitHub
tech
Dominant language
Ruby
Stars
3
Forks
13
Avg merge
5d 56m
Merged PRs (30d)
1

Description

# Ausgangslage
Die Userdoku hat einige technische Probleme so schlägt der Build fehl und die Übersetzungen müssen manuell von einem technisch versierten User aktualisiert werden. Transifex soll weiter verwendet werden, da hier bereits die Übersetzungen von Hitobito vorhanden sind.

Hier einige Diskussionsgrundlagen

## Transifex Plugin verwenden
Transifex biete ein [github Plugin](https://github.com/apps/transifex-integration) welches die Kommunikation zwischen github und transifex übernehmen würde. Dadurch automatisiert sich der Prozess und wird hoffentlich etwas robuster.

## Readthedocs deployment sicherstellen :heavy_check_mark:
Aktuell schlägt der Build fehl und die Seite https://hitobito.readthedocs.io/ wird nicht mehr aktualisiert. Die Jubla hat das gleiche Problem: https://github.com/hitobito/user_documentation/issues/34. Anstelle viel Aufwand fürs fixen zu investieren könnte passend zu Hitobito 2.0 die Seite komplett neu erstellt werden und die bestehenden Texte (inkl Übersetzungen) übernommen werden.

## Alternative: Github Pages verwenden :x:
Anstelle der readthedocs.org könnte die Seite auch direkt mit github pages gebaut werden. Nach meiner kurzen Recherche müssen Rst files zu md konvertiert werden und Übersetzung geklärt werden. Mögliches jekyll-locale [Plugin](https://github.com/ashmaroli/jekyll-locale)

## Zu beachten/Weiteres:
* Bei einer Umstellung darauf achten, dass die bereits bestehenden Übersetzungen nicht verloren gehen.
* Gewisse Bilder sind noch bei https://content.screencast.com/users/RolandStuder/folders/Jing/media/* :heavy_check_mark:
* Schön wäre es noch ein redirect von docs.hitobito.ch zu haben.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.