Contao-News

Wir informieren Dich hier regelmäßig zu Updates, stellen Best-Practice-Arbeiten vor und berichten über Aktuelles aus dem Contaoversum.

Status Quo der Dokumentation

von

Letzten November haben wir die neue Contao Dokumentation angekündigt und es wird Zeit, ein paar Worte darüber zu verlieren und dadurch hoffentlich weitere Helfer mit ins Boot zu holen.

Leute, die Dokumentation gedeiht prächtig! Höchste Zeit, eure eigenen, unternehmensinternen Dokumentationen über Bord zu werfen und gemeinsam an der offiziellen Dokumentation zu arbeiten!

Du glaubst mir nicht? Mal sehen, welche Leckerbissen ich für dich finden kann:

Anwenderdokumentation in Englisch

Endlich! Die Anwenderdokumentation wurde diese Woche komplett ins Englische übersetzt. Dies geschah maschinell und es gibt einiges nachzubessern! Wenn du der Englischen Sprache mächtig bist, hilf uns bitte, die ganzen Artikel zu korrigieren, so dass auch die englische Anwenderdokumentation so schnell wie möglich in vollem Glanz erscheint! Sag es auch all deinen Mitarbeiterinnen, Kolleginnen und Freunden, die eine englische Dokumentation so schmerzlich vermisst haben.

Neues in der Anwenderdokumentation

Seit der Einführung der Dokumentation wurden hunderte Fehler behoben und auch ganz viele neue Kapitel ergänzt. Ein kleiner Auszug gefällig?

  • Die Systemanforderungen wurden sauber dokumentiert.
  • Wir verfügen mittlerweile über einen sehr ausführlichen Bereich zur Performance, wo du erfährst, wie du dein System für Contao optimieren kannst und wie du das clevere Caching-Framework von Contao zu deinem Vorteil nutzt.
  • Wir haben neue Anleitungen zur lokalen Installation von Contao; egal ob mit der Docker Devilbox oder Laragon, der Betrieb ist dokumentiert. Du hast eine andere Methode und denkst, die könnte von Nutzen sein? Schreib's auf!
  • Wusstest du, dass Contao 4.10 auch neue Insert Tags mit sich bringen wird? Alles bereits dokumentiert!
  • Den WYSIWYG-Editor TinyMCE kannst du individuell auf deine Bedürfnisse anpassen. Wie das geht, zeigt dir die entsprechende Anleitung!
  • Schon gewusst? Die Zweifaktor-Authentifizierung lässt sich auch im Backend für alle Benutzer erzwingen. Welche Konfiguration dazu nötig ist, weiss die Dokumentation.
  • Die Nutzung von SASS und Grids wurde dokumentiert. Schweben deine Kacheln immer noch unkoordiniert auf der Webseite rum?
  • Wir treffen uns regelmässig zu öffentlichen Contao-Calls bei denen das Contao Core-Team aktuelle Tickets bespricht. Vielleicht hörst du mal rein oder hast eine Frage? Du bist jederzeit herzlich willkommen! Die Anleitung zur Installation von Mumble befindet sich natürlich auch in der Dokumentation.
  • und vieles, vieles mehr!

Neues in der Entwicklerdokumentation

  • Wusstest du, dass Contao den Workflow für Tickets auf GitHub dokumentiert hat? Oder dass wir über ein Versprechen zur Rückwärtskompatibilität verfügen?
  • Alle Contao Hooks und Events sind vollständig dokumentiert. Vielleicht möchtest du mal darin stöbern und entdeckst plötzlich ganz neue Wege, eine gewünschte Funktion umzusetzen?
  • Contao lässt sich durch diverse Umgebungsvariabeln steuern. Insbesonders wenn du Contao im Umfeld der Contao Managed Edition nutzt. Diese Umgebungsvariabeln sind dokumentiert, aber weisst du eigentlich, warum es die Contao Managed Edition gibt und in welchem Zusammenhang sie zu Symfony und dem Contao Core-Bundle steht? Die Dokumention klärt dich darüber auf und enthält ausserdem eine Vielzahl an Beispielen, wie du mittels des Contao Manager-Plugins in die Managed Edition eingreifen kannst!
  • Bildbearbeitung ist ein komplexes Thema, gerade wenn es um Responsive Images geht. Contao verfügt hier über etliche Helferlein und auch Contao 4.10 bringt mit dem neuen Image Studio wieder einiges an Developer Experience. Das alles kannst du schon heute nachlesen!
  • Seit Contao 4.9 verfügen wir über ein Migration Framework. Nutzt du immer noch die gute alte runonce.php? Dann sei dir ein Blick in die Dokumentation ans Herz gelegt!
  • und vieles, vieles mehr!

to.contao.org

Schon gewusst? Seit ein paar Wochen verfügen wir über einen eigenen Kurz-URL-Dienst to.contao.org.

Vielleicht ist dir etwas im Contao Backend aufgefallen, was schön zur Contao Dokumentation verlinkt werden könnte? Dann wäre das bestimmt eine gute Wahl. In Aktion siehst du den neuen Dienst übrigens weiter unten im PS.

Du siehst, die Contao Dokumentation wächst stetig weiter!

Für mich persönlich ist sie sogar wichtiger, als so ziemlich jedes Feature, das wir seit November 2019 in Contao selbst eingebaut haben. Denn was nützt einem das tollste Feature der Welt, wenn keine(r) weiss, wie man es nutzen kann?

So und jetzt tue Gutes und schreibe darüber! Wo sollte ja mittlerweile klar sein.

PS: Bei Fragen zur Dokumention oder dazu, wie du mithelfen kannst, findest du am schnellsten Unterstützung im Contao Slack-Channel #docs!

Zurück zur News-Übersicht.

Kommentare

Einen Kommentar schreiben

Bitte rechnen Sie 6 plus 3.