Documentation / Cookbook für Entwickler

[Sioweb]

Ho!

Aktuell werden einige Addons entwickelt und die meisten werden vermutlich die Core-Addons und den Core selbst als "HowTo" verwenden.

Gerade jetzt wäre es vorteilhaft ein Wiki / Cookbook zu starten für R5 Entwickler. Im ersten Schritt geht es mehr darum Informationen zu sammeln.

Ich stelle mir vor dass wir hier ein Gitbook erstellen: https://s4l1h.gitbooks.io/go-for-php-pr ... r/content/ Dass können alle durch PullRequests auf Github etc. erweitern. Dadurch können Entwickler ihre "entdeckungen/tricks" als PullRequest übermitteln und die Verantwortlichen Admin fügen es hinzu.

Edit: Das Gitbook wurde erstellt und auch schon gut gefüllt. Sobald es ein gewisses Volumen erreicht hat, wird Yakamara als "Owner" für Buch und Git-Repo eingetragen.

- http://book.redaxo.org/5.0/advanced/
- http://book.redaxo.org/5.0/manual/
- http://book.redaxo.org/4.6/advanced/
- http://book.redaxo.org/4.6/manual/

Kategorien können sein:

- Package.yml
-> Requires (PHP, Plugins, Packages)
-> Pages
-> Settings
- PJAX ( z.B. jQuery(document).on('ready pjax:success', function(){} )
- Plugins
-> Pages
- Extension Points
- Js/Css/Less/Sass einbinden
- Fragments / Subfragments

---

Im ersten Schritt sollten wir uns auf ein System einigen und ob sich Leute finden lassen die Redaktionell fit sind, um die eingehenden "tutorials" in Absprache mit den Entwicklern aufzubereiten. Das ganze kann unabhängig vom Core-Team entwickelt werden, damit der Core schnell weiterentwickelt werden kann.

Im zweiten Schritt werden die gesammelten Informationen sortiert und gefiltert bzw. strukturiert damit man eine brauchbare Anleitung bekommt.

Was haltet ihr davon? Hat jemand ein besseres System? Ist jemand bereit einen Workflow zu testen?

lg Sascha

[Thomas.Blum]

Hej Sascha,

ich finde die Idee sehr gut. Grad jetzt wo man die AddOns überarbeitet, kommen mit Sicherheit hier und da Fragen auf.

Gitbook wäre für mich auch ok

vg Thomas

[Oliver.Kreischer]

Super Idee!!!

[Sioweb]

Ich habe das Gitbook auf meinem Account gestartet. Ich kann weitere Autoren hinzufügen oder später dann das Buch auf einen anderen Besitzer übertragen. Aktuell bin ich hier mit meinem Github-Account verbunden: https://github.com/sioweb/redaxo

Das heißt im Prinzip kann jeder Änderungen via PullRequest vorschlagen, alternativ sicher auch hier im Forum oder via E-Mail.

[Jan.Kristinus]

Wie schon persönlich geschrieben .. Top.. Guter Startzeitpunkt. Jetzt müssen sich noch ein paar Pfleger finden .. Du bist ja schon gut dabei.

lg

[darwin]

Top Top Top. Danke.
Evtl, bin ich da gerne dabei (wenn s die Zeit zulässt).

Danke. Chris

[Sioweb]

Sehr gerne,

Hilfe ist hier sehr willkommen. Weil ich auch nicht alles Tippen kann

[Sioweb]

Ich habe die Doku nun an Redaxo weitergereicht: https://github.com/redaxo/dokumentation

Wer mithelfen will, kann entweder ein PullRequest senden, oder sich in das Doku-Team eintragen lassen um dann direkt zugreifen zu können.

http://book.redaxo.org/5.0/advanced/
http://book.redaxo.org/5.0/manual/

Am Besten meldet ihr euch einfach

lg. Sascha
@Sioweb