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 6.2.7 korrigiert CSRF-Problem im SecurityBundle
- Am ersten Februar, also vor genau einem Monat, wurden mit Symfony 6.2.6 zwei Sicherheitsprobleme adressiert. Ein Patch im SecurityBundle hatte allerdings auch valide Use Cases gebrochen, wie zum …
Flexible Tabellenspalten im EasyAdminBundle
- Vor kurzer Zeit haben wir das EasyAdminBundle (EAB) in die Entwicklungsversion von Zikula 4 integriert um das alte Admin-Interface abzulösen. Seitdem beobachten wir natürlich stets, was sich bei …
Kommende Neuerungen in Symfony 6.2
- Gegenwärtig laufen die Arbeiten an der nächsten Symfony-Version 6.2. Wie immer gibt es regelmäßige Einblicke in die wichtigsten, zu erwartenden Features und Verbesserungen. Dieser Beitrag zeigt im …
Zikula 4 - Ansätze für ein leichtgewichtigeres User Management
- Im Rahmen der Schlankheitskur vom Zikula Core sind einige Altlasten bereits entfernt worden. Das Admin-Interface baut nun auf dem EasyAdminBundle auf. Ein größerer Knoten, den es noch zu entwirren …
Zikula 4 und ModuleStudio - Weitere Integration mit dem EasyAdminBundle
- Im letzten Beitrag wurde unter anderem dargestellt, dass Zikula 4 nun das EasyAdminBundle (EAB) integriert um das alte Admin-Interface abzulösen. Zwischenzeitlich sind die Arbeiten daran etwas …