Contao-Bootstrap Dokumentation

[webstar]

Vom 10. - 20. Februar habe ich eine Umfrage zur Verbesserung der Bootstrap-Dokumention geschaltet. Am Wochenende habe ich eure Ergebnisse ausgewertet und darauf aufbauend die weitere Vorgehensweise beschlossen.
Erst einmal auch an dieser Stelle vielen Dank an alle 20 Teilnehmer, die sich die Zeit genommen haben und vor allem die hohe Bereitschaft gezeigt haben an der Dokumentation mitzuarbeiten.

Basierend auf den Ergebnissen habe ich mich entschlossen eine Dokumentation zu starten. Die Dokumentation zuerst auf deutsch erscheinen und mittelfristig die Beschreibungen auf der Homepage ersetzen. Sie ist in reStructuredText geschrieben und nutzt Sphinx. Verwaltet wird das Projekt als eigenständiges Git-Repository. Die Dokumentation als HTML-Dokument wird auf Readthedocs.org veröffentlicht. Beweggründe dafür sind dem oben verlinkten Blog-Artikel zu entnehmen.

Mitmachen - nun wirds konkret

Ihr habt eure Bereitschaft zur Mitarbeit bekundet.

Um die Dokumentation zu vervollständigen suche ich nun konkret 1-2 Personen, die sich der Dokumentation einer Komponente/Anleitung widmen.


Mein Ziel ist so innerhalb von 8 Wochen (Mitte April) die Dokumentation weitgehend fertig zu stellen.

Einige von euch meinten, dass sie gerne mitmachen würden, aber ihnen das Schreiben nicht liegt. Kein Problem. Es werden auch Persionen benötigt, die zu der Dokumentation aussagekräftige Screenshots erstellen und zur Verfügung stellen. Außerdem werden Personen benötigt, die Gegenlesen, Verbesserungsmöglichkeiten in Formulierungen hinweisen, Rechtschreibfehler finden.

Für folgende Komponenten suche ich Freiwillige Helfer. Die Themen sind hier nach den Prioritäten der Umfrage sortiert:

Komponente	Verantwortlich	Gegenlesen	Screenshots beitragen
Core	netzmacht	netzmacht	netzmacht
Templates	noch offen	noch offen	noch offen
Formular	noch offen	noch offen	noch offen
Layout	noch offen	noch offen	noch offen
Navigation	noch offen	noch offen	noch offen
Carousel	noch offen	noch offen	noch offen
Grid-Editor	noch offen	noch offen	noch offen
Buttons	noch offen	noch offen	noch offen
Modal	noch offen	noch offen	noch offen
Panel	noch offen	noch offen	noch offen
Tab	noch offen	noch offen	noch offen

Außerdem würde ich gerne folgende Themen im Kochbuch unterbringen und suche hierfür freiwillige. Weitere Themenvorschläge sind willkommen.

Komponente	Verantwortlich	Gegenlesen	Screenshots beitragen
Bootstrap-Framework integrieren	noch offen	noch offen	noch offen
Iconset einbinden	noch offen	noch offen	noch offen
Formularwidgets unterstützen	noch offen	noch offen	noch offen

Bitte schreibt in diesem Thread wo ihr euch gern einbringen möchtet. Ich werde diesen Post dementsprechend updaten.

Wer noch nie mit reStructedText gearbeitet hat, dem muss nicht bange sein. Die Struktur ist sehr simple. Anhand den bereits eingefügten Themen könnt ihr euch leicht ein Bild davon machen, die ein Dokument strukturiert sein muss.

Für Fragen während der Dokumentation zu Internas/Details stehe ich gern zur Verfügung. Am besten ist, dass dafür entsprechende Tickets auf Github eröffnet werden.

Ausblick
Wenn alles wie erhofft anläuft, würde ich gern schauen ob wir die Dokumentation auch übersetzt bekommen. Außerdem würde ich dann gern mit denjenigen, die gerne Blogposts schreiben würden schauen, welche Themen dafür in Frage kommen.

[chrischnian]

Hallo webstar

wie schaut es mit der Doku aus?

Kann man noch wo helfen? Meine Schreibweise ist nicht das beste aber würde gerne mit helfen wenn es noch wo gebraucht wird. Kämpfe mich gerade mit Bootstrap durch und könnte so meine Fragen und Antworten klären und somit anderen auch helfen.

[webstar]

Hallo webstar

wie schaut es mit der Doku aus?

Kann man noch wo helfen? Meine Schreibweise ist nicht das beste aber würde gerne mit helfen wenn es noch wo gebraucht wird. Kämpfe mich gerade mit Bootstrap durch und könnte so meine Fragen und Antworten klären und somit anderen auch helfen.

Danke für dein Angebot zur Mitarbeit. Wie du an der Dokumentation selber und hier im Post siehst, gibt es noch viele Baustellen. Jeder Beitrag ist hilfreich. Wenn es erst einmal beschrieben ist, gibt es vielleicht auch jemand, der ggf. Ausdrucksweisen verbessern möchte...

[webstar]

