Smeagol
Smeagol ist ein Open-Source-Wiki, welches die Dokumentation im Cloudogu EcoSystem unterstützt. Die sorgfältige Dokumentation von Code und Konfigurationen hilft Wissen in Organisationen zu verbreiten und zu verwalten. Smeagol macht es einfach die Dokumentation durchgängig auf dem aktuellen Stand zu halten und erleichtert den Entwicklungsteams das Dokumentieren.
Features von Smeagol
Einrichtung des Wikis
Die Wiki-Software verwaltet die Dokumentation direkt am Code im Git-Repository. Ein neuer Eintrag wird durch eine entsprechende Smeagol.yaml-Datei im Repository angelegt. Anschließend können die Seiten des Wikis als Textdateien im Repository abgelegt werden.
Bearbeitung von Inhalten via IDE
Da die Inhalte des Wikis Textdateien im Repository sind, kann jeder Entwickler direkt während der Arbeit am Code die Dokumentation pflegen. Alle Änderungen werden direkt ins Repository gepushed.
Bearbeitung via Browser
Zusätzlich können mit Smeagol die Inhalte des Wikis über den Browser angesehen und mit dem integrierten WYSIWYG-Editor bearbeitet werden. So können auch Teammitglieder, die nicht direkte an dem Repository arbeiten, Inhalte einsehen und bearbeiten. Bei der Bearbeitung des Editors werden die Änderungen automatisch an das Repository committed.
Integration im CES
Smeagol ist direkt in der Toolchain des Cloudogu EcoSystem integriert. Der Repository-Browser zeigt alle Repositories an, für die der Nutzer im SCM-Manager berechtigt ist.
Hinweise zur Nutzung von Smeagol gibt unser Blog: Smeagol, das Git Wiki
