openWB Wiki

HSC
Beiträge: 3941
Registriert: So Jan 10, 2021 8:49 am

Re: openWB Wiki

Beitrag von HSC »

Hallo JSAnyone,
ich wollte Dich eben schon anschreiben...
Mir wäre es sehr lieb, wenn Du es mit übernehmen könntest. Ich habe es nicht so mit diesem Git.
Ich habe eben schon gesehen, dass es "noch in Arbeit" ist.
Wäre es ok für Dich? Wenn ja, dann schon vorab vielen Dank.
VG
JSAnyone
Beiträge: 291
Registriert: Fr Jun 05, 2020 5:56 pm

Re: openWB Wiki

Beitrag von JSAnyone »

Ja, kann ich gerne machen.
Ich müsste aber deine Bilder verwenden, ich hab ja kein Android. Passt das?
HSC
Beiträge: 3941
Registriert: So Jan 10, 2021 8:49 am

Re: openWB Wiki

Beitrag von HSC »

Super, vielen Dank.
Ja, ich unterstütze sehr gern, auch mit neuen oder weiteren Bildern.
Was würdest Du benötigen? Wollen wir ab hier per PN?
Kannst Du mir bitte nochmal den Link vom Beitrag senden? Ich finde ihn eben nicht.
VG
JSAnyone
Beiträge: 291
Registriert: Fr Jun 05, 2020 5:56 pm

Re: openWB Wiki

Beitrag von JSAnyone »

HSC und ich haben mittlerweile per PN weitergemacht, hier die “finale” Version:
https://github.com/snaptec/openWB/wiki/openWB-%22App%22

Ich habe mich noch ein bisschen mit den Bildern rumgeärgert, weil die immer viel zu groß waren. Hab’s irgendwie nicht hinbekommen die Größe der Bilder in Markdown zu ändern, deswegen habe ich HTML-Tags verwendet:
Statt:

Code: Alles auswählen

 ![1. Schritt](url)
HTML:

Code: Alles auswählen

 <img src="url" alt="1. Schritt" width="500x">
Vielleicht hilft’s ja wem.
HSC
Beiträge: 3941
Registriert: So Jan 10, 2021 8:49 am

Re: openWB Wiki

Beitrag von HSC »

Top! 👍
Danke Dir....
JSAnyone
Beiträge: 291
Registriert: Fr Jun 05, 2020 5:56 pm

Re: openWB Wiki

Beitrag von JSAnyone »

Ich habe mir noch ein paar andere Gedanken zum Wiki gemacht:

Zurzeit ist die openWB Dokumentation ja eine Mischung zwischen Forum, GitHub Wiki und der OpenWB-Website. Das halte ich für nicht wirklich effizient.

Forum: ist für mich raus, weil Informationen mit der Zeit einfach untergehen.

GitHub Wiki: Finde ich eigentlich eine gute Sache, lässt sich relativ schnell und übersichtlich mit arbeiten. Zurzeit ist es noch ein bisschen ein Wildwuchs, aber wenn man da mal eine gescheite Gliederung reinbringt kann das denke ich gut werden.

OpenWB-Website: Hat ein paar gute Tutorials, und wird für Interessenten der OpenWB die erste Anlaufstelle bleiben.

Die wichtigen Wissenssammlungen aus dem Forum fände ich gut wenn mit der Zeit ins Wiki übertragen werden würden. Grade auch so was wie Erläuterungen zu CSVs, MQTT-Topics usw.

Die neuen SoC Foren machen das ganze schon deutlich übersichtlicher, aber auch da wäre es denke ich sinnvoll wenn man jeden Maintainer bittet ein paar Worte ins Wiki zu schreiben, oder einfach die schon existierenden Anleitungen von den Foren-Threads ins Wiki kopiert. Dann müssten sie aber finde ich weg vom Forum, um eine Dopplungen zu vermeiden.

Was mich aktuell etwas beunruhigt ist, dass jeder das Wiki bearbeiten kann. Ist das Git-typisch so abgesichert, dass falls ein Scherzkeks alles löscht, zur letzten Version zurückgegangen werden kann?
Oder gibt’s die Möglichkeit, dass das wie Code auch nur von OpenWB per Pull-Requests angepasst werden kann?

Nochmal zur OpenWB-Website: Am sinnvollsten wäre es denke ich die Anleitungen von der Website ins Wiki zu kopieren und dann sinnvoll unter z.B erste Schritte einzugliedern.
Auf die OpenWB-Website könnte man dann entweder zusätzlich zu / statt den jetzigen Tutorials einen Link zum Wiki setzten, oder man schafft es irgendwie das Wiki in die OpenWB-Website “einzubetten”.

Auch eine FAQ würde ich im Wiki wenn erlaubt auf Basis der FAQ auf der Website anfangen, die dann aber von jedem konsequent erweitert werden kann, um die sich im Forum ständig wiederholenden Fragen abzudecken.

