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

Symfony Messenger - Behandlung erneut fehlgeschlagener Nachrichten
- Im Symfony Messenger gibt die Möglichkeit, fehlgeschlagene Nachrichten an eine failed queue zu leiten. In diesem Sammelbecken können diese dann inspiziert und nach Korrektur des zu Grunde liegenden …
Response-Eigenschaften im Zikula Theme-Layer anpassen
- In Zikula gibt es eine Besonderheit zu beachten, welche Einfluss darauf nimmt, wie die aus einem Request resultierende Response zum anfragenden Client gelangt. Per Standard wird die Response in …
Tabellennamen mit Doctrine dynamisch anpassen
- Mit Hilfe der Metadaten von Doctrine lassen sich jegliche Daten zu einer Entität zur Laufzeit verändern. Allerdings kann das in manchen Anwendungsfällen fortwährend notwendig sein, zum Beispiel in …
Kommende Neuerungen in Symfony 5.2
- Vor zwei Tagen wurde Symfony 5.2.0-BETA2 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 Updates …
Zikula Core 3.0.3 mit Sicherheits-Update von Symfony 5
- Vor kurzem hatten wir über das Release von Zikula 3.0.1 berichtet, welches wichtige Korrekturen für Zikula 3 bereitgestellt hat. Vor einer Woche wurde die nächste Version 3.0.2 veröffentlicht. …