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

[apollon77]

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.

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

[munk]

Hallo,

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

Bin ja gerade mit "Wucht" eingestiegen…

[sigi234]

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…........

[apollon77]

@sigi234:

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 …

[apollon77]

@!munk:

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 …

[Puravida]

Ich bin gerade auf diesen Thread gestoßen weil ich gesucht habe wie oder wohin ich einen Doku-Fehler melden soll. Habe mir nämlich die Tage mal Blockly angeschaut und gleich beim dritten Beispiel auf Github ist ein Fehler im Blockly Beispiel. Es fehlt das setzen der Variable vor dem Trigger in dem Beispiel. Hat mich jetzt einiges an Zeit gekostet dahinter zu kommen warum ein Beispiel aus der Doku nicht funktioniert.

Mit Github bin ich leider nicht so auf Du und Du dass ich wüßte wie ich das dort einmelden kann.

[apollon77]

Github ist mega freundlich. Github braucht nur deine Email und ein Passwort und schon seid Ihr freunde.

Dann gehst Du auf https://github.com/ioBroker/ioBroker.javascript und kannst entweder ein Issue anlegen und den Fehler beschreiben, dann fixt es vllt mal jemand. Issue anlegen ist: Auf Issues klicken, "New Issue" und dann text eingeben.

Noch besser ist https://github.com/ioBroker/ioBroker.ja … blockly.md zu gehen, oben rechts auf den Stift klicken, im texteditor den Fehler selbst fixen, dann ganzen unten beschreiben was Du getan hast und "Änderung vorschlagen".

Versuch mal , tut nicht weh, verspreche ich. Danach hast Du nicht nur einen neuen Freund sondern kann noch ganz andere DInge tun wie für Issues abstimmen,Adapter-Requests anlegen und sowas

[maloross]

Moin,

im Rahmen meiner Möglichkeiten kann ich die eine oder andere Anleitung schreiben und würde bei dem Projekt mitmachen. Als Anfängerin würde ich natürlich die "einfacheren" Adapter bevorzugen

[apollon77]

Dann such Dir doch mal einen aus und dann melde dich bei mir per PN

hast Du Telegram? Dann deinen Telegram User mit dazu bitte

[SolarisMUC]

Hallo,

nachdem ich mich jetzt seit Ende 2018 mit dem ioBroker auf anraten eines befreundeten Entwicklers beschäftige, muss ich sagen, ne echt coole Nummer die Ihr da auf die Beine gestellt habt.

Leider sind die Anleitungen und Tutorials rund um die einzelnen Adapter etc. recht rudimentär oder hören nach 40% des zu erwarteten Umfangs auf.

Aus diesem Grunde möchte ich mich anbieten einige Bereiche der Dokumentation mit zu überarbeiten, sollte hierbei noch Bedarf bestehen.

Gerade durch den Umfang der IoT-Geräte in meinem Haushalt musste ich mir einiges in den letzten Tagen zusammensuchen und hab einige

Fallstricke kennengelernt.

Aus dem Grund: Wissen teilen ist ne feine Sache.

Was benötigt ihr von mir, damit ich euch bei der Doku unterstützen kann?

[Homoran]

Super!

Die alte Doku habe ich leider nicht mehr alleine geschafft aktuell zu halten, die Devs entwickeln schneller, als ich tippen kann.

Auch wollen wir schon seit längerem eine andere Basis für die Doku haben, deswegen ist an der alten (fast) nichts mehr gemacht worden. Schon gar nicht mit den neueren Adaptern. (Nur mal so als Entschuldigungsversuch)

Es wird eine Doku geben mit Tutorials und einen Teil mit Adapterreferenz.

Das Problem bei "externen" Quellen war leider, dass ich diese teilweise wegen fehlender Hardware nicht verifiziert habe und auch nicht pflegen konnte.

Wichtig ist daher auch die Kontinuität!

Was für ein Part schwebt dir den vor?

Gruß

Rainer

[apollon77]

@SolarisMUC Ich schick Dir gleich ne PN

[Homoran]

Ich denke/hoffe du hast da jetzt was

[SolarisMUC]

Ja alles im grünen Bereich

[xmace]

Hi zusammen,

ich hab vor ca. einem Jahr angefangen mich in das iobroker Thema einzuarbeiten und hab nun auch mittlerweile einiges geschafft und unser Smarthome mit >90 sensoren/aktoren und einigen skripten, adaptern & visualisierung aufgesetzt. Dabei bin ich durch viele unterschiedliche Themen gewandert mit den dazugehörenden Problemen:

• Iobroker installationen auf unterschiedlichen Platformen, Raspi, VM, Windows & als Docker

• Unterschiedliche Adapter (Homematic, Alexa, Denon, ical, Dashbuttons, Xiaomi, Zigbee, pilight, milight, spotify, fritzbox usw.)

• Multihost System mit Synology NAS & Raspi (da CC2531 Stick am Raspi zentral in der Wohnung)

• Diverse Skripte auf blockly & javascript (Temperatur & Luftfeuchtigkeitsregelung, Beschattungsautomatik, Anwesenheitserkennung, Aquarium Wasserwechselsteuerung, Beleuchtungsautomatik mit Bewegungsmeldern usw.)

Gerne würd ich mein Wissen auch an die Community weiter geben durch die ich selbst so viel gelernt habe.

In der Tat sind die ganzen Informationen teilweise sehr zerstreut in den Foren und Anleitungen zu finden und teilweise auch widersprüchlich (wenn die Adapter sich nicht richtig installieren lassen weil irgendwas fehlt grr)

Vielleicht können wir mal n Termin zum Skypen ausmachen & besprechen wie ich supporten kann.

Grüße,

Matze

[apollon77]

Hast eine PN

[dkleber89]

Hallo,

ich bin schon eine Zeit mit ioBroker unterwegs und habe auch ein Adapter den ich aufbaue und betreue.

Allgemein an alle die in dieses Projekt egal ob Core oder Adapter Zeit investieren -> EIN FETTES DANKESCHÖN!!!

Dokumentation ist ein wichtiges Thema das sehr gerne mal vernachlässigt wird. Deshalb würde ich gerne meinen Beitrag dazu leisten.

Es wird mangels Zeit vermutlich nicht allzu viel sein aber ich bemühe mich.
Github Username -> Der selbe wie hier

Mir ist noch aufgefallen das die Doku sehr versplittert ist (GitHub Wiki, ioBroker Website, ...) und das die einzige Möglichkeit auf die neue Doku zu kommen dieses Thema hier ist. Zumindest habe ich nix anderes gefunden . Ist das derzeit noch so gewollt?

Gruß

[Homoran]

@dkleber89 sagte in [Aufruf] Helft bei der neuen ioBroker-Dokumentation und -Adapter-Referenz mit!:

Ist das derzeit noch so gewollt?

Ja!

Im Moment "gilt" noch die alte Doku.
Adapterreferenz ist dort leider nicht auf Admin V2.
Neuere Adapter noch nicht implementiert.

Installation und Images sind immer aktuell

[Asgothian]

Ich spiele mit dem Gedanken zumindest für die Adapter die ich aktiv nutze an der neuen Doku mit zu schreiben - daher die Frage: welcher stand soll dokumentiert sein ?
Stable / Latest / github ?

A.

[Homoran]

@Asgothian
Latest wäre schon gut.

@all Dokumentators:
es sollte noch in jedem Header neben dem Datum auch die dokumentierte Version genannt werden!