Migration der Dokumentation auf das neue Format

[bastians]

Die Dokumentantion ist aktuell noch in dem älteren *.swx Format und sollte umgestellt werden auf das aktuelle reST-Format.

Links:

• https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/Index.html
• https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual

[bastians]

@digedag Wie angekündigt, bin ich da gerade dran und sollte demnächst ein PR dazu erstellen. Primäres Ziel ist es, die aktuelle Dokumentantion zu migrieren, inhaltlich passe ich da noch nicht viel an. Das wäre dann ein zweiter Schritt.

[digedag]

Hey @bastians ,
ganz ehrlich, das ReST Format finde ich nicht gut. Normales Markdown ist für eine Doku vollkommen ausreichend. Im TER wird dann einfach die externe Doku hier auf Github verlinkt...

[bastians]

@digedag Oh. Dann haben wir uns missverstanden.

Aber Markdown und ReST sind eigentlich relativ ähnlich von der Markup-Sprache. Der Vorteil von ReST wäre, dass man die Dokumentantion schön gerendet bekommt und sich dadurch besser zurecht findet.

Hier mein aktueller Stand: https://github.com/bastians/cfc_league/tree/Documentation-update-to-new-format/Documentation

Kann das stoppen, dann waren nur einge Stunden Arbeit bisher umsonst.

[bastians]

@digedag Soll ich das dann nun als reines Markdown umsetzen?
Oder wäre auch das Repo-Wiki eine Variante (auch Markdown)? Dann würde die Dokumentation aus dem Code fliegen, man könnte aber in der Readme darauf verweisen. Und für das TER kann man externe Doku-Links ja definieren.

[digedag]

Also mir nützt nur Markdown etwas, denn nur da würde ich dann auch mal weiter dokumentieren. Markdown wird überall unterstützt und ist für so eine kleine Doku genau richtig. :-)