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: 5993
Registriert: 17.02.2015, 14:45
System: Alternative CCU (RaspberryMatic etc.)
Wohnort: Dresden
Hat sich bedankt: 16 Mal
Danksagung erhalten: 336 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.20200621 @ ESXi mit ~180 HomeMatic Geräten + ioBroker – GitHubGitHub Sponsors / PayPalTwitter

scorpionking
Beiträge: 355
Registriert: 14.02.2016, 12:32
System: Alternative CCU (RaspberryMatic etc.)
Hat sich bedankt: 19 Mal
Danksagung erhalten: 30 Mal

Re: Helfer / Mitarbeiter an neuer Dokumentation gesucht

Beitrag von scorpionking » 11.08.2020, 18:59

Ich versuche, ein paar leere Bereiche mal mit Leben zu füllen, sofern es meine Freizeit erlaubt. Ich hoffe, es ist OK, wenn ich teilweise direkt von deiner Installationsanleitung hier im Forum kopiere...

Benutzeravatar
Psi
Beiträge: 376
Registriert: 09.08.2018, 19:58
Wohnort: Nürnberg
Hat sich bedankt: 23 Mal
Danksagung erhalten: 52 Mal

Re: Helfer / Mitarbeiter an neuer Dokumentation gesucht

Beitrag von Psi » 11.08.2020, 23:47

Generell ist meine Erfahrung, dass ein Wiki gerne mal etwas wuchert und neben tollen Beiträgen aus der Community auch mal hier und da Halbwahrheiten einfließen. Auch wenn die Hürde was beizutragen relativ gering ist hatte ich mich bei asksinpp.de bewusst dagegen entschieden und ein echtes Repository gewählt. Die weitreichenden Möglichkeiten einer eigenen Page sind hilfreich aber vor allem kann anhand der Commits Änderungen nachvollzogen werden und es gibt ein Review für pull requests.

Vllt sollte man (später?) mal überlegen ob so ein Konstrukt wie bei asksinpp.de nicht auch für raspberrymatic Sinn macht.

Zugegeben, besonders viele contributors gab es nicht, meist sind es immer die üblichen verdächtigen :-)

Benutzeravatar
jmaus
Beiträge: 5993
Registriert: 17.02.2015, 14:45
System: Alternative CCU (RaspberryMatic etc.)
Wohnort: Dresden
Hat sich bedankt: 16 Mal
Danksagung erhalten: 336 Mal
Kontaktdaten:

Re: Helfer / Mitarbeiter an neuer Dokumentation gesucht

Beitrag von jmaus » 12.08.2020, 10:45

scorpionking hat geschrieben:
11.08.2020, 18:59
Ich versuche, ein paar leere Bereiche mal mit Leben zu füllen, sofern es meine Freizeit erlaubt. Ich hoffe, es ist OK, wenn ich teilweise direkt von deiner Installationsanleitung hier im Forum kopiere...
Oh, das hört sich ja wirklich super an. Hab auch schon bereits deine Änderungen bzgl. bebilderte HyperV Anleitung gesehen. Danke dafür, genau so hatte ich mir das vorgestellt, das die Dokumentation eben schrittweise so mit Leben gefüllt wird und am besten auch mit vielen Bildern/Screenshots hinterlegt wird. Also bitte weiter so und klar, du kannst gerne von meiner ursprünglichen Installationsanleitung hier im Forum fröhlich kopieren wie du möchtest. Mein Plan wäre dann, sobald die Dokumentation im Wiki den Stand der Anleitung hier im Forum erreicht hat diese nur noch auf den GitHub Wiki verlinken zu lassen und in Zukunft dort zu pflegen.

P.S: Und nur so nebenbei, wenn du in Zukunft wieder Bilder verlinken willst, dann lad diese doch bitte in das Wiki Git Repository hoch und verlinke die bilder so. So sind die Bilder dann teil des Wiki Repositories und sind somit auch für alle Ewigkeiten archiviert bzw. versioniert.

Also noch einmal danke das sich nun anscheinend doch (ich hatte die Hoffnung schon aufgegeben) der Eine oder Andere hier findet der ein wenig an der Dokumentation mitarbeiten will – auch damit mir selbst mehr zeit für das eigentliche weiterentwickeln von RaspberryMatic bleibt. Also bitte weiter so!
RaspberryMatic 3.51.6.20200621 @ ESXi mit ~180 HomeMatic Geräten + ioBroker – GitHubGitHub Sponsors / PayPalTwitter

Benutzeravatar
jmaus
Beiträge: 5993
Registriert: 17.02.2015, 14:45
System: Alternative CCU (RaspberryMatic etc.)
Wohnort: Dresden
Hat sich bedankt: 16 Mal
Danksagung erhalten: 336 Mal
Kontaktdaten:

Re: Helfer / Mitarbeiter an neuer Dokumentation gesucht

Beitrag von jmaus » 12.08.2020, 10:50

