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

Allgemeine Themen zum c't-Bot und c't-Sim

Moderator: Moderatoren Team

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

Beitragvon Nightwalker-87 » 29. Dez 2017, 13:22

Ich habe vorsorglich ungewünschter Überraschungen mal die heise Projektseite (https://www.heise.de/ct/artikel/c-t-Bot-und-c-t-Sim-284119.html) sowie alle heise Artikel zum ct-bot als pdfs exportiert. Dies ist erstmal ein lokales Backup aller redaktionellen Inhalte. Vielleicht wäre es hier sinnvol mal einen Fileserver aufzumachen wo man solche Inhalte zumindest temporär ablegen und via ftp zugänglich machen kann. :wink:
Nightwalker-87
Friends of Gort
Friends of Gort
 
Beiträge: 53
Registriert: 16. Apr 2017, 23:40

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

Beitragvon Nightwalker-87 » 29. Dez 2017, 13:50

Zum Thema heise-wiki (https://www.heise.de/ct/projekte/machmit/ctbot/wiki#no1):

Hier ist die Gliederung mit einer noch weiter zu aktualisierenden Übersicht über den derzeitigen Stand (09.04.2018):

1) c't-Bot in Aktion

Galerie: Videos und Bilder rund um das Projekt. -> noch ungesichert, für die Übernahme dieser Inhalte wäre das Einverständnis der jeweiligen Autoren notwendig

2) Anlaufstellen

Zum Projekt gibt es viel Doku, hier ein paar generelle Anlaufadressen:

* c't-Artikel -> als pdfs gesichert im neuen Git-Doku-Projekt -> Dateiformat optimal (?)
Die ​FAQ --> gesichert
c't-Bot-Dokumentation im Code-Repository --> im Code, und entsprechend in Github
Das ​Forum --> ist hier
Das ​Archiv der Mailingliste --> benötigt?
Die ​Projektseite --> gesichert
* Das Wiki in dem Sie gerade lesen --> :lol:
Dokumentationen und Informationsseiten --> größtenteils Verlinkungen auf Unterseiten im wiki und heise-Artikel, nochmal prüfen
Übersicht über alle Support-Kanäle --> größtenteils Verlinkungen auf Unterseiten im wiki und heise-Artikel, nochmal prüfen
* Direkter Kontakt über IRC -> Funktion nicht mehr verfügbar, entfällt

3) Schnelleinstieg in das Projekt

Mal ausprobieren, wie das ganze so geht (auch ohne Geld auszugeben): Erste Schritte
c't-Bot aufbauen
c't-Bot testen
Die Firmware für die eigene Hardware kalibrieren
Demo-Firmware ausprobieren
Eigenen Code schreiben
* Firmware für den realen Bot generieren -> Notizen von nw87
* Firmware auf den realen Bot Übertragen (Flashen) -> Notizen von nw87

4) Hardware

Überblick über die ct-Bot-Hardware
* Schaltpläne -> Git-Projekt ct-bot-hw
* Stücklisten -> Git-Projekt ct-bot-hw
* NEU: Datenblätter -> Git-Projekt ct-bot-hw
Aufbauanleitung
Erweiterungen
* Firmware flashen -> Notizen von nw87
c't-Bot testen

5) Software

Installationsanleitung für c't-Bot und c't-Sim

5a) c't-Bot

Dieses Teilprojekt umfasst den C-Code für reale und simulierte c't-Bots

Überblick über die ct-Bot-Software
Dokumentation zum bestehenden Code
Howto zum Bot
Ideen & mehr
kalibrieren
Eigenen Code schreiben

5b) c't-Sim

Dieses Teilprojekt umfasst den Java-Code für den Simulator c't-Sim

* Überblick über die ​c-t-Sim-Software -> Dead-Link (war zugehöriger c't Artikel, gesichert)
Konfiguration der Sim-Optionen
Howto zum Sim

6) Zugang zum Source-Code -> Rubrik entfällt komplett, jetzt Git-Projekte

7) Entwicklungsumgebung

