Zikula Core Dokumentation in neuem Gewand

in  Zikula Apps , ,

Zikula Core Dokumentation in neuem Gewand

Schon seit einiger Zeit werden im GitHub-Repository des Zikula Core die Dinge dokumentiert, die zusätzlich zu den Handbüchern von Symfony, Doctrine, Twig, Bootstrap usw. zu beachten sind. Nun wurde die Struktur dieser Dokumente jedoch überarbeitet und in eine Gesamtsicht gekleidet.

Themenorientiert

Frühere Ansätze von Handbüchern und Doku-Sammlungen haben oft versucht, unterschiedliche Bereiche für Entwickler und Administratoren aufzubauen. Dies hatten wir wieder versucht, sind dann aber zu der Erkenntnis gelangt, dass es zu viele Überschneidungen gibt und das Ganze vor allem unübersichtlich wird.

Daher unterteilt die neue Struktur die Dokumentation nun in verschiedene thematische Schwerpunkte: zum Beispiel findet sich unter “Access Control” alles zu Benutzern, Authentifizierung, Gruppen und Zugriffsrechten. Die Dinge, welche jeweils nur für Entwickler relevant sind, werden am Ende eines Themas in einem gesonderten Abschnitt gesammelt.

Auch auf externe Ressourcen, wie etwa Symfony-Docs oder Infos zu bestimmten Bundles, wird ebenfalls an den entsprechenden Stellen verwiesen.

Wo ist die Seite?

Die Doku-Seite ist unter der Adresse https://docs.ziku.la erreichbar.

Einfache Pflege

Da die Dokumentation aus den Markdown-Dateien im Core-Repository gespeist wird, lässt sie sich leicht ergänzen und erweitern. Es entsteht somit kein nennenswerter zusätzlicher Aufwand und die Aktualisierung der Doku erfolgt nach jeder Änderung vollautomatisch.

Was fehlt?

Wichtig war es in diesem Schritt, die Struktur so zu verändern, dass sie sowohl intuitiv als auch erweiterbar ist. Natürlich ist hier das letzte Wort noch nicht gesprochen, es ist alles im Fluss. Auch viele Inhalte sind noch unvollständig oder fehlen aktuell sogar noch komplett.

Weitere Beiträge in Kategorie Zikula Apps

Monitoring von Queues mit dem Symfony Messenger
- Der Symfony Messenger kann über unterschiedliche Transporte mit diversen Queue-Technologien eingesetzt werden, zum Beispiel AMQP, Redis, Amazon SQS oder Doctrine. Um die Messages in den Queues …
MultiPart-Requests in Symfony einfach verarbeiten
- In Symfony gibt es mit der Mime-Komponente eine komfortable Möglichkeit, MultiPart-Nachrichten zu erstellen. Nicht out of the box enthalten ist aber ein Interface, das den Zugriff auf die in …
Kommende Neuerungen in Symfony 6.1
- Gegenwärtig laufen die Arbeiten an der nächsten Symfony-Version 6.1. Wie immer gibt es regelmäßige Einblicke in die wichtigsten, zu erwartenden Features und Verbesserungen. Dieser Beitrag zeigt im …
Zikula 3 - Cross-Release und weitere Ausrichtung
- Heute sind gleichzeitig zwei neue Versionen vom Zikula Core veröffentlicht worden. Zikula 3.0.4 bringt Fehlerkorrekturen Mit der Version 3.0.4 wird ein weiteres Bugfix-Update für die Hauptversion 3 …
Kommende Neuerungen in Symfony 5.4
- Vor einigen Tagen wurde Symfony 5.4.0-BETA3 veröffentlicht. Dies nehme ich zum Anlass, um einmal einen Überblick über die wichtigsten neuen Funktionen zu geben, auf die wir uns im Rahmen dieses …