[Aufruf] Helft bei der neuen ioBroker-Dokumentation und -Adapter-Referenz mit!

Allgemeine Fragen und Info rund um ioBroker
Antworten
Benutzeravatar
apollon77
guru
Beiträge: 7104
Registriert: 10.04.2015, 12:27

[Aufruf] Helft bei der neuen ioBroker-Dokumentation und -Adapter-Referenz mit!

Beitrag von apollon77 » 16.09.2018, 21:03

Hallo ioBroker-Community,

wie immer mal wieder im Forum oder auch in Facebook aufkommt, ist die ioBroker-Dokumentation auf der Webseite und auch bei den einzelnen Adaptern nicht so wie wir uns es wünschen und wie Ihr als User es braucht. Einiges ist nicht mehr aktuell, anderes fehlt und wieder anderes nur englisch.

Daran wollen wir etwas ändern und brauchen dabei Eure Unterstützung!

Wir (das ist eine Gruppe aus allen voran Homoran, Stabilostick, Eric2905, BuZZy1337, Bluefox, mir und noch ein paar anderen) haben in den letzten Wochen angefangen uns über eine neue Struktur der Dokumentation auf der Webseite und auch einer zentralen Adapter-Referenz Gedanken zu machen.

Wir haben mit der Struktur und der Navigation gestartet. Eine erste Vorschau steht unter https://iobroker.github.io/ioBroker.docs/#/ als Grundlage für das Schreiben der nötigen Inhalte zur Verfügung.
NewWebsite.png
Erwartet also noch nicht zu viel, das ganze "Fleisch" (damit meine ich die guten Texte, die auch helfen) fehlt noch.

Und damit kommt hoffentlich Ihr ins Spiel. Allein werden wir es neben unseren anderen Verantwortungen im Projekt nur eher langsam schaffen alle nötigen Texte zu schreiben bis wir einen Punkt haben, wo man die neue Dokumentation veröffentlichen können.

Ihr habt Euch schon mal geärgert das Texte veraltet oder falsch sind oder fehlen?
Ihr seid keine Entwickler und wollt ioBroker dennoch gern unterstützen?

Ich freue mich über jede Meldung per PN. Nennt auch gern die Bereiche an denen Ihr ggf. besonders Interesse oder Erfahrungen habt. Wir sammeln jetzt ein paar Tage die Unterstützer und starten dann gemeinsam.

Auf viele Rückmeldungen hoffend,

Ingo
How-to:
* Debug-Log für einen Adapter/Instanz einschalten? -> Instanzen -> Expertenomodus -> Spalte Loglevel/Log-Stufe

!munk
starter
Beiträge: 12
Registriert: 08.10.2018, 19:48

Re: [Aufruf] Helft bei der neuen ioBroker-Dokumentation und -Adapter-Referenz mit!

Beitrag von !munk » 10.10.2018, 00:45

Hallo,

da will ich gerne mitmachen, obwohl ich im homematic Bereich noch Frischling bin.

Bin ja gerade mit "Wucht" eingestiegen...

Benutzeravatar
sigi234
professional
Beiträge: 764
Registriert: 12.06.2017, 21:22

Re: [Aufruf] Helft bei der neuen ioBroker-Dokumentation und -Adapter-Referenz mit!

Beitrag von sigi234 » 10.10.2018, 01:08

Hallo Ingo,

sieht schon sehr gut aus. Eine kleine Anregung habe ich, kann man bei den Adaptern einen Hinweis einfügen für welches System er geeignet ist.

Entweder als Symbolbild oder in der Beschreibung.

Ich kann auch gerne mithelfen, möchte zwar keine Doku schreiben, aber ich werde fleißig mitlesen, Vorschläge machen und eventuelle Fehler melden.

Mein Spezialgebiet ist VIS...........
MfG
Sigi

Benutzeravatar
apollon77
guru
Beiträge: 7104
Registriert: 10.04.2015, 12:27

Re: [Aufruf] Helft bei der neuen ioBroker-Dokumentation und -Adapter-Referenz mit!

Beitrag von apollon77 » 10.10.2018, 06:18

sigi234 hat geschrieben:Hallo Ingo,

sieht schon sehr gut aus. Eine kleine Anregung habe ich, kann man bei den Adaptern einen Hinweis einfügen für welches System er geeignet ist.

Entweder als Symbolbild oder in der Beschreibung.

Ich kann auch gerne mithelfen, möchte zwar keine Doku schreiben, aber ich werde fleißig mitlesen, Vorschläge machen und eventuelle Fehler melden.

Mein Spezialgebiet ist VIS...........
Leg doch im docs Projekt mit der Idee mal ein issue an.


Gesendet vom Handy ...
How-to:
* Debug-Log für einen Adapter/Instanz einschalten? -> Instanzen -> Expertenomodus -> Spalte Loglevel/Log-Stufe

Benutzeravatar
apollon77
guru
Beiträge: 7104
Registriert: 10.04.2015, 12:27

Re: [Aufruf] Helft bei der neuen ioBroker-Dokumentation und -Adapter-Referenz mit!

Beitrag von apollon77 » 10.10.2018, 06:19

!munk hat geschrieben:Hallo,

da will ich gerne mitmachen, obwohl ich im homematic Bereich noch Frischling bin.

Bin ja gerade mit "Wucht" eingestiegen...
Dann meld doch mal per PN mit deinem GitHub Namen ;-) falls du noch keinen hast schnell anmelden.


Gesendet vom Handy ...
How-to:
* Debug-Log für einen Adapter/Instanz einschalten? -> Instanzen -> Expertenomodus -> Spalte Loglevel/Log-Stufe

Antworten