Seit dem Aufruf zur Mitarbeit bis heute ist über ein Monat vergangen. Leider erfolgte bisher aus der vielfach erklärten Bereitschaft keine tatsächliche Mitarbeit an der Dokumentation. Mein Aufruf hier blieb großteils ohne Feedback.

Daher sehe ich den Versuch die Dokumentation auf mehrere Schultern zu verteilen in dieser Form bisher als gescheitert an und werde selbst keine weitere Zeit darein investieren.

Die angefangene Dokumentation bleibt vorerst weiter bestehen, Mithilfe ist weiter willkommen. Zu gegebener Zeit werde ich das weitere Vorgehen entscheiden.

[Mr. Acylase]

Hi Website,

Habe zwar noch keine Doku erstellt, aber was solls, jeder fängt irgendwann mal an. Wäre also bereit mit zu helfen.

Grüße
Stefan

[Mr. Acylase]

Hi Website,

Habe zwar ........

Ich meinte eigentlich Hi Webstar.......

Blöde Autokorrektur, Sorry!!!

[webstar]

Hi Website,

Habe zwar noch keine Doku erstellt, aber was solls, jeder fängt irgendwann mal an. Wäre also bereit mit zu helfen.

Grüße
Stefan

Hallo Mr. Acylase,

schön dass du gern helfen möchtest. Bis jetzt ist die Dokumentation eine große Baustelle, du kannst dir quasi aussuchen, was du machen willst/kannst. Gibt es einen bestimmten Bereich, an dem du mitarbeiten möchtest? Benötigst du eine Hilfestellung, wie die Dokumentation über Github geändert werden kann?

[Mr. Acylase]

Guten Morgen Webstar,

Zum "Reinkommen" würde ich erstmal den Bereich "Buttons" übernehmen wollen und mich dann nach und nach mit Dir durchkämpfen. Wäre jetzt erstmal drei Wochen im Urlaub und würde mich dann nach meinem Urlaub an die Doku dran setzten. Ist das OK für Dich?

Grüße
Stefan

[webstar]

Guten Morgen Webstar,

Zum "Reinkommen" würde ich erstmal den Bereich "Buttons" übernehmen wollen und mich dann nach und nach mit Dir durchkämpfen. Wäre jetzt erstmal drei Wochen im Urlaub und würde mich dann nach meinem Urlaub an die Doku dran setzten. Ist das OK für Dich?

Grüße
Stefan

Ja, klar. Klingt gut. Vielleicht springt ja noch jemand mit auf. :-) Melde dich einfach hier, bei Github oder im IRQ wenn du aus dem Urlaub zurück bist und Fragen hast.

[stephangunnar]

Ich habe mich auch mal aus der Deckung getraut und auf Github, mit dem ich bis jetzt noch nicht gearbeitet hatte, und da wahrscheinlich auch noch einige schwere Anfängerfehler mache, die "assets.rst" angefangen zu bearbeiten/ändern. Die Erweiterung "contao-bootstrap" selber kenne ich auch noch nicht solange, aber vielleicht doch genug anderen Anfängern den Start zu erleichtern.

[webstar]

Ich habe mich auch mal aus der Deckung getraut und auf Github, mit dem ich bis jetzt noch nicht gearbeitet hatte, und da wahrscheinlich auch noch einige schwere Anfängerfehler mache, die "assets.rst" angefangen zu bearbeiten/ändern. Die Erweiterung "contao-bootstrap" selber kenne ich auch noch nicht solange, aber vielleicht doch genug anderen Anfängern den Start zu erleichtern.

Freut mich, dass du dich daran wagst. Vielleicht ist Git/Github am Anfang gewöhnungsbedürftig, wenn man das Prinzip verstanden hat, sollte es jedoch ganz gut klappen. Im Netz gibt es viele Tutorials dazu.

Github erlaubt den Prozess "Fork erstellen -> Änderungen vornehmen -> Pull Request erstellen" auch über die grafische Oberfläche abzubilden. Entscheidend ist, dass am Ende der Pull Request gestellt wird, sodass ich die Änderungen in das eigentliche Repository übernehmen kann. Wenn du noch Fragen hast, frag ruhig.

Ich denke, dass es einem Anfänger helfen kann die Erklärung von jemanden zu lesen, der selber noch recht frisch ist und die Herausforderungen sich einzuarbeiten selber kennt.

[konabi]

Hallo Spelmann,
die Dokumentation ist in reStructuredText geschrieben und nutzt Sphinx. Verwaltet wird das Projekt als Git-Repository.
Ich denke viele werden bei der Idee an der Doku mitzuwirken davor abgeschreckt sich mit Sphinx und Git beschäftigen zu müssen.

Deshalb mein Angebot: Wenn jemand an der Doku arbeiten möchte kann er mir seinen Text und seine Screenshots zusenden.
Ich würde das ganze dann in reStructuredText umsetzen und ins Git-Repository einbringen.

Mittlerweile habe ich mal als Anfang den Grid-Editor in der Doku beschrieben:
http://contao-bootstrap.readthedocs....id-editor.html

(Sollte man das jetzt in den Bereich "Contao-Bootstrap Dokumentation" verschieben?)

Grüße Sven