Verbesserung "Guide for adapter developers"

[Mic]

Hi,

ich denke, wir müssen unbedingt den Guide for adapter developers verbessern, also DIE Dokumentation für alle Adapter-Entwickler.

Jeder von uns hat wenig Zeit. Mein Ansatz wäre also was "schlankes", ähnlich wie man das von Wikipedia kennt, wo man auch nur mal Typos schnell ausbessert. Also: man nutzt gerade z.B. eine Funktion, hat sie soweit verstanden, und geht dann direkt zu dieser Doku-Datei und und verbessert die Beschreibung dieser einen Funktion.

Die Doku für den JS-Adapter finde ich ziemlich gut und ausführlich, Beispiel. Ich denke, das kann man gut mit berücksichtigen.

Frage: Stört es, wenn dann in kurzen Intervallen mehrere Pull Requests kommen für einzelne Verbesserungen? Ich habe halt einen Arbeits-Workflow wie folgt: ich entwickle gerade an einem Adapter, stelle fest, die Doku gibt das nicht her, ich helfe mir selbst, und würde jetzt gerne das auch in die Doku schreiben, z.B. also eine einzelne Funktion kommentieren.

Erst mal sammeln bekomme ich nicht auf die Reihe, und irgendwie muss man ja mal anfangen.

Würde aber dann bedeuten, dass es dann z.B. für ein paar einzelne Funktionen (siehe Functions) dann schon mal detaillierte Beschreibungen gibt, und am Anfang für alle anderen dann nicht.

Ich persönlich sehe die größte Baustelle in der Beschreibung mancher Functions und wann/wie man diese verwendet. Siehe z.B. hier - falsche Verwendung von delForeignObject() und @apollon77 empfiehlt delObject() (it would be better and more secure if you use delObject instead of delForeigObject here).

Ich würde auch nach und nach Infos für VS Code Bedienung etc. hinzufügen, nur halt "nach und nach", und nicht gleich eine Komplett-Lösung.
Aber das gibt dann einige Pull-Requests.

Meinungen? Vorschläge?

Danke

[apollon77]

@Mic Her mit den Pull Requests

[Mic]

@apollon77 sagte in Verbesserung "Guide for adapter developers":

@Mic Her mit den Pull Requests

Cool, gerne. Folgen dann nach und nach

[Garfonso]

Finde ich eine super Idee.

[Mic]

@Garfonso

Geht nur leider zäh voran. PR #244 zieht sich nun schon seit 17 Tagen ohne Response trotz Erinnerungen.

Wohl sicherlich dem Fokus auf den neuen js-controller 3.x geschuldet, aber so macht mir das nicht wirklich Spaß, mich hier in der Doku aktiv einzubringen, wenn kleine Änderungen schon so lange dauern. Und das geht jetzt bitte nicht gegen apollon, sondern es scheint, dass es an Personal-Ressourcen fehlt für die Reviews...

Ich bin auch gerne bereit, bei den Reviews zu unterstützen, aber dafür reicht meine Adapter-Entwicklungserfahrung wohl noch nicht. Aber einen dritten Adapter werde ich alsbald angehen

[apollon77]

@Mic am besten mich direkt hier nochmal Poken. Jupp geht aktuell viel Zeit beim Controller drauf. Schaue nachher nochmal.

Also daran soll Unterstützung nicht scheitern!!

[Mic]

@apollon77 sagte in Verbesserung "Guide for adapter developers":

@Mic am besten mich direkt hier nochmal Poken. Jupp geht aktuell viel Zeit beim Controller drauf. Schaue nachher nochmal.

Also daran soll Unterstützung nicht scheitern!!

Cool, danke

[apollon77]

@Mic merged. Und in zukunft ... mich einfach öfter treten

[Mic]

@apollon77 sagte in Verbesserung "Guide for adapter developers":

@Mic merged. Und in zukunft ... mich einfach öfter treten

Danke Ingo. Aus Wertschätzungsgründen für deine Arbeit hier bin ich wohl zu wenig penetrant