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: 41
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:

1) c't-Bot in Aktion

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

2) Anlaufstellen

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

c't-Artikel --> gesichert
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 im Chat: IRC-Server irc.blitzed.org, Port 6667, Raum #ct-bot (auch als ​Web-Chat erreichbar) --> 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
Firmware auf den realen Bot Übertragen (Flashen)

4) Hardware

Überblick über die ct-Bot-Hardware
Schaltpläne
Stücklisten
Aufbauanleitung
Erweiterungen
Firmware flashen
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
Konfiguration der Sim-Optionen
Howto zum Sim

6) Zugang zum Source-Code --> Rubrik entfällt komplett, muss durch Einführung in Github-Repository ersetzt werden

7) Entwicklungsumgebung

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

8) Was es hier gibt (Trac) --> Rubrik entfällt komplett, muss durch Einführung in entsprechende Github-Funktionen ersetzt werden

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
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, muss durch Einführung in Github-Repository ersetzt werden
Nightwalker-87
Friends of Gort
Friends of Gort
 
Beiträge: 41
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: 139
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: 41
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: 758
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: 42
Registriert: 12. Apr 2011, 15:31

Vorherige

Zurück zu SimBot Talk

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast

cron