Versionierte Dokumentation + Read the docs

#1

Hallo zusammen,

um die bestehenden textlichen Inhalte von von dem nicht mehr betreuten http://co-munity.net/ wegzuholen würde ich gerne eine auf reStructuredText basierende Dokumentation im GIT aufbauen. Wir hätten somit eine versionierte Doku und Read the Docs würde uns das dann in untersch. Ausgabeformate rendern.

Alternativen: @yala nutzt, soweit ich weiß, gerne HackMD, das ist jedoch meines Erachtens eher als Notizzettel-Sammlung geeignet Das Gitlab-Wiki ist von der Usability her nicht sonderlich zugänglich für Außenstehende, finde ich – ebenso Dokumente in der Cloud. Und in TYPO3 möchte ich nun auch keine mehrere Seiten umfassende Doku aufbauen, wenn wir davon weggehen.

Eure Gedanken dazu?

Liebe Grüße,
Micha

#2

Ich bin mit DokuWiki sehr glücklich. Bei uns ans OpenLDAP angeschlossen. Hat die Versionierung ja quasi build-in (man muss nicht vom Dokument in die Dokumente-Versionierung wechseln wie es bei read the docs und gitlab wäre) und hat ein paar nette andere plugin-möglichkeiten.
Auf der anderen Seite ist rst und readthedocs sicher nicht verkehrt, aber editieren für außenstehende ist doch da auch nicht drin oder?

1 Like
#3

Ich bin mit DokuWiki sehr glücklich. Bei uns ans OpenLDAP angeschlossen. Hat die Versionierung ja quasi build-in (man muss nicht vom Dokument in die Dokumente-Versionierung wechseln wie es bei read the docs und gitlab wäre) und hat ein paar nette andere plugin-möglichkeiten.

Ja DokuWiki wäre auch eine Option, ich mag das Teil ja auch :slight_smile: Ich wollte halt eher auf neue Software verzichten, da die ebenfalls wieder gewartet werden muss – und DokuWikis Update-Zyklen sind schon recht eng getaktet, auch wenn man natürlich nicht jedes mitmachen muss. Und wenn wir tatsächlich mal unsere SSO-Lösung hinbekommen sollten muss man jede neue Software wieder da mit reinfummeln …

Auf der anderen Seite ist rst und readthedocs sicher nicht verkehrt, aber editieren für außenstehende ist doch da auch nicht drin oder?

Naja, über nen eigenen GitLab-Account schon. Allerdings ist die Sphinx-Syntax jetzt sicherlich nicht die eingängiste, die Einstiegshürde für andere, ebenfalls zu dokumentieren wäre also eher hoch, schätze ich. Und wenn nur ein, zwei Hansel dokumentieren wäre die Ressourcen-Verteilung wieder ungleich verteilt …

Liebe Grüße,
Micha

#4

Finde das eine gute Idee, hab zwar noch nicht weiter in “readthedocs” rein geschaut, aber es braucht ja anscheinend echt nur ein Git Repo, und ein paar Textfiles dazu.

Super wenn du darauf Bock hast! Im bisherigen Arbeitsfluss ist es meist schon aufwändig genug ihn halbwegs in pads und issues zu loggen. Bei manchen Themen würde sich das allerdings vielleicht lohnen, wie angepasste Nextcloud deployments, und vor allem das angepeilte SSO setup. Solawi finde ich dafür dann allerdings nicht den passenden Rahmen, eher ecobytes, oder indiehosters.