Guppy bekommt eine Produktseite
Bisher lebten Guppy-Neuigkeiten im Slack. Das funktionierte für alle, die in der Woche zufällig im Channel waren, und für sonst niemanden. Eine Nachricht über einen Breaking Change findest du drei Monate später nicht wieder, und einem Kunden in die Hand geben kannst du sie auch nicht.
Deshalb gibt es auf der Doku-Seite jetzt drei neue Bereiche.
Changelog
Jedes Release aus dem Guppy-Theme und seinen Plugins liegt unter Changelog. Jedes Produkt hat dort eine eigene Seite in der Seitenleiste, und die Übersicht zeigt die jüngsten Releases über das ganze Ökosystem hinweg in zeitlicher Reihenfolge. Änderungen sind nach Kategorie gruppiert, damit Breaking Changes sich nicht zwischen den Bugfixes verstecken.
Die Seiten werden aus der CHANGELOG.md jedes Repositories erzeugt, die Release-Daten kommen aus den Git-Tags. Die Release-Notes bleiben also da, wo sie hingehören, direkt beim Code, und diese Seiten sind nur eine Ansicht darauf.
Das Changelog gibt es vorerst nur auf Englisch, weil die Einträge in den Repositories auf Englisch geschrieben werden.
Roadmap
Die Roadmap zeigt, woran gerade gebaut wird, was als Nächstes kommt und wohin es danach gehen soll. Sie wird bewusst von Hand gepflegt: Eine Roadmap drückt ein Vorhaben aus, und das kann kein Milestone-Tracker für uns ableiten.
Termine stehen absichtlich nicht darauf. Reihenfolge und Status sind die Zusage.
News
Dieser Beitrag ist der erste unter News. Erwarte Release-Highlights, Hinweise zu Breaking Changes und gelegentlich einen praktischen Tipp. Ankündigungen entstehen ab jetzt hier und werden von hier aus weiterverteilt, nicht andersherum.
Was du tun musst
Nichts, wenn du die Doku nur liest. Wenn du ein Guppy-Repository pflegst, sind zwei Dinge wichtig: Release-Notes folgen dem Format aus CHANGELOG-CONVENTION.md im Wurzelverzeichnis des Doku-Repositories, und jedes Release braucht ein Git-Tag, das zur Versionsüberschrift passt. Aus dem Tag kommt das Release-Datum.
Genau das hält die Changelog-Seiten korrekt.
Was als Nächstes kommt
Die jeweils fehlende Sprache für die Produktseiten. Die Slack-Anbindung ist inzwischen fertig: neue Releases und Beiträge melden sich automatisch in #guppy.