Installationsanleitung für c't-Bot und c't-Sim
Entwicklungsumgebung:
* Eclipse-Installation inkl. der nötigen Plugins -> Notizen von nw87
* Code aus dem Subversion in Eclipse einbinden -> veraltet, jetzt: Code aus Git einbinden -> Notizen von nw87
* Tickets aus dem Trac in Eclipse einbinden -> veraltet, entfällt
Tipps, Tricks und Hotkeys rund um Eclipse
AVR-Toolchain:
* Installation der AVR-Toolchain zur Entwicklung des Steuercodes eines realen c't-Bots -> Notizen von nw87
Hintergründe zur AVR-Toolchain
AVR-Tools und Tricks für die (Bot-)Softwareentwicklung

8) Was es hier gibt (Trac) -> Rubrik entfällt komplett

9) Jagd auf den Fehlerteufel

* Offene Fehlerberichte zum c't-Sim -> keine Inhalte, entfällt
Offene Fehlerberichte zum c't-Bot -> verbliebene offene Vorschläge sichern und ins Projekt übernehmen
* Neuen Fehlerbericht erstellen -> Funktion nicht mehr verfügbar, entfällt
* Erklärungen zu den Tickets befinden sich im TicketGuide -> Trac-spezifisch, entfällt

10) Organisatorisches

* Neuigkeiten -> AP: Projekt-History mal als Timeline neu zusammenschreiben
Links rund um den c't-Bot und auf Leserprojekte
Pool für Dateianhänge der Mailingliste

11) Ein paar Spielregeln (Trac) -> Rubrik entfällt komplett, muss durch Einführung in entsprechende Github-User-Funktionen ersetzt werden

Die Spielregeln für dieses Trac lauten wie folgt:

Ohne Anmeldung kann man alles einsehen, aber nichts verändern
Wer sich registriert darf das Wiki bearbeiten, Tickets anlegen und bearbeiten
Einige administrative Aufgaben, wie die Bearbeitung der Roadmap bleibt einer kleinen Gruppe von Maintainern vorbehalten
Jeder hat Leserechte auf den ganzen Code im SVN, Schreibrechte haben nur die Maintainer

Damit eigener Code den Weg in das Repository findet, sollte er den Coderichtlinien entsprechen. <--- ganz wichtig - muss übernommen/überarbeitet werden :!:

12) Trac -> Rubrik entfällt komplett


TODO: (NEU)

* Einführung in Git-Hub Funktionen & die Git-Repositories
* Direkter Kontakt über Slack und Riot/Matrix
* ...
Zuletzt geändert von Nightwalker-87 am 9. Apr 2018, 23:42, insgesamt 1-mal geändert.
Nightwalker-87
Friends of Gort
Friends of Gort
 
Beiträge: 53
Registriert: 16. Apr 2017, 23:40

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

Beitragvon anonybot » 29. Dez 2017, 22:15

eax hat geschrieben:Ist das denn wirklich ein Problem? So wie ich es verstanden habe, hat man immer alle Quellen als Markdown-Dateien dezentral zur Verfügung und kann daraus jederzeit lokal ein pdf oder eBook bauen.


Nightwalker-87 hat geschrieben:Ich sehe da auch nicht wirklich ein Problem...
Wichtig ist doch hier, dass man jederzeit den Content inkl. Quellen außerhalb des Services sichern kann und damit dann noch was anfangen kann.


Ich hätte nicht nur ein Notiz an mich schreiben sollen, sondern gleich mein Problem genauer formulieren sollen, nämlich den Umstand, nicht selbst hosten zu können mit den Nutzungsmodellen unter https://www.gitbook.com/pricing :
Open Source

Ideal for public and open source projects.
Free

Unlimited public books
Unlimited visits and updates

5 collaborators
0 private books

Custom domains

Community Support


Bedeutet: es können nur 5 User an der Doku mitarbeiten. So hatte ich mir ein dezentrales Dokumentations-System für den Bot eigentlich nicht vorgestellt, weil dann nicht jeder einfach mitmachen kann, der Zeit und Lust hat, oder seh ich hier etwas falsch?
anonybot
Friends of Sonny
Friends of Sonny
 
Beiträge: 146
Registriert: 7. Okt 2015, 00:14

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

Beitragvon Nightwalker-87 » 29. Dez 2017, 22:28