Das ist jetzt ganz schön lang geworden, aber was denkt ihr und @openWB zu den verschiedenen Punkten?
aiole
Beiträge: 6779
Registriert: Mo Okt 08, 2018 4:51 pm

Re: openWB Wiki

Beitrag von aiole »

Ich kann Deine Bedenken gut nachvollziehen. 3 Orte sind für normale Leute zu viel und eine gute Organisation hat noch nie geschadet. Sie haben aber alle Vor-und Nachteile.

Ich sehe es so:
1. Zusammentragen der Infos => Forum (Wissenssammlung und andere threads)
2. In zeitlichen Abschnitten paketweises Übertragen auf Wiki im Github. Github ist halt Fremdserver. Die Zugangsmodalitäten müssten noch geklärt werden.
3. Bestimmte Infos gehören m.E. zum Produkt. Deshalb ist auch die Website wichtig. Deren (wachsende) Tutorials würde ich ins Wiki verlinken und nicht kopieren.

Damit könnte oWB die website weiter pflegen/unabhängig ausbauen, das Forum weiter Infos sammeln und beides landet zum Schluss immer auf Github im Wiki.
Das Verlinken der oWB-website statt Datenkopieren finde ich extrem wichtig, um keine Doppelpflege betreiben zu müssen. Natürlich müssten auf Git dann die links zur oWB-website ab und an auf Aktualität geprüft werden, aber das ist allemal weniger aufwendig, als Texte/Bilder doppelt zu pflegen.

Ergebnis - für die Mehrzahl der Leute nur noch 2 Anlaufpunkte (1 und 2):
1 Neueinsteiger/Interessenten => oWB-website
2 Fortgeschrittene Anwender oder Interessenten mit mehr Infobedarf => wiki auf Github
3 für Insider => Forum

VG
openWB
Site Admin
Beiträge: 7905
Registriert: So Okt 07, 2018 1:50 pm

Re: openWB Wiki

Beitrag von openWB »

Ich denke das die Tutorials am "beständigsten" sind auf der Webseite und für den Anfang am sinnvollsten.
Hier dann gern ein Link zum Wiki mit Dingen die nicht unter gehen sollten (bytheway, Vielen Dank dafür!).
Alles mit höherer Fluktuation bzw. geringer Halbwertszeit (wie SoC Dinge) dann im Forum.

Gerne weitere Meinungen.
Supportanfragen bitte NICHT per PN stellen.
Hardwareprobleme bitte über die Funktion Debug Daten senden mitteilen oder per Mail an support@openwb.de
JSAnyone
Beiträge: 291
Registriert: Fr Jun 05, 2020 5:56 pm

Re: openWB Wiki

Beitrag von JSAnyone »

aiole hat geschrieben: Mi Mai 05, 2021 9:00 am Bestimmte Infos gehören m.E. zum Produkt. Deshalb ist auch die Website wichtig. Deren (wachsende) Tutorials würde ich ins Wiki verlinken und nicht kopieren.
Sehe ich genauso, kopieren ist keine Option wegen Dopplungen. Da habe ich mich unschön formuliert, ich meinte von der oWB-Website ins Wiki verschieben und dann auf der oWB Seite “einbetten”. Falls das aber nicht möglich oder nicht gewollt ist wäre ich auch fürs Verlinken.

Einzig eine FAQ würde ich auf Basis der FAQ auf der oWB-Website im Wiki starten, ich denke da ist es einfach sinnvoll wenn die Community miterweitern pflegen kann. Da fände ich eine Dopplung zwischen Wiki und oWB-Website aber gar nicht so schlimm, auf der oWB-Website wäre dann eine “Einsteiger-FaQ” und im Wiki eine mit der Zeit hoffentlich wesentlich größere “Les-mich-bevor-du-eine-Frage-ins-Forum-postest FAQ”.
openWB hat geschrieben: Mi Mai 05, 2021 9:50 am Alles mit höherer Fluktuation bzw. geringer Halbwertszeit (wie SoC Dinge) dann im Forum.
Die Frage ist halt, ist sowas wie eine grundlegende Anleitung für die verschiedenen Module nicht relativ fest? Also z.B. das:
https://github.com/snaptec/openWB/wiki/ ... ercedes-EQ

Nächste Frage, wo ich das gerade sehe: Wiki auf Deutsch oder Englisch?
JSAnyone
Beiträge: 291
Registriert: Fr Jun 05, 2020 5:56 pm

Re: openWB Wiki

Beitrag von JSAnyone »

Sonst keine Meinungen?

Habe auf jeden Fall noch eine Seite über den Fernzugriff zum Wiki hinzugefügt:
https://github.com/snaptec/openWB/wiki/Fernzugriff
Danke an LutzB von dem ich ein paar hier im Forum geschriebene Sachen klauen durfte!
Antworten