Dokumentation

[Homoran]

Jetzt wo du wieder aus dem Urlaub bist (ich hofffe du hhast dich erholt) wirst du sowieso wieder schneller programmieren als man die Doku schrieben kann.

Der Entwurf ist bereits überholt, bevor er online ist :mrgreen:

Gruß

Rainer

[pix]

Hallo,

habe mich zuletzt gekümmert, bei einigen Dokus neue Screenshots zu einzubauen. Seit dem großen Admin Update sieht ja alles anders aus.

Man kann natürlich nur Adapter dokumentieren, die man selbst nutzt und versteht. So kann ich zB die Nutzer/Entwickler vom Yamaha/Onkyo/Miele/Samsung/etc.-Adapter nur um Unterstützung bitten zumindest Screenshots sinnvoller Adaptereinstellungen und eine Liste der Datenpunkte zu liefern.

Der Fritzbox-Adapter ist auf github sehr gut dokumentiert. Großes Lob, sowas kann ich 1:1 übernehmen (wenn ich darf).

Gruß

Pix

[ruhr70]

@pix:

Der Fritzbox-Adapter ist auf github sehr gut dokumentiert. Großes Lob, sowas kann ich 1:1 übernehmen (wenn ich darf).

Gruß

Pix `

Klar darfst Du. Ist Open Source :mrgreen:

mctom hatte schon Teile übernommen.

http://www.iobroker.net/?page_id=2847&lang=de

Ich bin mir nur generell etwas unschlüssig, was man am Besten macht. Normalerweise sollte die Doku für einen Adapter im Detail auf Github gepflegt sein (Versionen, Beschreibung, Screenshot, usw.). Wenn man die gleichen Infos dann auf der ioBroker Homepage hat, muss es bei Änderungen doppelt gepflegt werden.

Habe aber keine bessere Idee oder Lösung. Ggf. die grundlegende Funktion in iOBRoker mit Screenshots und Beispielen zur Anwendung, ggf. mit anderen Adaptern und die Details in Github?

[Homoran]

@ruhr70:

Normalerweise sollte die Doku für einen Adapter im Detail auf Github gepflegt sein (Versionen, Beschreibung, Screenshot, usw.). Wenn man die gleichen Infos dann auf der ioBroker Homepage hat, muss es bei Änderungen doppelt gepflegt werden. `
Das ist immer ein Dilemma, zumal mit dem Hilfe-Icon (="?") im admin immer auf Github verlinkt ist und nicht auf die Website.

Gruß

Rainer

[OstfrieseUnterwegs]

Kann man nicht das README.md von github als iframe in die webseite einbinden?

[Bluefox]

@OstfrieseUnterwegs:

Kann man nicht das README.md von github als iframe in die webseite einbinden? `
Wenn Readme existiert, es ist kein Problem den Inhalt zu kopieren. (Englisch ) Oft aber Readme besteht aus zwei Sätzen.

[OstfrieseUnterwegs]

@Bluefox:

Wenn Readme existiert, es ist kein Problem den Inhalt zu kopieren. (Englisch ) Oft aber Readme besteht aus zwei Sätzen. `

Das ist richtig. Ich dachte eher daran, dass man sich dann nicht entscheiden muss, ob Website oder git. IFRAME hat gegenüber Kopieren den Vorteil, dass man keinen manuellen Schritt hat und der admin nicht immer aufpassen muss, ob es evtl eine neue Doku auf git gibt.

[Bluefox]

@OstfrieseUnterwegs:

@Bluefox:

Wenn Readme existiert, es ist kein Problem den Inhalt zu kopieren. (Englisch ) Oft aber Readme besteht aus zwei Sätzen. `

Das ist richtig. Ich dachte eher daran, dass man sich dann nicht entscheiden muss, ob Website oder git. IFRAME hat gegenüber Kopieren den Vorteil, dass man keinen manuellen Schritt hat und der admin nicht immer aufpassen muss, ob es evtl eine neue Doku auf git gibt. `
Es sieht nicht schön aus. 8-)

[Homoran]

@Bluefox:

Wenn Readme existiert, es ist kein Problem den Inhalt zu kopieren. (Englisch) `
Auch das Übersetzen sollte nicht das Problem sein, das schaffe ich schon.

Ich denke wir werden ZUSÄTZLICH noch einen Link auf GitHub setzen.

Ich weiß: Kassel ist ja auch schon bald - aber das wird schon.

Ich muss mich nur nach meiner "Auszeit" auch wieder einarbeiten.

Gruß

Rainer

[pix]

Der Link zu Guthub ist doch in der Adapterbeschreibung der Webseite oben schon enthalten.

Unten sollte der Adapter erklärt werden. Worum geht es, was kann, wie setzt man ihn ein. Schön sind auch Beispiele (wie im Nachbarthread: VIS Widget zum Toggeln einer Szene aus dem Scenes-Adapter).

Ich finde, im Admin Reiter sollte weiterhin der Link zu Github stehen.

Gruß

Pix

[Homoran]

Sorry pix,
@pix:

Der Link zu Guthub ist doch in der Adapterbeschreibung der Webseite oben schon enthalten. `
Habe mir die neue Version noch nicht so intensiv angesehen. :oops:

Dann ist ja alles da!

@pix:

Ich finde, im Admin Reiter sollte weiterhin der Link zu Github stehen. `
sehe ich auch so.

Allerdings gehen ja auch Leute auf die Website um sich vorab zu informieren, bevor sie ioBroker installieren.

Daher sollte da beides stehen.

Gruß

Rainer