ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Neuigkeiten zum c't-Bot und c't-Sim
eax
Friends of Robby
Friends of Robby
Beiträge: 765
Registriert: 18 Jan 2006, 16:16
Wohnort: Karlsruhe

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von eax » 12 Mai 2019, 14:43

Mir sind da immer noch keine Fehler aufgefallen ;-)

Nightwalker-87
Site Admin
Site Admin
Beiträge: 150
Registriert: 16 Apr 2017, 23:40

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von Nightwalker-87 » 13 Mai 2019, 01:10

:lol: na, dann ist ja gut. :wink:
nw-87

Nightwalker-87
Site Admin
Site Admin
Beiträge: 150
Registriert: 16 Apr 2017, 23:40

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von Nightwalker-87 » 28 Mai 2019, 00:07

Der nächste Artikel steht zum Review bereit: Aufbauanleitung für den c't-Bot \:D/
nw-87

anonybot
Friends of Sonny
Friends of Sonny
Beiträge: 180
Registriert: 07 Okt 2015, 00:14

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von anonybot » 09 Jun 2019, 11:31

Hi Nightwalker-87,

ich konnte die Artikel zwar nur überfliegen, aber: Große Klasse, liest sich sehr angenehm und macht alles einen einen extrem sauberen und hervorragenden Eindruck! :)

Meine Anmerkungen, um "Bit-Rotting" vorzubeugen:
Nightwalker-87 hat geschrieben:
26 Mär 2019, 20:56
Neben ein paar Seiten, welche eher projekt-technischer Natur sind, ist nun die erste Content-Seite vom neuen Wiki online! :mrgreen:
Als Demo hatte ich mir hier den USB-2-Bot-Adapter vorgenommen.
1. Ich würde es besser finden, wenn auf Seiten verlinkt wird, deren Fortbestehen relativ gesichert ist, bspw: https://de.wikipedia.org/wiki/FTDI statt https://www.ftdichip.com/Products/ICs/FT232R.htm - hier schadet es eigentlich nicht, dass der letztgenannte Link punktuell durchaus hilfreicher ist als der Wikipedia-Artikel, da es im Doku-Artikel an der verlinkten Stelle ja eher darum geht, schnell eine Erklärungshilfe für "FT232R" zu liefern. Soll heißen: Wer es ganz genau wissen will, wird eh eine Suchmaschine seiner Wahl konsultieren, aber die, die keine Ahnung haben, bekommen mit der Wikipedia sofort eine niedrischwellige Infoquelle, deren Fortbestehen relativ gesichert ist.

2. heise-Artikel zum ct-Bot besser aus dem eigenen Bestand verlinken, sie sind ja (bis auf die make) CC-BY-SA, also bspw. https://github.com/Nightwalker-87/ct-bo ... er_USB.pdf statt https://www.heise.de/ct/artikel/An-der- ... 90394.html.
Nightwalker-87 hat geschrieben:
03 Apr 2019, 22:34
Der nächste Artikel steht zum Review :shock: :lol: bereit: BeagleBoard-Erweiterung
3. https://shop.heise.de/katalog/c-t-bot-r ... lbst-bauen fehlt in https://github.com/Nightwalker-87/ct-bo ... s_heise%20 - hier müsste ich nochmal nachhaken, ob die make-Redaktion uns die PDFs zuschickt (die wie gesagt leider nur CC-BY-NC-SA sind - wie man solche Material einbindet, ohne langfristig Lizenz-Kollisionen zu verursachen, könntest Du dir ja schonmal überlegen).

4. Ich würde ext. Inhalte wie https://www.cnx-software.com/2011/09/26 ... -with-qemu als Zitat einbinden und dann entsprechend unter dem Zitat auf die Quelle verweisen. Dann steht der zitierte Teil nicht unter CC-BY-SA und ist trotzdem vor Bit-Rotting geschützt.
Nightwalker-87 hat geschrieben:
07 Apr 2019, 15:53
Der nächste Artikel steht zum Review bereit: Dokumentation zur virtuellen Speicherverwaltung für SD-Karten
5. Fehlt hier eventuell die Bild-Quellenangabe?
Nightwalker-87 hat geschrieben:
28 Mai 2019, 00:07
Der nächste Artikel steht zum Review bereit: Aufbauanleitung für den c't-Bot \:D/
6. Danke für die Aufnahme meines Messprotokolls und "Orientierungsplans"! :) Hier stimmt leider die E-Mailadresse nicht mehr... da muss ich Dir bei Zeiten mal einen Patch zukommen lassen.
Von mir selbst verfasste (daher nicht zitierte) Inhalte dieses Beitrags sind zur Weiternutzung unter CC-BY-SA freigegeben +++ ct-Bot -> Libre-Bot? - Diskussion zur Zukunft des ct-Bots +++ anonybot sagt hello!

