IoBroker start
-
Was ist schlimm daran, die fhem doku als vorbildlich darzustellen? `
Das ist schon in Ordnung. Und konstruktive Kritik ebenfalls. Aber bei:
@Bambo:Ich muss mir echt überlegen, wo meine Reise hin geht. Bin zur Zeit wirklich am überlegen. ioBroker war mein Firstshot… `
fehlt mir irgendwie das konstruktive.Auch einem Programm das in Version 0.5.9 ist, die schlechte Doku vorzuwerfen und mit dem Zustand eines Programms zu vergleichen, das in v5.6 ist (also 10x so weit) ist schon weit hergeholt.
und in der von mir verlinkten Anleitung ist sogar der Hinweis auf die fehlende Aktualität der github Version enthalten:
` > <size size="150">Vorbereitung der ioBroker Installation</size>Gemäß der Anleitung von Manual installation of ioBroker.js-controller on Debian based Linux sowie den zwischenzeitlich durchgeführten und auf github noch nicht aktualisierten Änderungen arbeiten wir uns Schritt für Schritt durch und installieren die Pakete `
Mich würde schon interessieren, wie die Doku bei fhem 0.5 war.
Gruß
Rainer
-
Du scheinst dich persönlich angegriffen zu fühlen, wofür nach meinem Verständnis kein Grund vorliegt.
Die von dir verlinkte "Doku" muss man erst mal finden und die Frage, warum man die zwei Sätze auf github nicht aktualisiert, dürfte berechtigt sein.
Man muss nicht nur mit eigenen Augen schauen sondern sich Standpunkte dritter berücksichtigen, wenn man nicht betriebsblind agieren möchte.
-
Ich fühle mich keinesfalls persönlich angegriffen, wieso auch, ich bin nur ein "normaler user", der ioBroker testet.
Ich reagiere nur ziemlich allergisch auf das Anspruchsdenken einiger Zeitgenossen (ist jetzt nicht alles auf dich bezogen). Es ist für mich nicht nachzuvollziehen:
Die Software muss kostenlos sein (Geiz ist ja ach so geil), am besten muss eine Hochglanzhandbuch mit allen Eventualitäten und Sonderfällen dabei sein. Und weil dann so ein Handbuch einfach zu umfangreich ist, wird es nicht mehr gelesen und die einfachsten Anfängerfragen hundertfach in einem Forum gestellt. Da soll dann innerhalb von Minuten eine Reaktion des Entwicklers erfolgen, da es seine "Aufgabe" ist, das in seiner Freizeit entwickelte Produkt rund um die Uhr zu betreuen.
Tut mir leid, solche Posts tauchen immer wieder in den Foren auf und sie ko…. mich wirklich an.
Das mit dem Auffinden gebe ich dir zum Teil recht, die Anleitung war vorher in einem Thread mit dem sinnvollen Namen "Anleitungen und Hilfe".
http://forum.iobroker.org/viewtopic.php?f=8&t=242
Wer den findet, findet dort immerhin noch den Link zu der aktuellen Anleitung.
und den Rest:
@Bambo:…und die Frage, warum man die zwei Sätze auf github nicht aktualisiert, dürfte berechtigt sein.
Man muss nicht nur mit eigenen Augen schauen sondern sich Standpunkte dritter berücksichtigen, wenn man nicht betriebsblind agieren möchte. `
gebe ich dir auch in allen Punkten recht. Ich hatte das -s.o.- auch nicht persönlich genommen sondern nur einen Erklärungsversuch unternommen, dass es gerade mit den Installationsroutinen teilweise fast täglich zu Änderungen gekommen ist und es IMHO dann verständlich ist, dass ein tägliches Update der Doku nicht mehr stattfindet, wenn sich am nächsten Tag rausstellen könnte, dass wieder umgestellt werden muss.…ich denke damit sollten wir es jetzt bewenden lassen
Gruß
Rainer
-
auf den Punkt gebracht: einem geschenkten Gaul schaut man nicht ins Maul.
Dass es vereinzelt noch im Argen liegt, das wissen wir alle. Entscheidend ist der gute Wille und die Unterstützung in der Community, und die ist hier gegeben. Ich bin im Moment auch am Einarbeiten, was auch hier etwas holperig vonstatten geht.
Immerhin gibts Leute wie z.B. homoran, die sich sehr um die Dokumentation kümmern in der Absicht, den Entwickler zu entlasten. Das find ich schon mal sehr gut. Kritik ist gut, aber sie muss konstruktiv sein.
Zudem: bei FHEM lief auch nicht immer alles so rund. Soweit ich mich erinnere, wurde dort anfänglich ein Wiki sehr angefeindet. Auch dort musste man anfänglich die Informationen mühsam zusammensuchern. Wer nicht Perl konnte war aufgeschmissen. Wie sich das heute präsentiert, entzieht sich meiner Kenntnis. Immerhin gibts FHEM schon sehr viel länger.
Wie auch immer: ein Hobby-Projekt kann nicht perfekt sein, das liegt in der Natur der Sache.
Gruss
starfish
-
Morgen Bambo, Rainer,
wollen wir die Energie nicht in die Verbesserung der Doku/Wiki Seiten stecken? Mich hat es auch schon gestört das auf Github falsche/veraltete Informationen stehen. Dies ist für ioBroker Anfänger sonst eine zu große Hürde veraltete Information als solche zu erkennen.
@Rainer/Homoran:
Gerne helfe ich mit Github mit Deinen tollen Ergebnissen/Informationen zu aktualisieren. Auf Englisch? Sollten wir das mit Blutfox abstimmen?
Wenn Du willst könntest Du das Ergebnis "reviewen"?
Danke
Steve
-
Hallo Steve,
Ich habe keine Ahnung von github, wollte mich da nicht auch noch einarbeiten, zumindest jetzt nicht.
Da ist deine Idee richtig gut. Was das koordinieren mit Bluefox angeht, da gibt doch so was wie pull request oder so. Wenn ich das richtig verstanden hab.
Im Moment (wenn es die Zeit erlaubt) durchforste ich alle möglichen ioBroker Seiten und binde deren Infos in meine Doku ein. Dabei versuche ich nach bestem Wissen diese auf den neuesten Stand zu bringen und auf deutsch zu übersetzen.
Jetzt willst du das wieder auf englisch übersetzen! [emoji2]
Natürlich ist englisch die erste Wahl! Aber ich musste schon innerlich lachen.
@all
Auch ich bin über konstruktive Kritik an "meiner" Doku genauso interessiert, wie an Unterstützung bei z.B. Adaptern, die ich nicht testen kann, weil mir du Hardware fehlt.
Gruß
Rainer
Gesendet von meinem Cynus T7 mit Tapatalk
-
Moin, moin Rainer,
Sprache:
na Englisch muss es nicht unbedingt sein…im Ausland fragen mich alle sofort ob ich Russe oder Schweden bin (wegen des starken Akzents).
Ich denke aber wir erreichen damit mehr Leute, es wundert mich sehr das Homematic Themen sehr auf den deutschen (russischen) Sprachraum fokussiert sind.
Interessiert sich keiner in USA für Homematic?
Github Readme:
Mir fallen vor allem die README.MD ins Auge…
Hast Du schon Webstorm in Verwendung? Das würde auch den Umgang mit Git erleichtern und das brauchen wir wohl für die README.MD. Obwohl man kann wohl auch direkt diese README.MD im Browser bearbeiten. Bei https://github.com/ioBroker/ioBroker/bl ... /README.md gibt es rechts oben ein Bleistift Symbol...
Doku:
Ich befürchte die Informationen in einer (Deiner) Doku und im Web/Wiki zu pflegen macht zu viel Arbeit und wird wohl nie in "sync" sein. Kann man nicht aus Wiki ein Worddoku exportieren?
Hardware:
Welche Hardware meinst Du?
Danke
Steve
-
Ich bin doch auch nur ein user und ein kleines Licht.
Ich finde es ganz lieb von euch, was ihr mir alles zutraut.
Ich kann kein PHP, kein HTML, kein JavaScript und mit Linux beschäftigte ich mich erst knapp ein Jahr. Da kann ich das nötigste nachvollziehen.
Was den sync der verschiedenen Anleitungen angeht, hast du wohl recht.
Allerdings liegen die infos bei github auf vielen verschiedenen seiten und selbst mir ist es schwergefallen mich da halbwegs durchzufinden. Für absolute ioBroker Anfänger ohne weitere Kenntnisse wird das praktisch unmöglich. Und für das Klientel sollte meine Anleitung sein, weil ich vor einem Jahr mit ccu.io in der gleichen Lage war.
Hardware meine ich z.b. hue, knx, z-wave und später vielleicht Fritz. Wenn die Adapter dann so weit sind.
Gruß
Rainer
Gesendet von meinem Cynus T7 mit Tapatalk
-
Reviewing und Rektorat würde ich meine Dienste zur Verfügung stellen.
Für eine allgemeine doku muss es nach meiner Meinung eine einzige Anlaufstelle geben aus mehreren gründen wie Wildwuchs Verhinderung, Aktualität und Auffindbarkeit um nur die wichtigsten zu nennen.
Meines Erachtens kann das in einer verteilten arbeitsstruktur nur ein wiki sein.
Gruß
Stephan
-
Ich hatte das schon mal an anderer stelle geschrieben.
Ich persönlich sehe für ein wiki und eine Anleitung verschiedene Zielgruppen.
Ein wiki stellt meistens die einzelnen Punkte losgelöst vom ganzen sehr detailliert dar, während eine Anleitung den Überblick und die Grundzüge für Anfänger zur Verfügung stellt.
Selbstverständlich hast du in allen Punkten, du du für ein wiki anführst recht, das unterstütze ich auch, aber zusätzlich sollte es eine Anleitung für Anfänger geben.
Gruß
Rainer
Gesendet von meinem Cynus T7 mit Tapatalk
-
Ich kann kein PHP, kein HTML, kein JavaScript und mit Linux beschäftigte ich mich erst knapp ein Jahr. Da kann ich das nötigste nachvollziehen. `
Eingefuchste User schreiben die besten Anleitungen, das ist kein Witz, in meiner langjährigen Berufstätigkeit habe ich genau die Erfahrung gemacht.Ansonsten fände ich ein zentrales Wiki für die jeweils aktuelle Dokumentation die beste Lösung. Eine separate Anleitung für Anfänger könnte problemlos integriert werden.
gruss
starfish
-
Hallo Leute
es ist spannend zu lesen wie die Meinungen so sind.
Und am Ende kommt herraus… : Wie wollen alles das gleiche
Meine Eindrücke:
Als ich das erste mal von ioBroker gelesen hatte habe ich mich auch mal auf die suche gemacht. Und ich muste feststellen, es war sehr verwirrend.
Da gibt es ..
- .domesticate the Internet of Things http://www.iobroker.org
[http://homematic-forum.de/forum/viewtop … 48&t=19642](http://homematic-forum.de/forum/viewtopic.php?f=48&t=19642) [http://forum.iobroker.org/index.php](http://forum.iobroker.org/index.php) [http://preview.iobroker.com/en/](http://preview.iobroker.com/en/) [http://preview.iobroker.com/de/](http://preview.iobroker.com/de/) [https://www.npmjs.com/package/iobroker.hmm](https://www.npmjs.com/package/iobroker.hmm)Und nun stellt man sich die Frage: Wo fange ich an.
Nach etlichen gehversuchen habe ich nun eine "Test"-Version laufen.
Nach dem Anmelden hier im Forum wurden einige Sachen klarer.
Leider ist die Struktur hier im Forum auch nicht so, dass man es einfach hat. Alle Themen sind zusammen in einem Bereich. Ja ich habe auch schon gesehen, dass es "nur" 2 Administratoren gibt. Die/Der sind sicher mit dem Programieren ausgelastet und können sich nicht aich noach mit dem Forum beschäftigen.
Vorschlag:
1.) Moderatar für das Forum suchen/benennen
2.) Struktur in die Themen bringen. z.B. Bereiche für -Entwicklung -Installation -Hardware -Adapter - um nur einige zu nennen. In jedem Bereich dann ein HowTo
3.) Auf den vorhandenen Internet-Seiten auf das Forum verweisen.
Wenn hier dann ein HowTo auf einem guten Stand ist kann man es dann richtung Wiki zu bringen.
Es wurde ja auch schon einige male erwähnt: Jeter neue User hat unterschiedliche Vorkenntnisse. Daher bleibt es schwirig ein HowTo zu schreiben was allen gefällt.
Das soll es von meiner Seite gewesen sein. (hoffe es wird konstruktiv aufgenommen) Dann mach ich mich mal wieder an den Docker-Test und dessen Doku ran
Gruß
derAuge
-
Das mit der Struktur kann ich ebenfalls voll unterstützen.
In grauer Vorzeit wurde ein entsprechender Vorschlag mit der damals sinnvollen Begründung abgetan: dazu gibt es noch zu wenige Threads.
Inzwischen ist das ganze gewaltig gewachsen und eine übergeordnete Struktur wäre sehr hilfreich.
Gruß
Rainer
Gesendet von meinem Cynus T7 mit Tapatalk
-
Das ist zum einen Detailfrage, zum anderen kann man in einem Wiki auch einen Punkt "Fsrst Steps" oder "Installation" aufführen.
-
Hallo,
das sind ja klasse Ideen…wirklich sehr interessante Entwicklung.
Fragen:
Wie wollen wir weiter vorgehen? Ich würde gerne vermeiden zu sagen "Schön das wir darüber gesprochen haben"
Wer ist denn der Forums Admin? Bluefox?
Was machen wir mit der "Mehrsprachigkeit"? Vorschlag: Forum: Deutsch/Russisch und Wiki Englisch?
Wiki…gibt es doch schon? https://github.com/ioBroker/ioBroker/wiki
Was machen denn unsere russischen Kollegen? Trotz Google Translate komme ich nicht ganz klar.
Vorschlag (um mal Ross und Reiter zu nennen)
-
Ich mache weiter mit dem Github Wiki mit der Einführung von ioBroker Programmierung? Falls jemand mitmachen will…:-)
-
Die Forums Struktur wie "derAuge" und Comoran vorgeschlagen übernehmen...kann man ja immer noch später anpassen.
Wie seht Ihr das?
Danke
Stefan
-
-
Hallo,
das sind ja klasse Ideen…wirklich sehr interessante Entwicklung.
Fragen:
Wer ist denn der Forums Admin? Bluefox? `
http://forum.iobroker.org/memberlist.php?mode=leaders
Das Team Administratoren Hauptgruppe Foren Bluefox Administratoren - hobbyquaker Site Admin Administratoren - -
Die Doku war doch schon bei ccu.io der Schwachpunkt. Da gibt es eben jemanden, der programmiert lieber, als dass er dokumentiert. Ich persönlich hab da ne Menge Verständniss für, ich finde die schreiberei auch ätzend. Aber ohne Doku geht es nicht. Und das kann nicht ein Fitzel in jenem Forum und ein anderer Fitzel in einem anderen und wieder mal ein veralteter Teil auf github sein. Das sorgt nur für Frust. Wirklich.
Aber die Doku bei fhem zum Beispiel ist vorbildlich. Da ist alles dokumentiert. Konsequente Nutzung eines Wiki, alle Module, jeder Aufruf, jeder Parameter, alles da. Liegt vermutlich auch an dem universitären Background mit Bildungsauftrag einiger Beteiligter da. Aber das macht die Sache im Ergebniss für Endanwender schon verständlicher.
Und eines weiss ich aus meinem Job, Doku wird nicht einfacher, wenn man später damit damit anfängt…:-) `
Seit September habe ich ioBroker Struktur 4 Mal umgeworfen:-
CouchDb raus
-
Redis raus
-
Namen geändert
-
Verzeichnisstruktur verändert..
Installation-Verfahren hat sich 3 mal geändert….
Wenn ich ausführliche Doku hätte, dann sollte ich auch die umschreiben. Jetzt steht das Gerüst und es ist ein guter Punkt mit der Doku zu anfangen..
Ich weiß, dass Projekt ohne Doku zum Sterben verurteil ist und wir werden auf jeden Fall die Doku ergänzen.
Es war nur wirklich zu früh für die Doku.
Es sind schon die erste Seiten auf dem Wiki zu finden. Weiter wird besser gehen. Bleibt dabei.
-
-
Vorschlag:
1.) Moderatar für das Forum suchen/benennen
2.) Struktur in die Themen bringen. z.B. Bereiche für -Entwicklung -Installation -Hardware -Adapter - um nur einige zu nennen. In jedem Bereich dann ein HowTo `
Gibt es freiwillige?3.) Auf den vorhandenen Internet-Seiten auf das Forum verweisen.
Wenn hier dann ein HowTo auf einem guten Stand ist kann man es dann richtung Wiki zu bringen. `
Kann ich machen.Ich habe mir vorgestellt, dass "https://github.com/ioBroker/ioBroker/wiki" wirklich eine Zentralstelle für alle Doku ist. Vielleicht jeder Adapter eigene Wiki haben wird, aber von Hauptseite werden auf jeden Fall die Links dorthin sein.
@Homoran: es ist wirklich nicht kompliziert eine Wiki auf github zu editieren. Da hat das Verfahren mit Kode-Verwaltung nichts zu tun.
Mach bitte einen Login bei github auf.
Und dann editierst du einfach Text online und danach drückst Save.. Das war es. Wie hier im Forum.Wir können alle Änderungen sehen, auch editieren und wenn nötig sogar zurückziehen. Du kannst nichts kaputt machen.
Du kannst auf Deutsch schon mal dein Artikel hier https://github.com/ioBroker/ioBroker/wi … -(Deutsch) reinkopieren und wir werden dann das auf English und Russisch übersetzen:
-
ja, ja,
ich denke das bekomme ich irgendwann auch noch hin.
Habe jetzt einen privaten Account angelegt - ohne repo (kosten die Geld?)
Dann habe ich testweise etwas angelegt, sollte im Wiki - Deutsch erscheinen.
Ist aber irgendwie im Daten-Nirvana verschwunden.
jetzt erzähl mir nichts von fork und request, soweit bin ich noch nicht
Habe noch genug andere "Probleme":
- Muss ich irgendwo noch links setzen?
kann eine "Seite" nur begrenzte Anzahl Zeichen haben? Wie bekomme ich Bilder rein?Gruß
Rainer
-
Hallo Rainer,
also ich habe vor kurzem auch meine Anlaufschwierigkeiten mit dem Github Wiki gehabt.
Kurz ein paar Tips:
-
Im Wiki regelmäßig speichern (5-10 Min.).
-
Grafiken lege ich auf Github ab und dann den Link/URL in den Wiki aufnehmen. Wichtig dabei ist, ein Grafik braucht eine URL zum Einbinden. Vielleicht gibt es eine bessere Lösung, als die:
a) Auf Github ein neues Project anlegen wie "iobrokerWiki"
b) Dieses leere Github Projekt in Webstorm "auschecken"
…und einloggen
c) Ins lokale Webstorm Projekt die Grafiken/Screendumps kopierend) Von Webstorm regelmäßig die Änderung auf Github pushen.
Steve
-
