Dokumentation

Ich habe in den letzten Wochen angefangen, Doku für die Ansible-Rollen zu schreiben. Mein Ziel ist es, für jede von uns (Ingolstadt) benutzte Rolle eine README.md zu haben, in der zumindest die Funktion der Rolle und wichtigsten Konfigurationsvariablen erklärt werden.
Es fehlt noch so einiges, zum Teil fehlt mir auch das nötige Wissen, und ich weiß auch nicht wie lange meine Dokumentations-Motivation anhält.

Bisher habe ich für 27 Rollen ein README.md in unterschiedlichster Qualität.
Der aktuelle Stand liegt hier: https://git.bingo-ev.de/freifunk/Ansible-Freifunk-Gateway/tree/12-rollen-dokumentieren/

Nur für den Fall dass jemandem im Homeoffice/Kurzarbeit oder anderweitig langweilig werden sollte.

2 Like

Finde ich sehr gut! Wollte sowas auch immer Mal angefangen haben aber irgendwie waren immer irgendwelche Sachen wichtiger oder aber ich war unmotiviert. :see_no_evil:

Vlt. Ändert sich das ja jetzt wo der erste Schritt getan ist :slight_smile:

Find ich super. Danke dir! Wollen wir das einfach direkt in den Master bei uns mergen? Macht ja nichts, wenn es noch nicht vollständig ist.

Hab eben den Pull Request erstellt: https://github.com/FreiFunkMuenster/Ansible-Freifunk-Gateway/pull/135

Bitte aber nochmal drübersehen bevor ihr das in Master merged.

1 Like