Dokumentation verbessern

[henfri]

Hallo,

ich kämpfe mich gerade durch die Installation der USZU. Die Dokumentation dazu ist verteilt auf zwei githubs (https://github.com/mworion/uzsu_widget, https://github.com/mknx/smarthome/tr...p/plugins/uzsu) und zwei Foren-Threads.

Das ist nicht gut.

Es sind allerdings gute Beispiele in den Threads verteilt, die aber natürlich schnell untergehen und an aktuaität verlieren.
Wo ich gerade ohnehin dabei bin, mir die Informationen zusammen zu suchen, wäre es sinnvoll, diese gleich in ein Wiki zu übertragen. Für Smarthome.py haben wir ja bereits eins:
https://github.com/mknx/smarthome/wiki/SmartHome.pi

Aber für die Smartvisu gibt es sowas nicht, oder? Was wäre ein guter Platz hierfür?

Gruß,
Hendrik

[henfri]

Ich antworte mir mal selbst:

Kann es sein, dass das github Wiki sehr limitiert ist?
Auf https://github.com/mknx/smarthome/wi...ken-und-Howtos finden sich ja einige Logiken.
Jetzt wäre es ja super, wenn es ein automatisches Verzeichnis von Logiken gäbe. Wenn man eine Seite in https://github.com/mknx/smarthome/wiki/Logiken/ erstellt, würde diese in https://github.com/mknx/smarthome/wi...ken-und-Howtos verlinkt.

Geht sowas nicht?

Dieses wiki: https://github.com/snowplow/snowplow...-documentation sieht ja recht gut strukturiert aus. Aber ich glaube, das ist manuell gemacht, oder?

Gruß,
Hendrik

[henfri]

Mann, wenn man den Namen einer Seite ändert, ändert sich der Pfad zu der Seite und man muss alle Links nachpflegen. Grrr.

Ich habe aber mal ordentlich aufgeräumt.

Gruß,
Hendrik

[callidomus]

Hallo Hendrik,

danke für das Dokumentieren!

Mir ist nicht bekannt, ob/wie man das Wiki Automatisieren kann.

Bis bald

Marcus

[Orion]

Hallo Hendrik,

erst einmal danke, dass Du die Doku des Widgets auch auf das Plugin "rüberkopiert hast". Ich bin auch schon drüber gestolpert, dass gerade bei Themen plugin im backend (smarthome.py) und ein widget im frontend (smartvisu) an separaten Stellen zu finden sind. Ich habe mir das dann letztendlich zusammen in ein GIT gepackt, weil es ja auch eine Lösung für mich zu Hause ist (und nicht beide separat). Es sind halt zwei Projekte mit zwei Foren.
Fazit für mich ist auf jeden Fall mehr darauf zu achten in beide Richtungen zu Dokumentieren.

Zur Entschuldigung (zumindest etwas): Das UZSU Plugin hat es ja wenigstens offiziell in develop bei Marcus geschafft, dass ist beim widget dafür noch gar nicht bei Apollo passiert, zumal ja auch noch die Alternative von 2ndsky da ist. Für mich erschien eine einseitige Doku Zentral nur als Werbung für meine Lösung, und das will ich niemand aufzwingen.

Grüsse :-)

Michel

[henfri]

Oh, es gibt noch eine Alternative? Wo?

[Orion]

2ndsky hatte für seine Quad visu etwas gebaut, ist am anfang des Threads UZSU in der Smartvisu beschrieben. Es gab auch versuche, diese ohne Quad einzusetzen. Bin dort aber hängengeblieben.

[Echo]

Danke schön.