Nightwalker-87
Site Admin
Site Admin
Beiträge: 150
Registriert: 16 Apr 2017, 23:40

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von Nightwalker-87 » 09 Jun 2019, 15:12

Danke für das Feedback. :-) Ich werde die Punkte bei nächster Gelegenheit mal durchgehen. Klingt aber so erstmal recht plausibel.

@ anonybot: zu Punkt 3): Wenn du dort sowieso wegen diesem Artikel nachfragst, wäre es sinnvoll auch gleich nochmal nach ordentlich formatierten pdfs von den anderen heise-Artikeln zum ct-Bot Projekt zu fragen. Ich hatte die damals hastig von den Web-Versionen erstellt als noch nicht klar war wie heise mit den alten Inhalten verfahren würde. Nun, da heise für diese Inhalte inzwischen ja CC-BY-SA eingeräumt hat, wäre es vielleicht möglich die ehemaligen kostenpflichtigen pdf-Versionen zur Verfügung zu stellen (zumindest sehe ich da grade kein lizenzrechtliches Hindernis). So könnte der Verlag auf Wunsch da ja sogar noch eine Fußnote reinsetzen. Ich denke das wäre auch ein gutes und positives Signal von der Community an den Verlag. :wink:
nw-87

eax
Friends of Robby
Friends of Robby
Beiträge: 765
Registriert: 18 Jan 2006, 16:16
Wohnort: Karlsruhe

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von eax » 16 Jun 2019, 20:09

Nightwalker-87 hat geschrieben:
28 Mai 2019, 00:07
Der nächste Artikel steht zum Review bereit: Aufbauanleitung für den c't-Bot \:D/
Finde ich auch gut :)
Wobei ich die inhaltlichen Details jetzt nicht gegengecheckt habe. Ich gehe mal davon aus, es gab "nur" Änderungen was Layout etc. betrifft? Ansonsten müsste es vielleicht am besten noch mal jemand gegenlesen, der vor Kurzem einen Bot aufgebaut hat.

Nightwalker-87
Site Admin
Site Admin
Beiträge: 150
Registriert: 16 Apr 2017, 23:40

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von Nightwalker-87 » 16 Jun 2019, 20:39

Die neue Version ergänzt die Informationen aus der heise-Anleitung an einigen Stellen um die detaillierten und teilweise auch besser verständlichen Ausführungen von Marvin aus dem ct-bot wiki. So gesehen gibt es auch inhaltliche Änderungen. Das ist ja genau das was die Aufbereitung so zeitaufwändig macht. Auch wenn das aus meiner Sicht so dem Projekt gerecht wird, fände ich es schon gut wenn das auch nochmal jemand "richtig" gegengelesen würde. Das dürfte bei den noch folgenden Artikeln zu den anderen Themen ähnlich sein.
nw-87

eax
Friends of Robby
Friends of Robby
Beiträge: 765
Registriert: 18 Jan 2006, 16:16
Wohnort: Karlsruhe

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von eax » 20 Jun 2019, 16:04

Ich habe den Text noch mal absatzweise mit der alten Version verglichen.
Aufgefallen sind mir nur ein paar Kleinigkeiten.

Nightwalker-87
Site Admin
Site Admin
Beiträge: 150
Registriert: 16 Apr 2017, 23:40

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von Nightwalker-87 » 20 Jun 2019, 20:16

Danke. :wink: An den Bildern dürfte inzwischen Broadcom die Rechte halten. Agilent hatte die ONS-Sparte vor einigen Jahren an Avago verkauft, die später dann die Broadcom Corporation übernommen haben und sich selbst in Broadcom Inc. umbenannt haben. Es wäre also nicht falsch das gleich entsprechend nachzuziehen.
Ich bin mir grade nicht sicher ob das auf der wiki-Seite, die in den neuen Artikel eingeflossen ist, überhaupt am Bild dranstand (sonst wäre es wohl nicht unter den Tisch gefallen). Auf der verlinkten anderne wiki-Seite von dir steht der Vermerk jedoch.

Edit:
Wenn ich mir das mit CC-BY-SA 4.0 aber so ansehe, dann dürfte das Einbetten der Grafiken aus dem Datenblatt hier ohnehin problematisch sein.
Besser wäre hier auf das Datenblatt zu verlinken wegen der Bildrechte. Man könnte zwar auch das jeweilige Bild per Fußnote von CC-BY-SA 4.0 ausnehmen, aber dann könnte es streng genommen immer noch als Urheberrechtsverletzung wegen der Weiterverbreitung und Entnahme aus dem Datenblatt-Dokument gelten, das als in sich geschlossenes "Werk" gewertet werden dürfte.
nw-87