Psi hat geschrieben:
11.08.2020, 23:47
Generell ist meine Erfahrung, dass ein Wiki gerne mal etwas wuchert und neben tollen Beiträgen aus der Community auch mal hier und da Halbwahrheiten einfließen. Auch wenn die Hürde was beizutragen relativ gering ist hatte ich mich bei asksinpp.de bewusst dagegen entschieden und ein echtes Repository gewählt. Die weitreichenden Möglichkeiten einer eigenen Page sind hilfreich aber vor allem kann anhand der Commits Änderungen nachvollzogen werden und es gibt ein Review für pull requests.
Die Wikis in GitHub sind doch genauso vollwertige Git-Repositories wie die source repositories. Du kannst den wiki (so mache ich das) ja via Git ganz normal auschecken und kannst die markdown dateien und bilder dann wie gewohnt via git versionieren und verwalten. Und so kann ich dann auch problemlos sehen wer/was/wie editiert hat und ggf. qualitätssichernd eingreifen. Bisher bin ich damit ehrlich gesagt ganz gut gefahren und mir gefällt bisher das simple editieren via markdown sehr gut und die Wiki seiten kann man da sehr gut und schnell editieren. Und falls der wildwuchs doch zu groß wird, so kann man den public write access ja deaktivieren und dann nur ausgewählten GitHub nutzern write access zum wiki repository geben.
Psi hat geschrieben:
11.08.2020, 23:47
Vllt sollte man (später?) mal überlegen ob so ein Konstrukt wie bei asksinpp.de nicht auch für raspberrymatic Sinn macht.
Prinzipiell bin ich da für alles offen. Also wenn sich da wirklich eine umfangreiche Dokumentationscrew bildet die die RaspberryMatic Dokumentation entsprechend erweitert und mit leben füllt (so würde ich mir das wünschen!) dann kann man sicherlich auch über solche Verbesserungen dann nachdenken und ggf. doch aus dem Wiki repositoriy ein vollwertiges machen. Danke für deine Hinweise/Anregungen!
RaspberryMatic 3.51.6.20200621 @ ESXi mit ~180 HomeMatic Geräten + ioBroker – GitHubGitHub Sponsors / PayPalTwitter

Benutzeravatar
Psi
Beiträge: 376
Registriert: 09.08.2018, 19:58
Wohnort: Nürnberg
Hat sich bedankt: 23 Mal
Danksagung erhalten: 52 Mal

Re: Helfer / Mitarbeiter an neuer Dokumentation gesucht

Beitrag von Psi » 12.08.2020, 11:08

jmaus hat geschrieben:
12.08.2020, 10:50
Die Wikis in GitHub sind doch genauso vollwertige Git-Repositories wie die source repositories. Du kannst den wiki (so mache ich das) ja via Git ganz normal auschecken und kannst die markdown dateien und bilder dann wie gewohnt via git versionieren und verwalten. Und so kann ich dann auch problemlos sehen wer/was/wie editiert hat und ggf. qualitätssichernd eingreifen. Bisher bin ich damit ehrlich gesagt ganz gut gefahren und mir gefällt bisher das simple editieren via markdown sehr gut und die Wiki seiten kann man da sehr gut und schnell editieren. Und falls der wildwuchs doch zu groß wird, so kann man den public write access ja deaktivieren und dann nur ausgewählten GitHub nutzern write access zum wiki repository geben.
Ahh okay, das wusste ich gar nicht aber dann erfüllt es ja erst mal den Zweck und solange du die Änderungen nachvollziehen, gegenlesen und wenn nötig korrigieren kannst passt das ja. Dokumentation ist und bleibt ein schwieriges Thema.

scorpionking
Beiträge: 355
Registriert: 14.02.2016, 12:32
System: Alternative CCU (RaspberryMatic etc.)
Hat sich bedankt: 19 Mal
Danksagung erhalten: 30 Mal

Re: Helfer / Mitarbeiter an neuer Dokumentation gesucht

Beitrag von scorpionking » 12.08.2020, 16:53

jmaus hat geschrieben:
12.08.2020, 10:45
P.S: Und nur so nebenbei, wenn du in Zukunft wieder Bilder verlinken willst, dann lad diese doch bitte in das Wiki Git Repository hoch und verlinke die bilder so. So sind die Bilder dann teil des Wiki Repositories und sind somit auch für alle Ewigkeiten archiviert bzw. versioniert.
OK, ich muss mich wohl noch in den Umgang mit Git näher einarbeiten...
Hatte da bisher keine Berührungspunkte (und dementsprechend keine Ahnung wie man Bilder in das Wiki hochlädt), aber da sich keiner sonst gemeldet hat wollte ich halt mal einen Anfang machen.
Ich gelobe Besserung.

Benutzeravatar
jmaus
Beiträge: 5993
Registriert: 17.02.2015, 14:45
System: Alternative CCU (RaspberryMatic etc.)
Wohnort: Dresden
Hat sich bedankt: 16 Mal
Danksagung erhalten: 336 Mal
Kontaktdaten:

Re: Helfer / Mitarbeiter an neuer Dokumentation gesucht

Beitrag von jmaus » 12.08.2020, 17:00

scorpionking hat geschrieben:
12.08.2020, 16:53
jmaus hat geschrieben:
12.08.2020, 10:45
P.S: Und nur so nebenbei, wenn du in Zukunft wieder Bilder verlinken willst, dann lad diese doch bitte in das Wiki Git Repository hoch und verlinke die bilder so. So sind die Bilder dann teil des Wiki Repositories und sind somit auch für alle Ewigkeiten archiviert bzw. versioniert.
OK, ich muss mich wohl noch in den Umgang mit Git näher einarbeiten...
Hatte da bisher keine Berührungspunkte (und dementsprechend keine Ahnung wie man Bilder in das Wiki hochlädt), aber da sich keiner sonst gemeldet hat wollte ich halt mal einen Anfang machen.
Ich gelobe Besserung.
Das ist vollkommn so i.O. Du kannst auch erst einmal gerne einfach so weitermachen. Bin da ja über jegliche Hilfe dankbar egal in welcher Form.
RaspberryMatic 3.51.6.20200621 @ ESXi mit ~180 HomeMatic Geräten + ioBroker – GitHubGitHub Sponsors / PayPalTwitter

Antworten

Zurück zu „RaspberryMatic“