Skip to content

Dokumentations-Support

Themen zur Erstellung der offiziellen Dokumentation

30 Themen 573 Beiträge

NEWS

Unterkategorien


  • Austausch zu der Bearbeitung einzelner Seiten

    12 286
    12 Themen
    286 Beiträge
    FeuersturmF
    @apollon77 Ich hab keine Stelle in der Doku gefunden wo ein relativer Link verwendet wird und funktioniert. Ich hab mich mal hier an das issue https://github.com/ioBroker/ioBroker.docs/issues/260#issuecomment-1826443729 dran gehängt.
  • Grundlagen der Struktur hinter der Doku

    Angeheftet
    1
    3 Stimmen
    1 Beiträge
    951 Aufrufe
    Niemand hat geantwortet
  • Neue Kategorie Dokumentationssupport

    Angeheftet
    16
    2 Stimmen
    16 Beiträge
    2k Aufrufe
    FeuersturmF
    @homoran Möchte mich auch an der Doku beteiligen. Hatte mir die Unterseite Repository schon einmal geschnappt und dort auch schon etwas bei mir vorbereitet. Werde auch noch einmal den link prüfen den du mir geschickt hattest. Kann heute abend schon einmal einen Beitrag im Unterforum posten.
  • Formelle Gesichtspunkte zur Doku

    Angeheftet
    12
    1
    0 Stimmen
    12 Beiträge
    2k Aufrufe
    crunchipC
    Soweit ich mich erinnern kann, sollte eigentlich wie in Variante 1 geschrieben werden, jedoch liegt das an der Übersetzung in mehreren Sprachen und funktioniert so nicht, daher hatte ich beim Schreiben Variante 2 verwendet.
  • Grundidee der Themenausrichtung der Doku

    Angeheftet
    77
    6 Stimmen
    77 Beiträge
    10k Aufrufe
    HomoranH
    @paul53 sagte: @homoran sagte: Ist alles gemerged content.md noch nicht? Doch! :joy: Danke für den Tritt! Hatte es irgendwie verschlafen. Github hatte sich immer wieder aufgehängt ("Checking for automerge" oder so), da muss ich es übersprungen haben
  • telegram-meue Menüstruktur HILFE

    bot dokumentation help wanted telegram-menue
    2
    0 Stimmen
    2 Beiträge
    145 Aufrufe
    HomoranH
    @aphofis bitte den Threadtitel aussagekräftig und verständlich gestalten
  • Vorschlag: RAG System für die Doku

    14
    1 Stimmen
    14 Beiträge
    875 Aufrufe
    Holger WillH
    @bloop so ein ähnliches Projekt mach ich auch gerade: https://github.com/Holger-Will/ioBroker.kiwi vielleicht kann man da ja zusammen arbeiten.
  • Doku: Anregung für Meeting März

    3
    3 Stimmen
    3 Beiträge
    2k Aufrufe
    wcag22W
    @feuersturm (Kopie zur Sicherheit an @apollon77) Das war eigentlich auch der Plan :-) Aber es scheint ja in dieser Kategorie auch den Einen oder Anderen erreicht zu haben. Einen schönen Sonntag noch in die Runde.
  • Änderungsvorschlag (PR)

    5
    0 Stimmen
    5 Beiträge
    604 Aufrufe
    wcag22W
    @mcm57 Oi, ja danke. Das sollte ich später mal selbst tun, oder? Geht das direkt aus GitHub? (Also doch noch nicht alles gelernt). :-)
  • Starthilfe erbeten

    5
    0 Stimmen
    5 Beiträge
    668 Aufrufe
    mcm1957M
    @apollon77 Ja, wenn man direkt auf der GH Seite editieren will und noch keinen Fork hat, dann legt GH einen an. Muss man nur bestätigen dass man das will / erlaubt.
  • Anregung Thema Updates

    45
    1 Stimmen
    45 Beiträge
    6k Aufrufe
    apollon77A
    Hi, interessantes Thema. Ich habe das Gefühl (was das Thema nicht abwerten soll!) das @Ro75 zur Minderheit der User gehört die die Details wissen wollen und verstehen wollen. Die allermeisten updaten nur und genug klicken auch Hinweise zu Breaking changes weg ud wundern sich das es dann nicht geht. ;-) (nein, ich wikll nicht die Diskussion erweitern!) Generell stimme ich zu das, wenn es sinnvoll ist, man mehr Details als Entwickler liefern kann. In vielen Fällen würde das aber mehr Infos verursachen, die dann wieder noch weniger User lesen. Oder man müsste wirklich Admin und GitHub News/Changelog getrennt erstellen was wieder viel Aufwand beim Entwickler verursacht. Auf Issues verlinken mag eine Idee zu sein, aber aus der Erfahrung liesst das erst recht wieder "keiner" weil sich auch da ja ggf Seitenlange Diskussionen mit Logfiles und Iterationen von Änderungen verbergen - aber es eine End-Zusammenfassung am Ende nie gibt. Wenn ich als Entwickler Fehler behebe die berichtet wurden oder Sentry-Crashes abarbeite dann steht da ein "Prevent Crash cases" im changelog weil es so ist - auch wenn ich verstanden habe wann die Zustandegekommen sind bin ich der Meinung das es nicht zielführend ist das zu erklären weil teilweise sehr speziell. Bei Adaptern wie Alexa2 oder Meross oder so wo es am Ende externe Systeme der Hersteller gibt versuche ich immer zu schreiben ob Änderungen aufgrund von Änderungen der Hersteller gemacht wurden oder ob es Feature sind die dazu kommen. Aber auch bin ich nicht des Mehrwerts eines "ins Detail gehen" sicher. Das Ziel des "Stable" Repos ist es das man idealerweise Adapter updaten kann wie seine Windows oder App-Store software ... da liesst doch auch keiner Changelogs - soweit es die überhaupt sinnvoll gibt. Stable Updates waren vorher mindestens 2 Wochen in latest ... wer hier sicherstellen will ob es Fehler gibt schaut idealerweise ins GitHub. Aber die Erwartung ist das es simpel ist. Das gute bei ioBroker ist das man im Einzelfall sich nur die alte Version merken (oder aus Logfile ziehen muss) und wieder downgraden kann. Und das ist - von viel Feedback - das was, meiner Erfahrung nach, die meisten User wollen. Update und es geht. Es gibt immer Sonderfälle - sei es "uralt Tablet Inkompatibilitäten in Vis" die unabsichtlich reinkommen weil kein Entwickler so ein altes Gerät hat und. Muss gemeldet werden und dann kann man entscheiden ob es gefixt wird oder halt so ist (Ja vor allem bei "Uralt Browsern" ist das immer eine Diskussion - kenn ich auch aus der Firma :-) ) Bei einem Adapter wie "zigbee" wegen Probleme in einzelnen Versionen komplett alles neue zu verteufeln ist auch der falsche Ansatz :-) Also lange rede kurzer Sinn: Man kann das Thema gern mal mit ins nächste Entwicklermeeting nehmen um dort noch einmal die Entwickler zu bitten detaillierter zu sein und nicht zu knapp - wenn sinnvoll. Ich glaube aber das Du da eine Ausnahme bist (vllt neben mir selbst ... ich schaue in meinem Produktivsystem auch eher 3 mal hin bevor ich was aktualisiere). Ingo
  • Aufruf zur Unterstützung für Backitup Wiki

    43
    3 Stimmen
    43 Beiträge
    6k Aufrufe
    simatecS
    @crunchip sagte in Aufruf zur Unterstützung für Backitup Wiki: @tt-tom sagte in Aufruf zur Unterstützung für Backitup Wiki: Und dieser Token ist der Root-Token. https://www.rajchert.net/?p=1026 Aufgrund des defekten Links habe ich eine eigene Anleitung geschrieben. https://github.com/simatec/ioBroker.backitup/wiki/Diverse-Anleitungen-für-ioBroker.backitup#operator-token-für-influxdb-2x-wiederherstellen
  • Adapter-Doku auf Github aktualisieren

    1
    0 Stimmen
    1 Beiträge
    378 Aufrufe
    Niemand hat geantwortet
  • Adapter heatingcontrol Doku

    10
    0 Stimmen
    10 Beiträge
    2k Aufrufe
    AndreiosA
    @rene_hm sagte in Adapter heatingcontrol Doku: @andreas-5 Der Fehler im heatingcontrol-Adapter wurde gefunden und wird demnächst behoben. ABER: die gleiche Doku steht im github in der jeweiligen readme des Adapters. Hi Rene, danke, da habe ich inzwischen auch den link bekommen, wie ich auf github die Doku in Deutsch finde und werde mich damit beschäftigen, sobald ich zu Hause wieder Zeit dafür finde.
  • Git clone iobroker.docs unter Windows nicht möglich

    git windows
    3
    2
    0 Stimmen
    3 Beiträge
    718 Aufrufe
    AlCalzoneA
    @feuersturm sagte in Git clone iobroker.docs unter Windows nicht möglich: Kennt jemand eine Alternative / Workaround, wie ich unter Windows so ein Repository clonen kann? Du könntest einen sparse checkout probieren, bei dem das Verzeichnis nicht ausgecheckt wird. https://stackoverflow.com/a/63786181/10179833
  • Nutzung von draw.io für Grafiken in der Doku

    doku
    6
    1
    1 Stimmen
    6 Beiträge
    1k Aufrufe
    HomoranH
    @ostfrieseunterwegs sagte in Nutzung von draw.io für Grafiken in der Doku: Weil es Cloud oder Desktop anbietet. und den hab ich nicht mehr gefunden. Bist du sicher, dass das nicht nur ein Frontend-Install ist, die Arbeit aber offline gar nicht möglich ist
  • 2 Stimmen
    1 Beiträge
    547 Aufrufe
    Niemand hat geantwortet
  • Diskussion zur Strukturierung einer Doku-Seite

    Verschoben
    37
    0 Stimmen
    37 Beiträge
    6k Aufrufe
    crunchipC
    @oliverio sagte in Diskussion zur Strukturierung einer Doku-Seite: oder gar neu mit Linux. Viele Begriffe, Befehle die im Forum so rumschwirren sind böhmische Dörfer. man hat überhaupt gar keine Ahnung was es bedeutet richtig, ein Beispiel der User schildert sein Problem, man antwortet, zeig mal die Ausgabe von iob update -i apt policy nodejs als Antwort erhält man die Ausgabe, mit dem Text, Fehler besteht weiterhin es gibt soviele User die hier um Rat fragen, man geht das Problem mit ihm durch, letztendlich aber gar keinen Plan haben, was sie da eigentlich abtippen, bzw was diese Befehle bewirken/bedeuten. Man kann nicht erwarten, das man sich vorher komplett einliest in sämtlichen Themenbereiche, die Zielgruppen sind total unterschiedlich, vereinfacht ausgedrückt der eine möchte etwas steuern, "bisschen Smarthome", der andere etwas auslesen, Statistiken..(Strom,Heizung), User A sucht bewusst nach einer Möglichkeit dies zu tun, User B kommt durch Zufall auf iobroker. Schnell installiert(stellt sich das leichter vor als gedacht), und nun erkennt er erst, was da alles dran hängt, was da alles zu tun ist, mit was man sich alles auseinander setzen muss und denkt sich...ich wollte doch eigentlich nur... doch da ist er schon mittendrin und letzendlich hilflos anderes Beispiel Probleme bei der Installation einer InfluxDb, klar man kann auf die offizelle Seite verweisen, ein Linuxfremder tut sich da allerdings sehr schwer, zum einen, weil er die Bedeutung der Befehle nicht kennt, nicht versteht, was er da eingeben muss, das mancher Befehl noch angepasst werden muss, oder gar die Info fehlt, dass das ein oder andere Packet noch nachinstalliert werden muss
  • Formatierungshilfe gesucht

    6
    1
    0 Stimmen
    6 Beiträge
    1k Aufrufe
    HomoranH
    @crunchip @AlCalzone sieht auf github schon mal vielversprechend aus [image: 1642776951518-readmore_md.png] Mal sehen wie es auf der Website nach dem nächsten Build aussieht DANKE

647

Online

32.4k

Benutzer

81.4k

Themen

1.3m

Beiträge