Vorwort
Wie man eine XOOPS-Dokumentation unter Verwendung von GitHub und GitBook erstellt
XOOPS war immer für einen sehr guten Code, gute Architektur und seinen modularen Ansatz bekannt, aber wir waren nie in der Lage, eine gute Dokumentation zu erstellen.
Mit den jüngsten technologischen Fortschritten, vor allem rund um GitHub, glauben wir, dass wir jetzt Werkzeuge gefunden haben, die uns helfen werden:
a) den Prozess zu rationalisieren und es effizienter zu gestalten b) die Gemeinschaft zu motivieren, da man die gleichen Verfahren "Forking und Einreichen von Pull-Anforderungen" benutzt, die jeder bereits bei den normalen Kodierungsaktivitäten verwendet.
Warum Gitbook?
GitBook ist ein Tool für die Erstellung von tollen Büchern unter Verwendung des Markdown Syntax. Es kann Deine Bücher in verschiedenen Formaten generieren: PDF, ePub, mobi oder als eine Website. Bei einen richtigen Einsatz von Github ist dies ein effizientes Tool für die Zusammenarbeit von Entwicklern und Dokumentationserstellern, das außerdem auf ein exzellentes Versionierungssystem aufbaut.
Der größte Vorteil für Opensource-Projekte wie XOOPS ist, dass jeder einen Beitrag leisten kann, indem er einfach einen Fork des Dokumentes erstellt und die durchgeführten Änderungen an das Team zurückschickt.
Ein weiterer großer Vorteil von Gitbook ist, dass es mehrsprachige Versionen in einem Verzeichnis unterstützt, und Benutzer in der Lage sind, deren Sprache zu verwenden. Da XOOPS ein internationales Projekt ist, ist uns dies sehr wichtig.
Weitere Informationen
Wenn Du mehr über Gitbook lernen möchtest, dann schau auf deren Hilfeseite oder auf deren sehr nützlichen README. Alles im Bezug auf die Arbeit und den Umgang mit Gitbook findest Du dort.
Lizenz:
Alle Derivate sind Bestandteil des XOOPS Project ( www.xoops.org )
All derivative works are to be attributed to XOOPS Project ( www.xoops.org )
Last updated
