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

Neuigkeiten zum c't-Bot und c't-Sim
anonybot
Friends of Sonny
Friends of Sonny
Beiträge: 190
Registriert: 07 Okt 2015, 00:14

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

Beitrag von anonybot » 22 Feb 2019, 23:50

Klasse, danke für die Mühen, nightwalker.

Was MediaWiki betrifft: Ich wäre ehrlich gesagt dankbar, wenn wir die Dokumentation komplett in einem "System" sammeln - hatten wir uns da nicht schon (grob) auf Git(Book) in Kombination mit Markdown-Dateien geeinigt, damit wir das Wissen dezentral sichern können?

Falls das nach wie vor der Fall ist, ist mir aktuell Unklar, wo die zentrale Sammelstelle ist: https://github.com/Nightwalker-87/ct-bot-doku oder https://github.com/tsandmann/ct-bot-doku ?

Von den Möglichkeiten finde ich eine Markdown-Doku vollkommen ausreichend (denn weniger Möglichkeiten der Gestaltung bedeutet auch weniger Chaos im kollaborativen Bearbeiten). Ein neues (zusätzliches) MediaWiki würde bedeuten, dass die Doku wieder gestreut wird (Git VS MediaWiki).
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: 180
Registriert: 16 Apr 2017, 23:40

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

Beitrag von Nightwalker-87 » 23 Feb 2019, 01:33

ok, dann lasst uns das als Markdown-"Wiki" in git realisieren.

Beim Aufräumen im alten ct-Bot wiki wurde noch einmal deutlich wie viel Administration da wirklich dahinter stecken kann (Nutzerverwaltung, Namensräume, Artikel-Kategorien, Artikel-Bearbeitungsrechte). Alleine das bisschen Aufräumen und Sichern hat fast einen ganzen Tag gekostet.
Auch die Datenbankstuktur ist sehr komplex was ich bisher dazu gesehen habe. Da wäre eine Realisierung via Git deutlich schlanker. Auch hat man dann den Ärger mit Spam und Vandalismus los... :mrgreen:

Allerdings sollte man das dort dann auch sauber in einer neuen Dateistruktur in unserem git-Dokuprojekt aufsetzen. Das nun dank Markdown wieder lesbare trac-wiki ist ja nur ein Provisorium und keine Arbeitskopie.

:idea: Was das git-doku-projekt betrifft:
Ich hoste https://github.com/Nightwalker-87/ct-bot-doku (Source-Repo) und https://github.com/tsandmann/ct-bot-doku ist ein Fork davon - also ensprechend ohne die erweiterte Github-Projektverwaltung und das -Ticketsystem.
nw-87

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

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

Beitrag von eax » 24 Feb 2019, 20:11

Ja genau, ich hatte das ct-bot-doku Repo nur geforked, um kurzfristig den Trac-Wiki-Export als Markdown bereitstellen zu können, als das Trac dann plötzlich down war. Wie in der Readme beschrieben, ist das ja auch nur eine temporäre und noch unfertige Lösung.
Timo -- Meine Beiträge sind unter CC-BY-SA freigegeben

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

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

Beitrag von Nightwalker-87 » 26 Feb 2019, 22:39

So, da wir ja nun schon wieder einen Schritt weiter zu sein scheinen, hole ich das Thema "Wiki" jetzt mal wieder in das richtige Unterforum zurück. :wink:

Das Doku-Projekt enthält nun die Config für Github-Pages und eine Portalseite. Dort liegt jetzt eine überarbeitete / ergänzte Portalseite. Das sieht jetzt erstmal so aus.

Von dort wird auf eine Wiki-Hauptseite verlinkt, die aktuell als Demo-Seite existiert. Aktuell findet sich hier nur ein Abschnitt zu den Lizenzbestimmungen. Die Wiki-Inhalte (also aktuell die Demo-Seite) liegen dann im Projekt-Unterverzeichnis /doc . Hier könnte nun für jeden neuen Artikel eine einfache Markdown-Datei abgelegt werden. Neu zu verlinkende Bilder können sauber in einem Unterverzeichnis /doc/images abgelegt werden und sind so nicht mehr einem Artikel zugeordnet - so wie im Trac-Wiki-Backup. Das erscheint so übersichtlicher und logischer.

Diese Struktur hat aber auch noch einen anderen Vorteil - die Trennung der Inhalte nach Art der Lizenz: Alle Dateien in /doc sind im wiki eingebunden, stehen unter der CC-BY-SA und das ist ein in sich geschlossener Bereich, da sich dann alle internen Wiki-Verlinkungen nur in diesem Verzeichnis abspielen.

Prinzipiell könnte es mit dieser Grundstruktur jetzt an die tatsächlichen Inhalte gehen... \:D/
nw-87

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

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

Beitrag von Nightwalker-87 » 26 Mär 2019, 20:56

Moin!

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.

Weitere Inhalte folgen nach und nach. Während die Umgestaltung und Reformattierung relativ schnell und einfach vonstatten geht, so ist die gleichzeitige Content-Überarbeitung und -Aktualisierung umso aufwändiger. Die Aufbereitung einer Seite vergleichbar mit der Obigen nimmt so durchaus einige Stunden in Anspruch.

