Meeting für ioBroker Core/Dev/Admin 08.09.20 20:30
-
- demonstration Discord LiveChat community (Dutchman/JeyCee) 10 min
-
@carsten04 Naja wenn müsste man das mit React und so machen das die aktuellen Mechanismen die jetzt schon die Adapter DOku in die Webseite ziehen damit auch tun ... also vue vllt die falsche basis
-
@apollon77 Ich glaube gar nicht das das primär ein Vue-Thema ist. Ich bin eigentlich drauf gekommen, weil ich hier immer wieder Fragen zu meinem Adapter gestellt bekommen habe und dann überlegt habe wie kann ich das am Besten dokumentieren. Die jetzigen Adapter-Dokus sind immer ein großes "flaches" MD-File. Das ist gut für kleinere Dokus, wird aber schnell unübersichtlich, wenn es um eine etwas ausführlichere Doku gehen soll. Da fehlen einfach Strukturierungsmöglichkeiten (Sidebar, Menüs, Links etc.). Das alles liefert Vuepress, docsify und auch Andere. Es muß ja kein entweder oder sein. Eine Überlegung wäre z.B. einen zusätzlichen Link auf die GitHub Page in die vorhandene Doku zu setzen, für die Adapter die eben dann eine ausführlichere Doku benötigen und wo der Entwickler gerne aktiv werden möchte. Über Vuepress oder vergleichbar könnten wir dann ein Layout und eine initiale Struktur vorgeben, die immer genutzt werden sollte und bedarfsgerecht erweitert werden kann. Dies würde auch für den Anwender der Adapter einen Wiedererkennungseffekt haben. Die Umsetzung könnte dann z.B. in einem Doku-Template mit Erklärungen erfolgen, dass bei Bedarf vom Entwickler genutzt werden kann. Wenn wir dann noch für das Dokuprojekt eine Namenskonvention für GitHub festlegen, könnte mit geringem Aufwand auch die Verlinkung in der aktuellen Doku automatisiert erfolgen.
-
@UncleSam sagte in Online Meeting für ioBroker Core/Dev/Admin September Edition:
Wie sieht's mit Übersetzungen aus? Das ist ja im Thema zum letzten Meeting ausführlich diskutiert worden - mit einem Vorschlag von @Bluefox.
Bump... können/wollen wir das auch besprechen?
-
@UncleSam sagte in Online Meeting für ioBroker Core/Dev/Admin September Edition:
Bump... können/wollen wir das auch besprechen?
Was genau ? Thema Vorschlag bitte
-
@Dutchman Mein eigenes Zitat
Übersetzungen in allen Adaptern zentral führen und verwalten. Siehe auch https://forum.iobroker.net/topic/33630/online-meeting-für-iobroker-core-dev-admin-14-07-2020-20-30/70
-
@UncleSam sagte in Online Meeting für ioBroker Core/Dev/Admin September Edition:
@Dutchman Mein eigenes Zitat
Übersetzungen in allen Adaptern zentral führen und verwalten. Siehe auch https://forum.iobroker.net/topic/33630/online-meeting-für-iobroker-core-dev-admin-14-07-2020-20-30/70
Uff ja verstehe das war die Diskussion alles in Adapter Code mit words.js oder centraal
Das hatte auch ne Relation mit Admin 5 hmmm
Ich pak es auf die Liste nach dem Thema Admin 5 denke mal da ist ein Verband
-
- Fortschritt Windows Installer
-
@UncleSam sagte in Online Meeting für ioBroker Core/Dev/Admin September Edition:
@Dutchman Mein eigenes Zitat
Übersetzungen in allen Adaptern zentral führen und verwalten. Siehe auch https://forum.iobroker.net/topic/33630/online-meeting-für-iobroker-core-dev-admin-14-07-2020-20-30/70
@Dutchman sagte in Online Meeting für ioBroker Core/Dev/Admin September Edition:
Ich pak es auf die Liste nach dem Thema Admin 5 denke mal da ist ein Verband
Done
@sigi234 sagte in Online Meeting für ioBroker Core/Dev/Admin September Edition:
Fortschritt Windows Installer
Done
-
@sigi234 Uhh da bin ich gespannt
-
Ich denke auch js-controller 3.2 Status können wir nochmal drauf setzen. Ich will die Tage mal erstes Changelog machen und issues durchschauen was noch fehlt
-
@apollon77 sagte in Online Meeting für ioBroker Core/Dev/Admin September Edition:
js-controller 3.2
done
-
Ich hätte ein Vorschlag zur Struktur für das Doku-Thema:
Im Adapter gibt es ein Ordner doc
Darin gibt es eine Adapter.MD welche nur die Beschreibung des Adapters (also die Funktion des Adapters) in englischer Sprache enthält.
Weitere Sprachen dann z.B. in Adapter_de.MDAußerdem gibt es eine settings.md (englisch) plus weitere Sprachen als z.B. settings_de.md. In diesen wird die Konfiguration des Adapters beschrieben.
Diese wird in Abhängigkeit der in ioBroker konfigurieren Sprache über die Einstellungen der Instanz aufrufbar gemacht, falls die eingestellte Sprache nicht vorhanden ist wird einfach settings.md aufgerufen.
Lizenz und Changelog werden ebenfalls ausgelagert.
Die zentrale Readme.md verlinkt dann nur noch die Dokumente im Ordner doc.
Der Vorteil:
Die Adapter*.MD lässt sich sowohl in der Doku zu ioBroker einfach einbinden, als auch aus dem Admin aus der Liste der Adapter aufrufen. Hierüber erhalten die User die Info, was genau der Adapter macht und kann.
Die Settings*.MD wird ja dann für die Konfig des Adapters benötigt, daher der direkte Aufruf aus den Einstellungen der Instanz.
Die Frage wäre dann noch, wie die Struktur innerhalb der Dokumente aufgebaut sein soll und mit welchem Tool am einfachsten die anderen Sprachen erzeugt werden können oder ob z.B. der Admin direkt übersetzen kann.
-
@AggroRalf Die Namen muss man nicht "hart kodieren" und das ist schon definiert wie es geht
https://github.com/ioBroker/ioBroker.javascript/blob/master/io-package.json#L304-L316
Da sollten wir was definieren was darauf aufsetzt
-
- Welche NodeJS Version empfehlen wir, proposal : immer die LTS ! Anlass oAuth2 geht nur mit Node 12
-
@Dutchman Naja aktuell empfehlen wir nodejs 12 ... und ja ich denke es mit controller 3.2 demnächst zu ändern ist zu früh
Und das OAuth2 noch "12" ist ist blöd ... gibts issues bei denen?
-
@apollon77 sagte in Online Meeting für ioBroker Core/Dev/Admin September Edition:
Und das OAuth2 noch "12" ist ist blöd ... gibts issues bei denen?
wie meinst ? die habe in Major 4.x gerade auf 12 mandatory gewechselt und damit < 12 unsupported ist doch ok ?
-
@Dutchman ach so rum
-
@apollon77 sagte in Online Meeting für ioBroker Core/Dev/Admin September Edition:
@Dutchman ach so rum
alles gut, dachte schon reden aneinander vorbei
-
Hi All,
Der Termin steht fest ! 08-09 20.30-22.30
Location
Discord ioBroker communityVorbereitung
- Discord runterladen und installieren (iOS/Android oder PC/Mac/Linux)
- Den link folgen zu unserem server
- Vor dem meeting wird in der DEVELOPER Gruppe ein neuen talk kanal erstellt (OnlineMeeting)
- Während des meetings werden wir euch die Berechtigungen geben zum Entwickler damit alle die "versteckten" Gruppen sehen koennen
Warum Discord*
- Wir bauen dort gerade unsere support community auf
- Viele Entwickler sind bereits auf discord unterwegs
- Discord bietet uns sehr einfach die moeglichkeit Voice / Chat und Screensharing zu kombinieren
Bis nächsten Dienstag, ich freu mich drauf !
