Prozesserfordernisse

Für den Erstellungsprozess einer XOOPS-Dokumentation unter Verwendung von GitBook und GitHub benötigst Du:

• Einen Account bei GitHub (http://www.github.com)

  • grundsätzliche Kenntnisse über die Verwendung der GitHub-Website

  • grundsätzliches Verständnis über die Verwendung von Git als Versionierungssystem

  • grundsätzliche Kenntnisse über Markdown

• Einen Account auf GitBook (http://www.gitbook.com)

  • um mehr über GitBook zu erfahren, lies bitte diese Veröffentlichung

Erstellen eines GitHub-Verzeichnisses für das Buch

Es gibt zwei Möglichkeiten, wie Du zu einer XOOPS-Dokumentation beitragen kannst:

a) Erstelle einen Fork (Zweig) von einem existierenden Buch/Tutorial

Um dies zu erreichen, gehe zu einem bestehenden Tutorial auf GitHub XOOPS Docs, und erstelle einen Fork (Zweig), indem Du auf die Schaltfläche Fork klickst: (screenshot)

• Benenne das Verzeichnis so um, wie Du dies gerne haben möchtest:

  • Klicke auf Einstellungen auf der Übersichtsseite Deines Fork-Verzeichnisses (durch das Forken wird eine Kopie des Originalverzeichnisses unter Deinem Namen erstellt). (screenshot)

  • Wenn gewünscht, dann benenne den Namen Deines Verzeichnisses um (screenshot)

• Wenn Du das Dokument lokal bearbeiten möchtest, dann klone Dein Verzeichnis auf Deinen Rechner. Für Windows-Benutzer steht GitHub for Windows zur Verfügung, welches sehr hilfreich sein kann. Du must nur auf die "Klonen"-Schaltfläche klicken, und GitHub übernimmt den Rest für Dich.

  Natürlich kannst Du auch Deine persönliche Art der Interaktion mit Git verwenden, inklusive der Verwendung von Kommandozeilen.

b) Erstellen eines vollständig neuen Buches/Tutorial

• Du kannst auch mit dem Schreiben eines vollständig neuen Buches/Tutorials beginnen, indem Du ein neues Verzeichnis in Deinem Account erstellt.

• In diesem Fall empfehlen wir die Verwendung des "XOOPS Documentation Starter Kits", das bereits die vordefinierte Projektstruktur besitzt und alle erforderlichen Dateien enthält, sodass es viel einfacher für Dich wird, einfach loszulegen.

  Weitere Informationen findest Du außerdem im letzten Kapitel dieser Dokumentation.