search

hitobito / user_documentation

User Documentation for hitobito to be featured on the website.
https://hitobito.readthedocs.io/
GNU Affero General Public License v3.0
3 stars 14 forks source link

Mehr liebe für die user docu #41

Open olibrian opened 9 months ago

olibrian commented 9 months ago

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 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

Zu beachten/Weiteres:

olibrian commented 9 months ago

Readthedocs wurde im PR #42 gefixed. Github Pages wird somit auch verworfen.

olibrian commented 9 months ago

Zur Schnittstelle github zu Transifex fand ich folgende Möglichkeiten:

ich habe mal transifex angeschrieben, was sie uns empfehlen..

olibrian commented 9 months ago

Bilder sind jetzt in diesem Repo #44

olibrian commented 9 months ago

Antwort von Transifex: Hello,

Unfortunately, Transifex does not support RST files. However, Transifex does support a variety of file formats. Please refer to the documentation to see if you can convert your content to any of the supported formats.

If your project is stored in a GitHub repository, the most straightforward way to load it to Transifex is by using our GitHub integration, feel free to take a look at the documentation and let me know if you have any further questions or concerns.

Best regards,

Sandy De la Rosa | She, Her, Hers | Customer Success Engineer ​Blog | We are hiring | Join Our Community

olibrian commented 7 months ago

Ich würde vorschlagen den Weg mit der Connect Transifex to gitub weiter zu verfolgen. Hier ist jedoch das Problem, dass Transifex keine RST Files unterstützt. Es besteht die Möglichkeit die RST files zu MD zu migrieren.

Vorgehen:

olibrian commented 7 months ago

Aktuell laufe ich auf dem Holzweg. Migration war erfolgreich und build läuft bei readthedoc. Synchronisation zu Tranisfex Testprojekt (nicht dass ich die bestehende Übersetzung überschreibe) funktioniert auch in beide Wege. Die Übersetzung ist aber aktuell noch leer, da Transifex die Inhalte nicht abgleichen oder empfehlen kann. Weiter verweist readthedoc nicht auf die Übersetzten md files sondern kann soweit ich gelesen habe nur po files für die Übersetzung brauchen.. :-(

olibrian commented 7 months ago

Aktuell müssen die Übersetzungen nach wie vor via rake vorgenommen werden. Beschreibung ist hier: https://github.com/hitobito/user_documentation#contribute-generic-user-documentation-this-repo

olibrian commented 7 months ago

Erster Entwurf mit github action ist im Branch am entstehen..