Nightwalker-87
Site Admin
Site Admin
Beiträge: 150
Registriert: 16 Apr 2017, 23:40

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von Nightwalker-87 » 21 Jun 2019, 00:54

@anonybot:

1. Ich würde es besser finden, wenn auf Seiten verlinkt wird, deren Fortbestehen relativ gesichert ist, bspw: https://de.wikipedia.org/wiki/FTDI statt https://www.ftdichip.com/Products/ICs/FT232R.htm - hier schadet es eigentlich nicht, dass der letztgenannte Link punktuell durchaus hilfreicher ist als der Wikipedia-Artikel, da es im Doku-Artikel an der verlinkten Stelle ja eher darum geht, schnell eine Erklärungshilfe für "FT232R" zu liefern. Soll heißen: Wer es ganz genau wissen will, wird eh eine Suchmaschine seiner Wahl konsultieren, aber die, die keine Ahnung haben, bekommen mit der Wikipedia sofort eine niedrischwellige Infoquelle, deren Fortbestehen relativ gesichert ist.

--> ich habe hier einfach auf das Datenblatt im Repo verlinkt. Da steht ja alles drin. Die Links zu den Treiberseiten sind keine Direktlinks, daher kann man die schon beibehalten. Wenn sich da mal was ändern sollte kann man das jederzeit nachziehen. Das ist recht überschaubar.


2. heise-Artikel zum ct-Bot besser aus dem eigenen Bestand verlinken, sie sind ja (bis auf die make) CC-BY-SA, also bspw. https://github.com/Nightwalker-87/ct-bo ... er_USB.pdf statt https://www.heise.de/ct/artikel/An-der- ... 90394.html.
--> wartet auf deine Rückmeldung nach der Anfrage an Heise

3. https://shop.heise.de/katalog/c-t-bot-r ... lbst-bauen fehlt in https://github.com/Nightwalker-87/ct-bo ... s_heise%20 - hier müsste ich nochmal nachhaken, ob die make-Redaktion uns die PDFs zuschickt (die wie gesagt leider nur CC-BY-NC-SA sind - wie man solche Material einbindet, ohne langfristig Lizenz-Kollisionen zu verursachen, könntest Du dir ja schonmal überlegen).
--> wartet auf deine Rückmeldung nach der Anfrage an Heise

4. Ich würde ext. Inhalte wie https://www.cnx-software.com/2011/09/26 ... -with-qemu als Zitat einbinden und dann entsprechend unter dem Zitat auf die Quelle verweisen. Dann steht der zitierte Teil nicht unter CC-BY-SA und ist trotzdem vor Bit-Rotting geschützt.
--> externe Inhalte sind per-se schon ausgeschlossen, das schreibe ich sowieso nochmal auf die Hauptseite zu den Lizenzbestimmungen dazu. Generell wird angestrebt möglichst wenig externe Direktlinks zu verwenden. Daher sollte das hier schon mal vertretbar sein. Wenn der Link mal tot ist, hilft die Alternative auch nicht wirklich weiter...


5. Fehlt hier eventuell die Bild-Quellenangabe?
--> dürfte sich mit der Anmerkung von eax nun erledigt haben (siehe vorheriger Post)


6. Danke für die Aufnahme meines Messprotokolls und "Orientierungsplans"! :) Hier stimmt leider die E-Mailadresse nicht mehr... da muss ich Dir bei Zeiten mal einen Patch zukommen lassen.
--> bitte eher jetzt als später, damit das gleich erledigt ist. Alternativ kannst du auch einfach eine Version mit Namensnennung aber ohne e-mail-Adresse erstellen. Das sollte auch ausreichen.
nw-87

Nightwalker-87
Site Admin
Site Admin
Beiträge: 150
Registriert: 16 Apr 2017, 23:40

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von Nightwalker-87 » 30 Jun 2019, 00:25

Der nächste Artikel steht zum Review bereit: Teileliste & Design-Dokumente für den c't-Bot \:D/
nw-87

eax
Friends of Robby
Friends of Robby
Beiträge: 765
Registriert: 18 Jan 2006, 16:16
Wohnort: Karlsruhe

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von eax » 30 Jun 2019, 14:55

Sieht gut aus, lediglich die Links zu Bestückungspläne -> Maussensorplatine und -> Erweiterungsplatine sind falsch (altes Namensschema).

