mform
mform copied to clipboard
FriendsOfREDAXO
MForm: Upgrade auf v7.0.0 bzw. v7.0.1 werden die docs nicht gelöscht
Moin, ich stellte heute MForm von 6.1.2 auf 7.0.0 und direkt anschließend auf 7.0.1 um und bin gerade dabei die Module hochzurüsten. @skerbis meinte, dass dabei die Dokumentation eigentlich gelöscht werden sollte. Das ist sie nicht.
Slack bitte siehe hier: https://friendsofredaxo.slack.com/archives/C1BAXLN2F/p1652793179191599
Mein System aktuell: core 5.13.3 PHP 7.4.27
Jetzt habe ich direkt einen Einwand: Ich würde die Doku schmerzlich vermissen. Sie ist eine der besten in REDAXO von allen AddOns, weil bedienerfreundlich und übersichtlich. Ich kann direkt zu dem Punkt springen und kurz nachschauen, den ich im Modul umsetzen will. Die Beispiele sind eine wertvolle Ergänzung dazu, jedoch nur try&error, ständiges Hin-und Hergeklicke. Und ja: Ich programmiere nicht täglich, sodass ich wirklich immer nachschauen muss, wenn ich etwas Neues entwickle.
Heißt: Ich wünsche mir die Doku in dieser Form weiterhin. Wenn es also ein Zeitproblem ist, lasst es mich bitte wissen. Dann erhalten wir die Docs und ich werde gern versuchen, die Doku auf den neuesten Stand zu bringen, wenn ich weiß, was gemacht werden muss. Das würde allerdings etwas Zeit meinerseits benötigen und auch von Euch müsste mindestens eine Qualitätsprüfung erfolgen. Ich bin einfach zu ahnungslos, was das Programmieren angeht, als dass ich die Qualität zusagen kann ohne diese Gegenprüfung.
@madiko ich habe es als Erweiterung vermerkt. Die Pflege der Doku ist wirklich aufwändig. Vielleicht können wir aber auch die Beispiele besser kommentieren. Mal sehen.
Vielen Dank Thomas @skerbis. In meinen (begrenzten) Möglichkeiten unterstütze ich gern. Wie heißt es so schön: Durch Doku lernen wir. In diesem Fall würde ich es mir mit Eurer Unterstützung sogar zutrauen (wenn ich die alte Version als Vorbild hätte).
Ich denke wir sollten die Readme einfach um grundlegende und spezielle Dinge erweitern.
@madiko Docs wird es keine mehr geben, das ist einfach zu viel Arbeit, man könnte die Beispiele zur Doku "updaten" und da mehr Beschreibung und wie @skerbis schon meinte wäre es dann denke auch gut, wenn man in der Readme mehr grundlegendes platziert.
@joachimdoerr @skerbis als Initiatoren und Verantwortliche überlasse ich die Entscheidung Euch.
Mir ist nur wichtig: Wenn ich Euch unterstützen kann (z. B. in der Doku), lasst es mich bitte wissen. Da ich selbst am meisten davon profitiere und ich es für ein wichtiges Element in Open Source halte, dass die Nutzer:innen es leicht haben, den freien Code für ihre Zwecke zu adaptieren und einzubauen, halte ich eine gute Dokumentation für essentiell. Es gibt in REDAXO noch nicht viele Stellen, wo ich mir eine Zuarbeit zutraue. In diesem Fall schon.
Ihr habt da übrigens auch etwas davon: Weniger Nachfragen via Slack ;-)
Ungeachtet dessen: Ein (gut) dokumentierter Code ist immer Gold wert. Ein exzellentes Vorbild ist übrigens @ChristophBoecker. Sein GeoLocation AddOn ist erstklassig dokumentiert.
Vielen Dank!
@madiko da es hier auch nicht mehr weiter geht Close. Ich würde weiter auf die Code-Beispiele setzen wollen, die könnten noch besser kommentiert werden, her gerne via PR. Sonst könnte man noch auch noch in den Redaxo Tipps zusätzliche Doku und Infos platzieren.