Eine gute Dokumentation für das schreiben von Redmine-plugins

Ich bin derzeit an der Entwicklung einiger plugins für Redmine, und ich muss sagen, ich bin ein wenig enttäuscht mit dem Mangel an Dokumentation zu diesem Thema.

Normalerweise, Wenn ich bin auf der Suche nach Erklärungen auf Klassen/Methoden, die ich aufbringen müssen, um eine konsistente Menge Zeit surfen durch die Kern-Klassen, und Versuch zu verstehen, den code dort geschrieben (Es scheint, dass einige Leute vergessen, um Ihren code zu dokumentieren, leider).

Habe ich überprüft Ihren Foren http://www.redmine.org/projects/redmine/boards, und es scheint, für immer zu nehmen, um eine Frage zu beantworten.

Deshalb würde ich gerne einige Ratschläge in Bezug auf einige gute API-Dokumentation/Bücher/Foren zu diesem Thema.

  • Der IRC-channel #redmine an freenode.net kann mehr nützlich für schnellere turn-around in den Antworten.
  • Wenn meine Antwort hilft bitte akzeptieren Sie als Antwort für deine Frage.
InformationsquelleAutor Rails Rider | 2011-07-18
  1. 9

    besseren Dokumentation ist die codesource. Eine der Redmine ist instandhaltern haben fast alle Redmine-plugin auf github.

    können Sie alle Plug-ins und sehen, was wie aussieht. meistens ist es über metaprogramming und alias_method_in_chain Nutzung

    • Dies kann nicht scheinen, wie die Antwort, aber Sie sparen sich eine Menge Kopfschmerzen, und glauben Sie uns, es ist. Die plugins sind eigentlich nicht so schwer zu schreiben. Gehen Sie ab von dem, was bereits geschrieben und Sie sollten in der Lage sein, um herauszufinden, wie zu tun, die meisten Dinge.
    • ja, ich kann auch nicht finden, dass ein guter 'text' Dokumentation howto schreiben-plugin für Redmine. können Sie bitte lassen Sie mich wissen, wenn Sie es finden können?
    • Ich denke da schreiben ein paar tutorials um anderen Menschen zu helfen, schneller Einstieg, als ich es Tat, sobald ich erwerben mehr Erfahrung. Wahrscheinlich werde ich den link hier posten, wenn ich Erfolg habe. Vielen Dank für die Antworten
    • Bitte Lesen Sie meine Antwort für ein neues Buch über Redmine Plugin Entwicklung
    InformationsquelleAutor Anatoly
  2. 14

    Ich weiß, das vielleicht zu spät für die ursprüngliche Frage, poster, sondern könnte helfen, jemand anderes in einer ähnlichen situation. Unten links sind für ein total Neuling (wie mich) zu RubyOnRails aber jemanden, der das programmiert bevor. Sie können wählen, und wählen Sie die entsprechende Einsen pro skill-level.

    Verständnis Redmine (Funktionalität):

    Wenn Sie nicht vertraut sind mit Redmine oder Verwaltung anderer Problem-Tracking-Software Mastering Redmine Buch ist eine ok-Platz zu starten. Es ist nicht sehr dicht gepackt so dass es dann nur helfen, die strukturierte Organisation von Informationen. Wenn Sie wollen mehr dichten Informationen gehen Sie durch die Dokumentation statt.

    Verständnis Redmine Plugins:

    "Redmine Plugin Extension and Development" von Alex Bevilacqua ist soeben erschienen (März 2014). Es ist erhältlich als print-und ebook-Formate von packtpub.

    Werde ich durch das Buch selbst, da muss ich anpassen/umschreiben ein plugin für Redmine.
    Ich bin neu in Rails/Ruby/Redmine mich. Aber ich bin von Unix/C++ - hintergrund noch kennen zu lernen, die Seile von Ruby, Rails, Redmine über die folgenden Büchern.

    Verstehen Schienen:

    Ich fand das Buch Agile Web Development with Rails, um eine ausreichend gute Einführung in Rails für Programmierer aus anderen Sprachen.

    Hinweis: Zielgruppe scheint Rails-Entwickler, aber es sollte möglich sein, um durch die Lernkurve durch das surfen github, redmine plugin repositories.

    Verständnis Ruby:

    Programming Ruby (das PickAxe-Buch)

    Verständnis Ruby Metaprogramming Idiome (in Schienen):

    Auf der Oberfläche Ruby sieht aus wie die meisten scripting-Sprachen ist die Verwendung von MetaProgramming und Dynamische Natur von Ruby Objekt-Modell, das es erlaubt, komplexe interne gymnastik unsichtbar für Neulinge.

    Einer einzigen Zeile der Rails-code enthält genug ist, solche tricks zu füllen ein kleines Buch.

    Zum Glück solch ein Buch schon geschrieben hat - Ruby MetaProgramming Buch der Pragmatische Programmierer-Serie. Es ist hervorragend zu kommen, um sich mit diesem Mixin-basierten Dynamischen MetaProgramming. Rails und Redmine verwenden viele diese tricks, wie Haken etc. um die Arbeit zu erledigen.

    Hervorragende Video-on-Ruby-Objekt-Modell von Dave Thomas

    Video-on-Ruby-Objekt-Modell und Meta-Programmierung

    InformationsquelleAutor GuruM
  3. 6

    Wie gesagt auf die redmine wiki-Seite über das plugin-hooks:

    Gibt es eine Liste der gültigen Haken. Aber der beste Weg, Sie zu finden ist einfach, einen Blick in den code zu finden, der Ort, den Sie ausbauen möchten und suchen für einen Anruf an einen Haken in der Nähe.

    Scheint es Browsen durch die Kern-Klassen zu suchen sowie bei anderen plugins ist der Weg zu gehen.

    Ich nehme an, Sie bereits gefunden, die alle in der Dokumentation auf der wiki bezüglich plugins:

    Als der Reaktivität auf das forum, können Sie versuchen, eine Frage auf die forum von chiliproject, der jüngste fork von redmine. Nicht sicher, ob, wie viel sich bereits verändert hat.

    • Redmine und ChiliProject 1.x sind ziemlich eng, wir haben versucht zu halten, Kompatibilität, so viel wie möglich. ChiliProject 2.x hat einige wichtige änderungen, vor allem rund um Zeitschriften (Schuldverschreibungen). Älterer code sollte weiterhin funktionieren, aber es muss getestet werden und portiert. Über 50% meiner plugins gearbeitet, ohne änderungen, 40% arbeiteten mit einem Gemfile für bundler und der rest braucht einige updates.
    InformationsquelleAutor marapet
Schreibe einen Kommentar