Wir haben doch auch noch ein wiki, wo jeder posten kann. Vielleicht ist das gar nicht wirklich so ein Problem dass es nur 5 Contributors gibt für wiki books.
Streng genommen ist es beim Code in Git sogar noch "eingeschränkter". Hier kann zwar jeder den Code verändern aber den "offiziellen" Code verwaltet eax und entscheidet letztlich auch (mit) was wie an Beiträgen übernommen wird. Das hindert niemand daran eigenen Code zu schreiben, zu testen oder zu forken. Ich würde sogar sagen es ist nicht das Verkehrteste wenn wenige statt viele die Haupt-Doku pflegen umd a ein bisschen lenken zu können im Sinne des Projekts.
Zuletzt geändert von Nightwalker-87 am 31. Dez 2017, 01:22, insgesamt 1-mal geändert.
Nightwalker-87
Friends of Gort
Friends of Gort
 
Beiträge: 53
Registriert: 16. Apr 2017, 23:40

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

Beitragvon eax » 31. Dez 2017, 01:16

anonybot hat geschrieben:Bedeutet: es können nur 5 User an der Doku mitarbeiten. So hatte ich mir ein dezentrales Dokumentations-System für den Bot eigentlich nicht vorgestellt, weil dann nicht jeder einfach mitmachen kann, der Zeit und Lust hat, oder seh ich hier etwas falsch?

Ich hatte es so verstanden, dass der Inhalt der Dokumentation eh in einem GitHub-Repo liegt und das können ja beliebig viele Leute forken, Änderungen vornehmen usw. Ich dachte, die dort genannten "5 collaborators" beziehen sich lediglich auf die Präsentation der Inhalte auf gitbook Webseite. Dafür müssten wohl auch nicht mehr Leute zuständig sein, meiner Meinung nach ist die dezentrale Ablage der Inhalte der entscheidende Punkt, denn die kann ja auch jeder lokal anzeigen, wie er möchte. Evtl. habe ich das Ganze aber auch falsch verstanden. Vermutlich müsste man es einfach mal ausprobieren, um zu schauen, ob es für unsere Zwecke taugt.
eax
Friends of Robby
Friends of Robby
 
Beiträge: 760
Registriert: 18. Jan 2006, 17:16
Wohnort: Karlsruhe

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

Beitragvon lenchen » 14. Jan 2018, 01:47

anonybot hat geschrieben:Bedeutet: es können nur 5 User an der Doku mitarbeiten. So hatte ich mir ein dezentrales Dokumentations-System für den Bot eigentlich nicht vorgestellt, weil dann nicht jeder einfach mitmachen kann, der Zeit und Lust hat, oder seh ich hier etwas falsch?

Stimmt, verstehe ich auch so. Das ist dann natürlich nicht so ganz optimal...
Was hätten wir denn so für Alternativen?

Gruß
Lena
lenchen
Friends of Gort
Friends of Gort
 
Beiträge: 44
Registriert: 12. Apr 2011, 15:31

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

Beitragvon anonybot » 16. Feb 2018, 10:41

eax hat geschrieben:Ich hatte es so verstanden, dass der Inhalt der Dokumentation eh in einem GitHub-Repo liegt und das können ja beliebig viele Leute forken, Änderungen vornehmen usw. Ich dachte, die dort genannten "5 collaborators" beziehen sich lediglich auf die Präsentation der Inhalte auf gitbook Webseite. Dafür müssten wohl auch nicht mehr Leute zuständig sein, meiner Meinung nach ist die dezentrale Ablage der Inhalte der entscheidende Punkt, denn die kann ja auch jeder lokal anzeigen, wie er möchte. Evtl. habe ich das Ganze aber auch falsch verstanden. Vermutlich müsste man es einfach mal ausprobieren, um zu schauen, ob es für unsere Zwecke taugt.


Naja, aber selbst wenn es so ist, läuft es auf einen Vendor-Lock-In hinaus (was ich in jedem Fall vermeiden möchte): was bringen uns die Git-Repos, wenn man diese im Ernstfall nicht wirklich als Notfall-Doku verwenden kann? Spätestens bei in Anleitung eingepflegte Bilder wird es ja kaum möglich sein, diese über GitHub anzeigen zu lassen.

