Helfer gesucht für Zikula-Dokumentationsprojekt  Unten

  • Hallo zusammen,

    ich würde gerne ein Dokumentationsprojekt zu Zikula erstellen. Es sollen dabei Dokumentationen zu folgenden Themen entstehen:

    1. Zikula installieren
    2. Themen erstellen
    3. Module programmieren
    4. Lokalisierungen erstellen

    Das Projekt soll in verschiedenen Sprachen entstehen. Anfang würde Deutsch machen. Die Lizenz wäre aller Wahrscheinlichkeit nach eine Creative Commons Lizenz, wobei hier Alternativvorschläge gerne willkommen sind.

    Dokumentationen 2 und 3 wären Beispielorientiert. Wann würde also Schritt für Schritt lernen wir man ein Modul/Thema erstellt. Die Beispiele könnte man direkt herunterladen.

    Die Dokumentation würde mit Sphinx erstellt. Im vergleich zu einem Wiki hat folgende Vor- und Nachteile:

    - Das mitmachen ist etwas schwieriger (Editierung erfolgt über Github)

    +- Die Dokumentation unterliegt nicht ständigen Änderungen

    + Die verschiedenen Sprachen und Versionen (Zikula 1.2.x 1.3.x, 2.0.x) lassen sich sauber trennen. Das heist wenn man die Suchfunktion benutzt bekommt man nur Resultate von der betreffenden Version die man gerade ausgewählt hat.
    + Die einzelnen Dokumentation lassen sich sauber trennen.
    + Die Dokumentation lässt sich auch Offline verwenden.
    + Man kann auch ein richtes Handbuch als PDF erstellen.
    + Das Design ist noch flexibler wie in einem Wiki.
    + Die Dokumentation hat einen Bugtracker (github) indem man über Veränderungen diskutieren kann
    + Kleinere Serverlast.

    Hier noch ein kleiner Vorgeschmack:
    http://www.wuertz.org/zikula/module-development/de/

    Nun die Frage an euch hat jemand Lust mitzumachen?
  • Was mir immer sehr geholfen hat:
    Ein Bereich für einzelne Module, in dem ich Erläuterungen, Tipps und Tricks zu diesem Modul finde.

    Generell würde ich gelegentlich mitschreiben, mir mangelt's nur oft an der Zeit für längere Projekte.

    -.-.-.-.-.-.-.-.-.-.-.-
    Frank
  • Servus,
    Die Dokumentationsanätze gibt es ja immer wieder. Das internationale Wiki hat ja einige gute Ansätze.
    Aus meiner Sicht ist das aktuell halten, das grösste Problem. Die Entwicklung geht so schnell voran, dass 6 Monate alte Doku schon fast nicht mehr aktuell genug ist.

    Grundsätzlich würde ich mitmachen. Allerdings bin ich nicht der Entwickler, der das initial schreibt. Aber ich würde mich anbieten, die Ergüsse Korrektur zu lesen. Also das erste mal nachzumachen und Verbesserungen einzubringen.

    Die Idee ein Modul oldschool from scratch zu dokumentieren finde ich sehr cool. Die internationale Doku zeigt die Aufgabenbereiche bis hin zur Übersetzung schon ganz gut.

    Gruß Sebastian
  • btw:Hab mal auf die schnelle probiert deine Tutorial zu folgen.
    Aber der Installation schmeißt es mir nen PHP Fehler aus:

    Code

    PHP Fatal error:  class SwaTest_Installer contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (Zikula_AbstractInstaller::upgrade) in /srv/www/htdocs/intranet/modules/SwaTest/lib/SwaTest/Installer.php on line 19

    Wie man sieht hab ich nur nen sed drüber laufen lassen der mir das Modul umbenennt.

    Ein, zwei kleine Verbesserungensvorschläge hätte ich auch. Ab dem Mittelteil fehlen die Dateinamen wo du die Änderungen machst, etc.

    Gruß Sebastian
  • Ich hab die Modul-Entwicklungs-Dokumentation aktualisert. Nun lassen sich auch einige der Beispiele direkt herunterladen. Zudem gibt es auch ein Doctrine2 Kapitel.
    @Mr.Montesa In der Grundstruktur hat noch die upgrade Funktion gefehlt. Ich denke der Fehler sollte jetzt gelöst sein. Korrektur lesen wäre natürlich super. Schon im Voraus vielen Dank. Ich werde demnächst das ganze auf GitHub stellen.
  • Ich hab den Source-Code mal auf GitHub gestellt:
    https://github.com/zikula-documentation-project/module-development

    Mithilfe ist weiterhin willkommen.



    Bearbeitet von phaidon am 01. Aug 2012 - 20:14.

Diese Angaben basieren auf den Useraktivitäten der letzten 30 Minuten.