Auf der Suche nach der alten Version des Artikels zum Vergleich ist mir aufgefallen, dass scheinbar bei sehr vielen der Markdown-Dateien unter https://github.com/Nightwalker-87/ct-bo ... kis_export der Lizenz-Hinweise entfernt wurde - das ist aber nicht erlaubt, da diese Inhalte unter CC BY-SA zur Verfügung gestellt wurden!
Bitte die Lizenznennung wieder so hinzufügen, wie sie im Quellmaterial (https://github.com/tsandmann/ct-bot-dok ... iki_export) mal war.

Nightwalker-87
Site Admin
Site Admin
Beiträge: 150
Registriert: 16 Apr 2017, 23:40

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von Nightwalker-87 » 01 Jul 2019, 00:09

@eax: Zu deinem Hinweis mit den Lizenz-Tags bei den alten ungesichteten Markdown-Dateien:

Das ist so, wie du es beschreibst, nicht richtig. Die Inhalte stehen ohnehin unter der besagten Lizenz, die auch im Projekt hinterlegt ist. So gesehen gibt es hier keinen Lizenzverstoß. Da ich zuvor jedoch stichprobenartig schon mehrere Lizenzkonflikte zu CC-BY-SA im alten Content gefunden habe, wo propietäre Bilder eingepflegt waren, habe ich mich dazu entschlossen die Tags in den Artikeln zu entfernen und durch einen Hinweis in der Main-Readme zu ersetzen der auch nochmals den Verweis auf die CC-BY-SA Lizenzierung enthält.

Da das offensichlich nicht wahrgenommen wurde, habe ich mich nun entschlossen die diesen Hinweis über jeden Artikel zu setzen. Die "Direktlink"-Tags werde ich nur bei gesichteten Inhalten hinzufügen, wenn ich die Konformität aller Inhalte einer Seite zur CC-BY-SA auch persönlich verantworten kann.
Da gibt es weder (lizenz-)rechtliche Konflikte noch eine weitere Diskussionsgrundlage, da ich die Verantwortung für das Hosten der Inhalte trage.
nw-87

eax
Friends of Robby
Friends of Robby
Beiträge: 765
Registriert: 18 Jan 2006, 16:16
Wohnort: Karlsruhe

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von eax » 01 Jul 2019, 00:55

Also bei sämtlichen Markdown-Dateien aus https://github.com/tsandmann/ct-bot-dok ... iki_export habe ich damals die Inhalte auf die Lizenz geprüft und überall dort, wo die Inhalte unter CC BY-SA zur Verfügung gestellt wurden, den Lizenzhinweis eingefügt. Diese pauschal wieder zu entfernen ist aus meiner Sicht nicht in Ordnung. Wie soll denn ein Hinweis in einer übergeordneten Readme-Datei ausreichend sein, wenn nicht alle Dateien in den Unterordnern unter derselben Lizenz stehen? Wenn man es nicht pro Datei annotiert, ist das ja nicht mehr zu Unterscheiden. Abgesehen davon ist es IMHO nicht okay, einen Lizenzhinweis zu entfernen, wenn er mal da war.

An welchen Stellen gab es denn bei den genannten Inhalten Lizenzkonflikte? Ich will natürlich nicht ausschließen, dass da irgendwo Fehler passiert sind, die sollten wir dann aber an diesen Stellen korrigieren und nicht pauschal Lizenzinformationen löschen, die zuvor mühsam geprüft und extra eingefügt wurden.

Der eingefügte Hinweis passt so irgendwie nicht, denn keiner der Inhalte aus dem Trac ist gemeinfrei.

Nightwalker-87
Site Admin
Site Admin
Beiträge: 150
Registriert: 16 Apr 2017, 23:40

Re: ct-Bot-Neuveröffentlichung - Arbeitsb. A: Dokumentation

Beitrag von Nightwalker-87 » 01 Jul 2019, 01:34

Konkret ging es um Bildinhalte aus Datenblättern die nicht CC-BY-SA konform sind. Was da sonst noch vorhanden ist, kann ich zum derzeitigen Zeitpunkt nicht pauschal sagen. Zumal dürfte es problematisch sein Inhalte aus solchen Werken direkt zu entnehmen, selbst wenn die Quelle angegeben wird, da diese den Rechten der Hersteller unterliegen. Hier gibt es nach meinen Recherchen beim Urheberrecht nur Ausnahmen für den wissenschaftlichen Bereich. Die Inhalte als ganzes vertieft Durchzugehen entspricht nicht meiner Vorgehensweise bei der Überarbeitung der Doku. Ich kann und möchte das gründlich bearbeiten und kann das in dieser Form nur abschnittsweise tun.

Nochmals hier die Anmerkung, dass sich am Lizenzstatus der Inhalte formell gar nichts geändert hat. Im Header ist auf jeder Seite ein Hinweis zu CC-BY-SA enthalten. Hier wurde "gemeinfrei" durch "freie Inhalte" ersetzt.

Was da wer wie oft meint geprüft zu haben oder geprüft hat, ist für mich in dieser Frage sekundär, wenn ich dafür grade stehen soll/muss. Daher bleibt es bei dem Header in jetziger Form, solange noch solche alten Inhalte verbleiben und ich Maintainer des Repos bin.
nw-87

Antworten