Ich habe gerade https://til.secretgeek.net/gitbook/use_ ... cally.html gefunden - scheinbar kann man gitbook doch auf eigenen Instanzen laufen lassen?

lenchen hat geschrieben:Was hätten wir denn so für Alternativen?


Wikibooks. Ich diskutiere da seit Ewigkeiten die Möglichkeiten für eine Doku-Migration. Dort hätten wir alles, was wir brauchen. Anfangs hatte mich dort genervt, dass niemand mir konkretere Aussagen darüber geben konnte, ob etwas wie die ct-Bot-Doku dort konzeptionell ein Zuhause finden könnte. Die letzten Antworten sind aber sehr spezifisch und diejenigen, die ich wollte.

Letzter Stand ist hier: konzeptionell ginge alles, solange wir uns an die Wikibooks-Regeln halten ("Wikibooks ist kein Support-Forum, kein Dateipool, kein Webserver".).
Ich fände den Ansatz spannend, weil die Plattform an sich am Ehesten dem Projekt-Charakter eines Bildungsprojekts entspricht und dann in den Händen einer Nonprofit-Orga wäre, die sich um die Erhaltung freien Wissens kümmert. Das ist ein Umstand, der nicht unterschätzt werden sollte.
anonybot
Friends of Sonny
Friends of Sonny
 
Beiträge: 146
Registriert: 7. Okt 2015, 00:14

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

Beitragvon Nightwalker-87 » 20. Feb 2018, 16:20

Also wenn man sich mit Gitbooks nicht anfreunden können sollte, dann würde ich eher das aktuelle ct-bot.de wiki ausbauen.
Das ist dann immer noch besser geeignet als wikibooks, aus meiner Sicht. Ich kenne Wikibooks bereits aus anderen Projekten. Es ist eine gute Sache wenn über ein in sich rundes Thema in einem Buch zusammenziehen will. Für dieses Projekt sehe ich da nicht die nötige Flexibilität und vor allem nicht die Nähe zum Code (was allerdings auch beim ct-bot.de wiki anzuführen wäre). Ich würde mich an dieser Stelle aber nicht nochmal auf eine individuelle Diskussion einlassen wollen.
Nightwalker-87
Friends of Gort
Friends of Gort
 
Beiträge: 53
Registriert: 16. Apr 2017, 23:40

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

Beitragvon Nightwalker-87 » 1. Apr 2018, 14:08

Nachdem sich im Slack/Matrix Chat nun ein Konsens abzeichnete, haben wir nun ein eigenes Git-Projekt für die Doku. Dorthin ist inzwischen auch das Backup vom alten Heise-Wiki umgezogen, das temporär im ct-Bot-Code zwischengespeichert war. Es erscheint sinnvoll auch mit dem ct-bot.de-Wiki so zu verfahren - zunächst einmal um ein Backup der Inhalte vorzuhalten.
Aktuell sind auf https://wiki.ctbot.de übrigens auch alle visuellen Darstellungen der Seiten verschwunden. Der Quellcode der Artikel ist aber noch vorhanden. Noch ist unklar was die Ursache hierfür ist.
Vielleicht kann marvin uns bei beiden Punkten weiterhelfen... :wink:
Nightwalker-87
Friends of Gort
Friends of Gort
 
Beiträge: 53
Registriert: 16. Apr 2017, 23:40

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

Beitragvon anonybot » 6. Apr 2018, 16:35

Danke Nightwalker!

Nightwalker-87 hat geschrieben:Nachdem sich im Slack/Matrix Chat nun ein Konsens abzeichnete, haben wir nun ein eigenes Git-Projekt für die Doku.


...wobei der Konsens darin besteht, die Doku dezentral über Git(Hub) zusammenzutragen und mit https://gitbook.com für End-User verfügbar zu machen.
Edit: Genauer gesagt nicht nur "verfügbar machen", sondern wohl auch online oder mit dem https://legacy.gitbook.com/editor erstellen, denn wenn Markdown von sich aus Bilder integrieren könnte, bräuchten wir GitBook nicht. So ganz ist mir hier die Verzahnung zwischen GitBook und GitHub noch nicht klar, weil ich aktuell noch keine Zeit habe, mir das mal praktisch anzuschauen. Unklar ist mir auch, unter welcher Lizenz https://legacy.gitbook.com/editor steht. Ich konnte zum Editor kein GitHub-Repo finden und auf der gitbook.com keine entsprechende Information. Es wäre ungünstig, wenn der Editor, auf den wir langfristig für die Doku angewiesen sind, proprietär ist.

