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

[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!

[thewhobox]

Hey,

ich hab mich ja in letzter Zeit ausgiebig mit dem Discovery Adapter beschäftig und hab eh viel darin geändert und unnötiges entfernt.
Würde mich daher gern anbieten die Doku für den Discovery Adapter sowie die Entwicklung (wie bringe ich meinen Adapter in Discovery) zu machen.

[x3l4]

Link aus dem ersrten Beitrag funktioniert nicht, Fehler 404!

[Homoran]

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

Link aus dem ersrten Beitrag funktioniert nicht, Fehler 404!

Siehe Announcements:
https://forum.iobroker.net/topic/22994/neue-dokumentation

[x3l4]

@Homoran auch auf https://www.iobroker.net kommt nur eine leere weiße Seite. Es ist sehr sehr mühsam sich alle benötigten Infos heran zu holen.

[Homoran]

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

kommt nur eine leere weiße Seite.

bei mir klappt dein Link auf Anhieb. (mal forced reload gemacht?)

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

Es ist sehr sehr mühsam sich alle benötigten Infos heran zu holen.

Kannst du das genauer erklären?

[OliverIO]

Mir ist noch ein Fehler in der neuen Doku zur Übernahme der Adapterdoku aus github aufgefallen.
Euer Markdown-Interpreter interpretiert die Tabellen anders.
Bei github können die führenden und abschließenden senkrechten Striche bei einer Tabellenzeile fehlen.
vgl. auch https://help.github.com/en/articles/organizing-information-with-tables
"The pipes on either end of the table are optional."

Bei euch leider nicht

Beispiel im Abschnitt Spieler
https://www.iobroker.net/#de/adapters/adapterref/iobroker.squeezeboxrpc/README.md
im Vergleich dazu im Abschnitt Player
https://github.com/oweitman/ioBroker.squeezeboxrpc/blob/master/README.md