Dokumentation

Open DIY Projects Stuhlkreis WiFree Copter Dokumentation

Dieses Thema enthält 22 Antworten und 4 Teilnehmer. Es wurde zuletzt aktualisiert von  kreativmonkey vor 1 Jahr, 9 Monate.

Ansicht von 15 Beiträgen - 1 bis 15 (von insgesamt 23)
  • Autor
    Beiträge
  • #4054

    kreativmonkey
    Teilnehmer

    Um das Forum sauber zu halten möchte ich hier ein Topic zur weiteren Diskussion rund um das Thema Dokumentation einrichten. Es geht darum die Fakten aus dem Forum an einer zentralen Stelle zu sammeln. Somit kann nicht nur der Einstieg erleichtert werden sondern auch viel Zeit gespart werden beim wiederauffinden von z.B. Anleitungen und co.

    Ein Forum bietet sich perfekt an zum austausch von Informationen und Diskutieren über einzelne Themen. Jedoch stellt es keine Wissensdatenbank/Dokumentation dar sondern nur eine unstrukturierte Ansammlung von Wissen, Fakten und Off-Topic.

    Ich finde das WiFree Projekt großartig und würde mich freuen es mit einer gemeinsam gepflegten Dokumentation weiter verbessern zu können. Derzeit habe ich auf meinem [Git-Server](https://git.calyrium.org/WiFreeCopter/dokumentation) angefangen eine Dokumentation zu schreiben. Gerne könnt ihr euch dort anmelden und mitwirken.

    Der gewählte Weg bietet etliche Vorteile.
    1. Ist Git ein dezentrales System und nicht von einem Anbieter abhängig. Jeder der Mitarbeitet hat normalerweise eine Copy des gesamten Werks auf dem eigenen Computer. Somit sind immer Sicherungen verfügbar und ein Systemwechsel schnell vollzogen.
    2. Anwendung von Markdown als Auszeichnungssprache. Markdown benötigt wenig Einarbeitung und lässt sich auch im Quelltext einfach lesen. Es gibt für Markdown in allen Programmiersprachen Parser und für die meisten Systeme Plugins/Add-On/Module. Somit lässt sich die Dokumentation auch einfach in andere Systeme importieren.
    3. Git ist ist ein verteiltes Versionierungssystem welches frei als Open-Source zur Verfügung gestellt wird. Es wird Millionenfach eingesetzt und aktiv entwickelt. Somit ist es sehr unwahrscheinlich das es bald nicht mehr funktioniert/existiert. (Da wäre WordPress gefährdeter und auch das ist sehr unwahrscheinlich 😉 )

    Es gibt noch weitere Vorteile, jedoch ruft das Bett. Ich würde mich auf jeden Fall freuen wenn noch andere an diesen Überlegungen Teilnehmen und ihre Meinung äußern. Evtl. stehe ich auch alleine mit dem Wunsch nach etwas mehr Struktur.

    #4055

    doing
    Teilnehmer

    Hallo kreativmonkey,

    ich gebe dir in soweit Recht, als dass es mit der Zeit etwas schwieriger geworden ist die ganzen Beiträge im Forum und die darin vorhandenen Tipps und Tricks zum Aufbau des eigenen WiFree zu verfolgen. Eine Dokumentation, die alles auf einer Seite zusammenfasst, wäre daher wünschenswert.

    Allerdings bin ich mir nicht sicher, ob es Sinn macht, dass jeder daran herumschreiben kann. Das könnte dann so enden, wie es eine Zeit lang bei Wikipedia der Fall war: Einer hat einen guten, neuen Artikel mit wenigen aber zutreffenden Fakten erstellt, dann kam ein Anderer und hat seinen Senf dazugegeben, die vorhandenen Fakten mit einer Menge Halbwissen angereichert. Daraufhin dauerte es eine Weile bis das aufgefallen ist und wiederum andere dieses Halbwissen editiert und in den richtigen Kontext gebracht haben.

    Von dieser Überlegung ganz unabhängig finde ich es doof die Dokumentation aus Open DIY Projects auszulagern. Benny und Georg haben hier über viele Jahre eine Menge Fleiß, Zeit und Wissen reingesteckt und ich finde diese Webseite sollte der einzige Anlaufpunkt für den WiFree Copter sein und bleiben.

    Aber – wenn du den beiden Arbeit abnehmen willst – was spricht dagegen, dass du eine Dokumentation in Form einer Webseite oder einer PDF Datei erstellst und diese dann Open DIY Projects zur Verfügung stellst? Ich denke damit wäre das Problem schon gelöst…

    Viele Grüße
    Sebastian

    #4056
    EagleEi
    EagleEi
    Keymaster

    Guten Abend Zusammen,
    Wie schon angekündigt, wir haben uns auch Gedanken zu der Pflege und der Weiterführung unserer Projekte gemacht, unser Ziel ist nach wie vor eine Austausch-Plattform gemeinsam mit euch aus zu bauen. Dies bedeutet wir möchten einen Weg finden wie wir zum einen die Beschreibungen und Erfahrungen aktuell halten und zum anderen soll es möglich sein individuell an den Projekten weiter zu entwickeln.
    Nicht von der Hand zu weisen bleibt dass wir hierfür Zeit aufbringen müssten und diese ist bei uns stark limitiert.

    Bislang war der Ansatz, möglichst im ersten Beitrag unserer jeweiligen Foren die wichtigen Informationen zu sammeln und im laufe der Zeit zu erweitern. Dies ist nach unserer Meinung auch gelungen und unsere Projekte sind so gut es ging aktuell und nachvollziehbar.

    Der Ansatz unsere Dokumente und das KnowHow auf eine übersichtlicheren Plattform aus zu weiten ist grundlegend gut, bedingt jedoch definitiv eine Verwaltung und mehr Aufwand.
    Wir sind davon nicht abgeneigt, im Gegenteil, es muss nur ein klares, in sich konsistentes und zuverlässiges Konzept dahinter stehen.

    Wir haben uns GitHUB nochmals genauer angeschaut, es wäre denkbar den WiFree Copter dort zu supporten und dort gemeinsam das Ding unter dem BETA-Status weiter zu entwickeln.
    Wir sehen GitHub jedoch nur als Werkzeug und Option das Projekt besser dar zu stelllen. Das Projekt an sich also die Offiziellen Downloads und der direkte Austausch sehen wir nach wie vor an einer Stelle und zwar im ersten Beitrag des Stuhlkreises.

    Wenn wir mit GitHub und dem WiFree als Pilot Projekt starten möchten, so bedingt dies natürlich einen durch uns erstellten offenen GitHubAccount und nicht einen privaten. Was wäre wenn nun ein Privat veröffentlichter Zugang von heute auf morgen wieder verschwunden wäre, Open Source?
    Desweitern sehen wir es wie schon Sebastian es beschrieben hat für notwendig, hin und wieder aus den Erweiterungen offizielle Releases zu generieren.

    Wir könnten es uns am Beispiel des Images wie folgt vorstellen:
    Das Image in der aktuellsten Version wird als Version 1.0 auf GitHub veröffentlicht und es kann drauf los entwickelt werden. Im Laufe der Zeit würden wir dann die geprüften Entwicklungen in eine nächste Offizielle Version weiterschreiben, also Version 2.0 und so weiter, welche dann bei uns im Stuhlkreis für alle (auch nicht Entwickler) zum Download verlinkt stehen. So wäre gewehrleistet dass auf Open-Diy-Projects alles aktuell wäre und dennoch für Entwickler ein besserer Zugang entsteht.
    Alle Zwischenentwicklungen auf GitHub werden als BETA-Versionen behandelt, so lange bis wir der Meinung sind, eine fertige neuere Version bekannt zu geben.
    Selbiges wäre auch für die Zeichnungen und Aufbauanleitungen denkbar.

    All dies bedingt jedoch auch, dass wir weitere Unterstützung benötigen. Wie schon erwähnt, wir wenige können nicht unbegrenzt unsere Freizeit für die Verwaltung aufbringen.

    @kreativmonkey, könntest du dir Vorstellen, einen von uns zur Verfügung gestellten GitHub Account mit deinen gesammelten Inhalten zu erstellen und die Basis hierfür zu schaffen?
    Wenn ja, wir wären dabei!
    Und hier hätten wir auch schonmal eine Basis geschaffen: https://github.com/EagleEi

    #4063

    kreativmonkey
    Teilnehmer

    Hallo Eaglei,

    zunächst wollte ich nur sagen das ich es lediglich auf meiner privaten Umgebung gehostet habe da es dort möglich ist nicht öffentliche Repository an zu legen. Auf GitHub ist dies nur gegen Bezahlung möglich.

    Nun möchte ich ein paar Missverständnisse aus dem Weg räumen.

    1. „Wenn wir mit GitHub und dem WiFree als Pilot Projekt starten möchten, so bedingt dies natürlich einen durch uns erstellten offenen GitHubAccount und nicht einen privaten.“

    Es gibt eine nette Funktion in GitHub, mit der lassen sich Organisationen erstellen. Somit lassen sich Projekte durch mehrere Mitglieder mit einer Rechteverwaltung verwalten und es ist kein GitHub Account für ein Projekt notwendig.

    2. Was wäre wenn nun ein Privat veröffentlichter Zugang von heute auf morgen wieder verschwunden wäre, Open Source?

    Hier tritt Git ins Spiel. Mit Git hat jeder eine Lokale Kopie von den Daten vorliegen. Somit wäre bei der Löschung eines Projektes nie alles weg. Je mehr sich daran beteiligen und je öfter es geforkt wird desto sicherer wird das ganze. Abgesehen davon ist Punkt 1 auch ein hinderniss das das passiert ;-).

    3. Allerdings bin ich mir nicht sicher, ob es Sinn macht, dass jeder daran herumschreiben kann. Das könnte dann so enden, wie es eine Zeit lang bei Wikipedia der Fall war: Einer hat einen guten, neuen Artikel mit wenigen aber zutreffenden Fakten erstellt, dann kam ein Anderer und hat seinen Senf dazugegeben, die vorhandenen Fakten mit einer Menge Halbwissen angereichert.

    Nächster Vorteil von Git. Jeder der Änderungen vornehmen möchte erstellt einen Fork und später einen Pull-Request. Dieser Pull-Request kann dann von einem Team überprüft und in das Projekt übernommen oder abgelehnt werden. Dieser Ablauf findet bei fast allen großen Projekten so statt. Hierdurch ist gewährleistet das jeder Änderungen und Anpassungen vornehmen und einreichen kann, jedoch erst nach Einsicht übernommen wird.

    @eagleei, ich habe mir mal erlaubt eine Organisation an zu legen und den Account den du erstellt hast einzuladen. Sobald du die Einladung angenommen hast werde ich dich zum Administrator machen. Gerne Unterstütze ich bei der Verwaltung, jedoch kannst du mir natürlich auch die administrativen Rechte entziehen.
    Das schöne ist das sich in Organisationen Teams bilden lassen. So ist es möglich dem 3D-Frame Team die rechte für das Frame Repository zum schreiben zu geben, jedoch bei der App nur lesenden Zugriff usw.

    Wünsche eine Gute Nacht,

    Sebastian

    PS.: Habe auch schon alles was ich zusammen getragen habe dort eingestellt. Da ich für Projekte die ich anfange immer eine Dokumentation erstelle damit ich meine Recherche und Arbeitsschritte auch später leichter nachvollziehen kann werde ich noch einiges beitragen. Jedoch freue ich mich über jeden der Mithelfen kann.

    PPS.: Hier ein paar hilfreiche Links:

    https://guides.github.com/

    https://rogerdudler.github.io/git-guide/index.de.html
    https://git-scm.com/book/de/v1

    #4064
    EagleEi
    EagleEi
    Keymaster

    Hallo Sebastian,
    das hört sich dich schonmal alles nach einem gutem Konzept an. Ich bin deiner Einladung gefolgt und das GItHub WiFrer Projekt kann losgehen. Wie du sehen kannst, GitHub ist für uns Neuland, somit setzen wir da auf deine Hilfe und unterstützen dabei soweit wir können. Ich kann gern versuchen in den kommenden Tagen die Inhalte zur Verfügung zustellen, hier darfst du uns vermutlich dabei etwas unter die Arme greifen.

    Viele Grüße
    Benny

    #4069

    doing
    Teilnehmer

    Hallo Sebastian,

    wenn du nun alles in ein neues GitHub Respository übernimmst, dann möchte ich

    a) gefragt werden ob das für meine Frames in Ordnung ist
    b) auch Zugang zu meinen WiFree Files erhalten
    c) als Contributor genannt werden

    Ich teile gerne, was man an meinem Beitrag zu dem WiFree Projekt erkennen kann. Aber ich mag die Selbstbedienungsmentalität nicht, das stösst bei mir sauer auf…

    In diesem Sinne,

    viele Grüße
    Sebastian

    P.S. Vorhin gab es die *.stl Files noch zum Download, aktuell kann ich sie nicht finden, ich vermute du arbeitest daran – daher dieser Hinweis!

    P.P.S OOOPS – hab ich den Text doch glatt im falschen Thread gepostet – hier gehört er hin.

    #4070
    EagleEi
    EagleEi
    Keymaster

    Hallo Zusammen,
    Der Umgang und die Verwaltung mit GitHub ist für uns alle Neuland und daher bedarf es vermutlich noch Hinweise und Vereinbarungen. Die Pflege und der Aufbau der Dokumentation auf GitHub kann dem Open-DIY-Projekt eine bessere Übersicht verschaffen und den Austausch mit den Entwicklern verbessern.

    Unsere Bedingung war, dass die offizielle Dateien und die Downloads an einer Stelle liegen und zwar bei uns im Stuhlkreis. GitHub soll als Dokumentation und BETA-Entwicklungsstatus unterstützen.
    Der Umgang mit Zeichnungen war noch nicht definiert, wir ziehen es jedoch zunächst vor, die Zeichnungen und STLs zunächst bei uns zum Download zu belassen und uns auf die Dokumentation und die Verlinkungen zu unseren Downloads zu beschränken.

    Offene Frage an alle, Wie seht Ihr das?

    #4073

    kreativmonkey
    Teilnehmer

    Hallo Doing,

    vielen Dank für deine Anregung, da am ende der Webseite ein Hinweis auf die Lizenzierung der Inhalte hier existiert bin ich davon ausgegangen das dies auch das Forum betrifft da nirgends etwas anderes steht. Die Lizenz erlaubt es mir ohne nachfragen Inhalte zu kopieren und unter angabe des Autors zu verwenden solange ich es nicht für kommerzielle Zwecke einsetze. Wie du im Repository zum Frame sehen kannst habe ich alle Punkte beachtet und somit auch Punkt c umgesetzt 😉 : https://github.com/WiFree-Copter/frame

    Zu Punkt B, ich möchte mir nicht anmaßen einfach frei Rechte zu vergeben, hier handel ich gerne auf Zuruf aus dem Entwicklerteam von Open-DIY-Projects. Mein Vorschlag wäre jedoch, da du und Georg an dem Frame Arbeiten, ein Frame-Team auf Github an zu legen welches für die Verwaltung des Frames zuständig ist. Bis dahin kannst du, wie alle anderen auch, das Repository forken und nach den Änderungen ein Pull-Request stellen.

    Die *stl Files sind alle im Frame Repository enthalten und lassen sich dank Github sogar direkt online begutachten.

    Grüße,
    Sebastian

    #4074
    EagleEi
    EagleEi
    Keymaster

    @kreativmonkey JETZT ERSTMAL STOPP!!!!

    Wir wissen deinen Einsatz wirklich sehr zu schätzen, allerdings haben wir im Vorfeld klargestellt dass wir GitHUB nicht als Open-DIY Ersatz sehen, sondern als Ergänzung in sachen Dokumentation und für die Weiterentwicklung des Images.
    Wir bitten dich hiermit deinen Einsatz auf die Dokumentation und die Grundlagen zu beschrenken, Dateien werden zunächst nur durch unsere Seite zur Verfügung gestellt!!

    Bitte beachte diese Anforderung und entferne sämtliche Zeichnungen!
    Du kannst auf unsere Seite und den passenden Link verlinken, erstmal nicht mehr!

    #4075

    kreativmonkey
    Teilnehmer

    Hi EagleEi,

    ich dachte auch am Frame wird aktiv entwickelt, daher hatte ich die *.stl dort in einem repository gesammelt. Downloads können ja weiterhin hier belassen werden. Eine schöne Möglichkeit bei der Verwaltung mit Git sind sogenannte Tags, mit diesen kann man Entwicklungsstände festhalten und somit verschiedene Versionen zur Verfügung stellen wärend die Daten in einer gleichbleibenen Struktur abgelegt sind.

    Ich würde mich Übrigens freuen wenn ihr das Frame als gesammeltes ZIP File zum Download bereit stellen würdet. Sprich ein ZIP Version 1 in dem alles enthalten ist und ein ZIP Version 2 in dem alles enthalten ist. Diese dadeiten ließen sich einfach aus dem Git Repository erzeugen. Wenn wir die Readme dort pflegen könnte der Ordner dann auch alle Wichtigen Informationen zu Einstellungen des Druckers enthalten usw.

    #4076

    doing
    Teilnehmer

    Hallo Benny,

    GitHub ist für mich zwar kein Neuland, aber das Thema ‚Datenkrake‘ möchte ich hier nicht vertiefen. Ich habe meine geänderten Frames hier in dieses Forum eingestellt und hier in diesem Forum ist der Download für mich in Ordnung und gewünscht. Bei Github sehe ich das etwas anders, zumal wenn ein anderer ‚Sebastian‘ plötzlich als Autor auftaucht.

    Ich bin nach wie vor für eine PDF Dokumentation hier aus dem Forum, da habt Ihr die Kontrolle drüber und es kommt nur in die ‚Offizielle Dokumentation‘ was zuvor auch getestet wurde.

    Wenn ich in dem neuen GitHub den Punkt ‚WiFi‘ lese, dann ist damit keinem geholfen. Was bringt einem die Aussage ‚wird teilweise unterstützt‘ – damit wird man als geneigter Bastler nur in die Irre führt. WiFi Dongles die keine Verbindungsqualität auslesen können sind nicht geeignet (da damit der Failsafe des WiFree fehl schlägt). An der Stelle gibt es auch nicht viel zu entwickeln solange die App nicht Quelloffen ist (warum das so ist hast du ja an anderer Stelle bereits nachvollziehbar erläutert).

    Aussagen in der Art meinte ich in meinen vorletzten Beitrag mit ‚Halbwissen’…

    Viele Grüße
    Sebastian

    #4077

    kreativmonkey
    Teilnehmer

    Hi EagleEi,

    bitte nicht laut werden, habe das Repository schon gelöscht. Wie oben geschrieben wollte ich nichts ersetzen!

    @eagleei schreibt:
    „GitHub soll als Dokumentation und BETA-Entwicklungsstatus unterstützen.“

    Ich dachte dies bezieht sich auf alle Komponenten des WiFree Projekts. Sprich derzeit das Raspbian Image und das Frame. Tut mir leid wenn ich das falsch verstanden habe. Das Image würde nur in RAW Format sind machen, daher habe ich da noch nichts gemacht gehabt. Sprich das wäre dann auch nur mit tiefer greifenden Kenntnissen im Bereich Linux nutzbar.

    #4078

    doing
    Teilnehmer

    @kreativmonkey

    Ich habe so absolut keine gar keine Lust mit dir jetzt eine Diskussion über Urheberrecht zu führen. Das war bzw. ist das schöne an diesem Forum bzw. dem Stuhlkreis. Hier achtet man sich, es ist klein und kuschelig und man muss diese Diskussionen eben einfach nicht führen. Da du mir jetzt mit ‚ich darf das aber weil…‘ kommst ist die Diskussion um GitHub für mich an dieser Stelle bereits beendet.

    Ich erwarte von dir, dass du meine Files aus dem GitHub Repository entfernst. Danke!

    Viele Grüße
    Sebatsian

    #4079
    EagleEi
    EagleEi
    Keymaster

    Hallo Sebastian(doing),
    ich stimme dir zu, daher war der Vorschlag GitHub ein zu setzen lediglich zur Weiterentwicklung von uns aus freigegeben.

    Kreativmonkey, auf GitHub soll zunächst nur das stehen was vereinbart wurde und auch auf unserer Seite beschrieben wird, bitte bereinige die Inhalte sonst werden wir GitHub nicht weiter zu Verfügung stehen.

    #4080

    kreativmonkey
    Teilnehmer

    Hallo @doing,

    nirgends ist ein anderer „Sebastian“ als Author und Urheber aufgetreten! Es ist klar gekennzeichnet wer für die Daten verantwortlich war. Was Spricht dagegen gemeinsam eine Dokumentation zu erarbeiten die man später gerne auch als PDF Formatiert hier zur Verfügung stellt? „teilweise“ ist übrigens in der Legende erklärt was das bedeutet. Es geht lediglich darum zu kennzeichnen das bekannt ist das der Stick eigentlich unter Linux eingesetzt werden kann jedoch nicht für den WiFree funktioniert. Daher ist es sinvoll gemeinsam an Dokumentationen zu Arbeiten, denn der Author versteht es und die leser evtl nicht. Nicht immer kommt man direkt auf die besten Formulierungen.

    Ich Dokumentiere gerne Projekte die ich angehe damit ich mich einfacher zurecht finde und später meine Arbeitsschritte nachvollziehen kann. In der Regel mache ich das in meinem Persönlichen Wiki. Meist handelt es sich jedoch nur um Dokumentation von Recherche Links und Codeanpassungen. Jedoch habe ich hier festgestellt das ich wesenltich mehr mühe habe alles Wichtige zu finden da vieles in Beiträgen weiter hinten versteckt war. Dachte es geht nicht nur mir so und ich treffe auf gleichgesinnte.

    Mir ist dies abneigung zu GitHub sehr neu. Komme selbst aus dem OpenSource bereich und bin in einigen Gruppen tätig mit sehr Paranoiden menschen, jedoch habe ich auch von denen noch nie so viel negative Stimmung zu GitHub erfahren alla „Datenkrake“ und co.

Ansicht von 15 Beiträgen - 1 bis 15 (von insgesamt 23)

Du musst angemeldet sein, um auf dieses Thema antworten zu können.