Ganz wichtig an dieser Stelle: wir hatten uns meiner Erinnerung nach auf CC-BY-SA (nicht CC-BY-NC-SA) geeinigt, um kommerzielle Nutzung (zB auch durch Heise) nicht auszuschließen, aber die Erzeugnisse frei zu erhalten. Wenn wir das Doku-Repo von Nightwalker unter https://github.com/Nightwalker-87/ct-bot-doku/ als Ausgangs-Repo nehmen, sollte hier die Lizenz nochmal geklärt werden, falls es Klärungsbedarf gibt.
anonybot
Friends of Sonny
Friends of Sonny
 
Beiträge: 146
Registriert: 7. Okt 2015, 00:14

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

Beitragvon eax » 6. Apr 2018, 21:40

anonybot hat geschrieben:Edit: Genauer gesagt nicht nur "verfügbar machen", sondern wohl auch online oder mit dem https://legacy.gitbook.com/editor erstellen, denn wenn Markdown von sich aus Bilder integrieren könnte, bräuchten wir GitBook nicht.
Markdown kann problemlos Bilder integrieren.

anonybot hat geschrieben:So ganz ist mir hier die Verzahnung zwischen GitBook und GitHub noch nicht klar, weil ich aktuell noch keine Zeit habe, mir das mal praktisch anzuschauen.
Da gibt es keine Verzahnung, GitHub ist ein Online-Datenspeicher, der das Git-Protokoll unterstützt, GitBook ist ein Render-Dienst, der Markdown-Dateien auf einer Webseite hübsch anzeigt.

anonybot hat geschrieben:Unklar ist mir auch, unter welcher Lizenz https://legacy.gitbook.com/editor steht. Ich konnte zum Editor kein GitHub-Repo finden und auf der gitbook.com keine entsprechende Information. Es wäre ungünstig, wenn der Editor, auf den wir langfristig für die Doku angewiesen sind, proprietär ist.
Markdown-Dateien sind einfach Textdateien, die kannst du mit jedem beliebigen Texteditor bearbeiten: vi, vim, nano, emacs, notepad, libreoffice, was immer dir gefällt. Deren Editor hat halt eine hübsche Voransicht, die man aber in keiner Weise braucht, um die Doku zu erstellen oder zu editieren. Ich wage mal die Prognose, dass sich Textdateien auch in vielen Jahren noch mit verschiedensten Editoren bearbeiten lassen werden... (vermutlich mit auch immer noch denselben Problemen was Zeilenenden auf verschiedenen Systemen angeht, aber da ist ein anderes Thema :lol: )
eax
Friends of Robby
Friends of Robby
 
Beiträge: 760
Registriert: 18. Jan 2006, 17:16
Wohnort: Karlsruhe

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

Beitragvon Nightwalker-87 » 9. Apr 2018, 22:48

Wie ihr wahrscheinlich schon gesehen habt sind mit dem letzten Commit die Lizenz für das Projekt inkl. der userspezifischen Lizenzen für die Nutzer-Medieninhalte nun aktualisiert. Ich bitte euch noch einmal um sorgfältige Prüfung und anschließende Rückmeldung an mich, damit wir das Teilkapitel "Lizenz(en)" dann abschließen und den Fokus auf die weiteren Themen richten können. :wink: 8)
Nightwalker-87
Friends of Gort
Friends of Gort
 
Beiträge: 53
Registriert: 16. Apr 2017, 23:40

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

Beitragvon Nightwalker-87 » 10. Apr 2018, 00:00

Ich habe die Dokuliste mal aktualisiert:
https://www.ctbot.de/viewtopic.php?f=34&t=1219&p=6406#p6406
Nightwalker-87
Friends of Gort
Friends of Gort
 
Beiträge: 53
Registriert: 16. Apr 2017, 23:40

Vorherige

Zurück zu SimBot Talk

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast

cron