Wäre cool wenn jemand die Inhalte auch mal gegenliest. :wink:

:idea: Hinweis: Die internen Verlinkungen zu altem Trac-Wiki-Content funktionieren noch nicht alle, da dazu noch einige Links zu aktualisieren sind. Wenn ansonsten irgendwas auffällt, dann dafür bitte wie vorgesehen ein Ticket im Projekt aufmachen...

Insgesamt sind noch 44 Artikel zu überarbeiten. #-o
nw-87

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

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

Beitrag von eax » 27 Mär 2019, 20:15

Sehr cool! :D

Ich lese es mal im Detail gegen. Was mir direkt schon auffällt: Der Hinweis zum Nachfolger des USB-2-Bot Adapters ist verschwunden, war das Absicht?
Timo -- Meine Beiträge sind unter CC-BY-SA freigegeben

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

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

Beitrag von Nightwalker-87 » 27 Mär 2019, 23:51

Ich freue mich, dass es gefällt. :mrgreen:

Zu deinem Hinweis:
Ja schon, da zum Einen auch der Nachfolger selbst nicht mehr bei Segor verfügbar ist (soweit ich das sehen konnte).
Darüber hinaus wäre es hier zum Anderen auch sinnvoller, einen separaten Artikel für eine Alternative zu erstellen.

Ich würde zukünftig die Vermischung von alten Komponenten und neueren Alternativen innerhalb eines Artikels gerne aufheben und stattdessen separate Artikel pflegen, welche dann einfach ausgetauscht werden können. Das erleichtert die Administration und somit lassen sich veraltete Teile der Dokumentation auch einfach in einen separaten Teil ausgliedern (Modularitätsprinzip). :wink:
nw-87

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

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

Beitrag von eax » 28 Mär 2019, 21:08

Ah okay, ja das klingt sehr sinnvoll :)

Dass der "Nachfolger" bei Segor nicht mehr verkauft wird, wusste ich nicht, dann sollte man vielleicht mal eine Alternative raussuchen für alle, die dafür ein fertiges Produkt haben wollen.
Timo -- Meine Beiträge sind unter CC-BY-SA freigegeben

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

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

Beitrag von Nightwalker-87 » 28 Mär 2019, 23:24

Jo, da könnte sich ja der vorgestellte AVR-Programmer eignen; muss vorher aber nochmal getestet werden. Ich habe derzeit noch nicht genug Artikel zusammen damit sich eine Bestellung lohnt.
nw-87

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

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

Beitrag von Nightwalker-87 » 03 Apr 2019, 22:34

Der nächste Artikel steht zum Review :shock: :lol: bereit: BeagleBoard-Erweiterung
nw-87

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

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

Beitrag von eax » 07 Apr 2019, 13:52

Nightwalker-87 hat geschrieben:
03 Apr 2019, 22:34
Der nächste Artikel steht zum Review :shock: :lol: bereit: BeagleBoard-Erweiterung
Super, danke :)

Mir sind da jetzt beim Durchlesen keine Fehler aufgefallen. Die Informationen sind halt deutlich veraltet, von daher ist das inhaltlich nicht mehr wirklich zu überprüfen.
Timo -- Meine Beiträge sind unter CC-BY-SA freigegeben

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

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

Beitrag von Nightwalker-87 » 07 Apr 2019, 15:44

Gut, danke. :wink: Überschüssige Bilder im Installationsteil ohne Informationsgehalt , kegele ich bei nächster Gelegenheit noch raus, weil das nur das Repo unnötig aufbläht und die Leserlichkeit stark beeinträchtigt.
nw-87

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

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

Beitrag von Nightwalker-87 » 07 Apr 2019, 15:53

Der nächste Artikel steht zum Review bereit: Dokumentation zur virtuellen Speicherverwaltung für SD-Karten
nw-87

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

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

Beitrag von eax » 11 Apr 2019, 00:01

:)
Mir sind da beim Durchlesen keine Fehler oder so aufgefallen.
Timo -- Meine Beiträge sind unter CC-BY-SA freigegeben

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

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

Beitrag von Nightwalker-87 » 22 Apr 2019, 18:13

eax hat geschrieben:
07 Apr 2019, 13:52
Nightwalker-87 hat geschrieben:
03 Apr 2019, 22:34
Der nächste Artikel steht zum Review :shock: :lol: bereit: BeagleBoard-Erweiterung
Super, danke :)

Mir sind da jetzt beim Durchlesen keine Fehler aufgefallen. Die Informationen sind halt deutlich veraltet, von daher ist das inhaltlich nicht mehr wirklich zu überprüfen.
Nachdem ich es nun lange genug vor mir hergeschoben habe, ist der obige Artikel nun noch einmal leicht überarbeitet worden. Dabei ließ sich die Anzahl der Bilder deutlich reduzieren, ohne dass Installationsschritte verkürzt dargestellt werden. Ein erneuter prüfender Blick wäre trotzdem ganz hilfreich. Hin und wieder übersieht man ja gerne mal etwas... :roll:
nw-87

Antworten