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

Zikula Framework in Version 3 veröffentlicht
- Heute haben wir das finale Release von Zikula Core 3.0.0 veröffentlicht. Es basiert auf Symfony 5.1 sowie Twig 3 und verwendet unter anderem Bootstrap 4 und Font Awesome 5. Einen grundlegenden …
Zikula 3 erscheint als Release Candidate
- Heute wurde der erste Release Candidate für Zikula Core 3.0.0 veröffentlicht. Einen grundlegenden Überblick über die wichtigsten Änderungen sowie die weiterführenden Links zur Dokumentation und zu den …
Weitere neue Features in Zikula Core 3
- Nachdem wir bereits in einigen Artikeln zu Zikula 3 die Änderungen unter der Haube, umfangreiche Modernisierungen, Möglichkeiten für dynamische Formulare und Neuerungen rund um Übersetzungen …
Zikula 3 bringt zahlreiche Neuerungen rund um Übersetzungen
- Nachdem zwischen den Jahren der komplette Unterbau von Zikula 3 auf Stand gebracht worden ist, hat sich der nächste Sprint dem Übersetzungssystem gewidmet. In diesem Beitrag wird kurz dargestellt, …
Zikula startet modernisiert ins neue Jahr
- Im Rahmen des letzten Sprints wurde der Unterbau von Zikula 3 auf den neuesten technischen Stand gebracht. Im Folgenden wird kurz zusammengefasst, was hierbei genau passiert ist. Twig 3 Als erstes …