Helfer / Mitarbeiter an neuer Dokumentation gesucht

Einrichtung, Nutzung und Hilfe zu RaspberryMatic (OCCU auf Raspberry Pi)

Moderatoren: jmaus, Co-Administratoren

Antworten
Benutzeravatar
jmaus
Beiträge: 5793
Registriert: 17.02.2015, 14:45
Wohnort: Dresden
Hat sich bedankt: 14 Mal
Danksagung erhalten: 285 Mal
Kontaktdaten:

Helfer / Mitarbeiter an neuer Dokumentation gesucht

Beitrag von jmaus » 01.05.2020, 12:59

Hallo Zusammen,

da die originale Installationsanleitung zu RaspberryMatic (cf. viewtopic.php?f=65&t=26917) etwas in die Jahre gekommen ist arbeite ich bereits seit Anfang des Jahres daran eine etwas modernisierte Installations- und allgemeine Dokumentation über RaspberryMatic zu schreiben. Nun komme ich aber leider aus Zeitgründen einfach nicht so schnell voran wie ich mir das gewünscht hätte und so will ich hier einmal die Gelegenheit nutzen um Mithilfe bzw. Mitarbeit an der neuen Dokumentation zu bitten.

Das Grundgerüst der neuen Dokumentation steht im Grunde schon und auch der eine oder andere Inhalt ist bereits von mir eingepflegt bzw. von der alten RaspberryMatic Anleitung übertragen und angepasst worden. Den aktuellen Stand dazu kann man sich hier anschauen:

https://github.com/jens-maus/RaspberryMatic/wiki

Wie man darin unschwer erkennen kann habe ich die neue offizielle Dokumentation nicht nur in das GitHub Projekt von RasberryMatic verlagert, ich nutze dort auch die allgemeine Wiki-Funktion der GitHub Seiten damit im Grunde jeder der einen GitHub Account hat an der Weiterentwicklung der Dokumentation mitarbeiten kann (RaspberryMatic ist eben ein Community-Projekt!). Und wie man auch dort sehen kann soll das nicht nur eine allgemeine Installationsanleitung sein, sondern vielmehr eine allgemeine Dokumentation über RaspberryMatic wo dann auch Tipps&Tricks finden kann, Einsteiger die Installation besser nachvollziehen können, usw.

Lange Rede, kurzer Sinn: Nun suche ich eben Mitstreiter die nicht nur die notwendige Zeit und Motivation mitbringen an der (Weiter-)Entwicklung der Dokumentation mitzuwirken, sondern diese auch am besten in Zukunft entsprechend mitpflegen können, sodass in naher Zukunft diese Wiki-Seiten hoffentlich die neue alleinige offizielle und komplette Dokumentation rund um das Thema "RaspberryMatic" wird.

Wenn es also Interessenten gibt die gerne an der neuen Dokumentation mitwirken wollen, dann bitte vortreten und hier melden. Empfehlenswert wäre, wenn man sich ggf. bereits mit dem Markdown-basierten Wikisystem von GitHub auskennt oder ggf. bereit sich darin einzulesen damit man nicht nur einfachen Text in die Dokumentation aufnehmen kann, sondern dann auch entsprechend Grafiken einbinden und das ganze etwas kompletter gegeneinander verlinken könnte. Mehr Infos über die GitHub Wikis findet man z.B. hier:

https://guides.github.com/features/wikis/
https://help.github.com/en/github/build ... bout-wikis

Über ein entsprechendes vielfältiges Mitwirken an der Dokumentation würde ich mich sehr freuen. Also bitte hier einfach melden und dann können wir hier weitere Details besprechen.

Ich bitte allerdings darum, das nur Personen sich hier melden die auch wirklich bereit sind einen gewissen Zeitaufwand zu investieren und sich das wirklich auch als Ihr "Projekt" auf den Tisch ziehen wollen. Und wer sofort loslegen will kann ja einfach in dem GitHub Wiki bereits anfangen. Es ist ja wie gesagt als freier Wiki eingerichtet, sodass jeder der einen GitHub Account hat darin auch rumeditieren kann um verbesserungen/Veränderungen einzupflegen. Die einzige Bitte die ich hier hätte wäre allerdings die Struktur soweit aufrecht zu erhalten und sich auch bei der Benennung neuer Seiten oder das hochladen von Bilddateien an die existierende Struktur/Nomenklatur zu halten.

Viel Spaß!
RaspberryMatic 3.51.6.20200420 @ ESXi mit ~170 HomeMatic Geräten + ioBroker – GitHubGitHub Sponsors / PayPalTwitter

Antworten

Zurück zu „RaspberryMatic“