Anfänger-Feedback

[henfri]

Moin,

ich habe gerade versucht, den Einstieg in Konnekting zu finden. Da meine Erinnerungen an das Demo-Video und die Posts in diesem Unterforum nicht mehr frisch sind, habe ich die Gunst der Stunde genutzt, bei Null zu starten und die Doku zu gesten.

Also: google-> Konnekting --> führt auf die Github seite.
Da ist man erstmal verwirrt, dass es nur Dateien/den Code zu sehen gibt. Man kann doch auch eine Website hosten, bei Github, oder?
Wenn man aber erstmal verstanden hat, dass unten Text steht, findet man eine sehr schöne Doku!
Allerdings ist https://github.com/KONNEKTING/Konnek...kting_suite.md leer.

Dann will man aber irgendwann loslegen. Und da hängt man dann. Man weiß zwar, wie die xml und auch der Code zu schreiben ist. Aber wie Kompiliere ich den code? Wo gibt es die Bibliotheken und die Suite zum Download?

Hier im Unterforum sind zwei Threads sticky, die das erklären. Sehr gut sogar. Aber ich denke, diese Erklärungen wären besser auf github aufgehoben. Ich finde, ihr dürft solche Threads/Erklärungen auch gerne -für die Wiedernutzung auf Github- auf englisch verfassen.

Bitte nicht als Kritik verstehen. Ich habe alles gefunden, was ich brauche und es ist super dokumentiert. Es fehlt nur das letzte Bisschen.

Gruß,
Hendrik

[tuxedo]

Moin,

ich habe gerade versucht, den Einstieg in Konnekting zu finden. Da meine Erinnerungen an das Demo-Video und die Posts in diesem Unterforum nicht mehr frisch sind, habe ich die Gunst der Stunde genutzt, bei Null zu starten und die Doku zu gesten.

Also: google-> Konnekting --> führt auf die Github seite.
Da ist man erstmal verwirrt, dass es nur Dateien/den Code zu sehen gibt. Man kann doch auch eine Website hosten, bei Github, oder?
Wenn man aber erstmal verstanden hat, dass unten Text steht, findet man eine sehr schöne Doku!

Auf Github haben wir dafür extra ein Doku-Projekt:

https://github.com/KONNEKTING/KonnektingDocumentation

Allerdings ist https://github.com/KONNEKTING/Konnek...kting_suite.md leer.

Jepp, steht auf der elendig langen "ToDo" Liste. Auf der anderen Seite: Die Suite ist weitgehend selbsterklärend (weitgehend, nicht komplett...). Das ist dann auch einer der Gründe warum die Suite noch nicht so gut dokumentiert ist.

Dann will man aber irgendwann loslegen. Und da hängt man dann. Man weiß zwar, wie die xml und auch der Code zu schreiben ist. Aber wie Kompiliere ich den code? Wo gibt es die Bibliotheken und die Suite zum Download?

Hmm, stimmt. Für den totalen Noob sollte man ggf. noch prägnanter erwähnen dass es sich bei der KONNEKTING Device Library um eine Arduino Lib handelt, wie man diese in die Arduino IDE rein bekommt und wie man das Beispielprojekt lädt.

Hier im Unterforum sind zwei Threads sticky, die das erklären. Sehr gut sogar. Aber ich denke, diese Erklärungen wären besser auf github aufgehoben. Ich finde, ihr dürft solche Threads/Erklärungen auch gerne -für die Wiedernutzung auf Github- auf englisch verfassen.

Da ich mit meiner Reg-Controller Entwicklung eine Art Bausatz-Ansatz verfolge, ist hier sowohl eine Aufbau/Lötanleitung geplant, sowie eine PDF die den direkten Einstieg bebildert erklärt. Aber mein Tag hat nur 24h :-(

Von uns vier Kern-Projekt-Mitgliedern sind aktuell zwei beruflich/privat/krankheitsbedingt so stark eingespannt, dass unterm Strich noch zwei bleiben die sich um das meiste Kümmern. Wir würden es begrüßen wenn sich freiwillige finden die am Projekt etwas mithelfen. Da wir aktuell schon ausreichend Hardwarebaustellen haben die in Arbeit sind und es offenbar an der Doku noch hapert, wäre in dieser Ecke Hilfe hilfreich.

Dokuverbesserungen/erweiterungen nehmen wir gerne als Pull-Request auf Github entgegen. Hat halt die Hürde "man muss sich ein wenig mit git/github auskennen"

Bitte nicht als Kritik verstehen. Ich habe alles gefunden, was ich brauche und es ist super dokumentiert. Es fehlt nur das letzte Bisschen.

Kritik ist immer gut, sofern sie angebracht ist. Und das ist sie hier eindeutig. Danke.

[henfri]

Auf Github haben wir dafür extra ein Doku-Projekt:

https://github.com/KONNEKTING/KonnektingDocumentation

Ja genau. Das habe ich gelesen.

Jepp, steht auf der elendig langen "ToDo" Liste. Auf der anderen Seite: Die Suite ist weitgehend selbsterklärend (weitgehend, nicht komplett...). Das ist dann auch einer der Gründe warum die Suite noch nicht so gut dokumentiert ist.

Ist ja auch ok. Aber ein Download Link und vvlt ein Link zum Demo-Video würden schon helfen.

Hmm, stimmt. Für den totalen Noob sollte man ggf. noch prägnanter erwähnen dass es sich bei der KONNEKTING Device Library um eine Arduino Lib handelt, wie man diese in die Arduino IDE rein bekommt und wie man das Beispielprojekt lädt.

Ja, das würde schon reichen. Ich hab's ja auch hinbekommen, nachdem ich den Forum-Beitrag gelesen habe. Das reicht völlig.

Da ich mit meiner Reg-Controller Entwicklung eine Art Bausatz-Ansatz verfolge, ist hier sowohl eine Aufbau/Lötanleitung geplant, sowie eine PDF die den direkten Einstieg bebildert erklärt. Aber mein Tag hat nur 24h :-(

Ich finde, das ist gar nicht nötig. Wie gesagt: Alles schon da, halt in Deutsch und verteilt im Forum.

Dokuverbesserungen/erweiterungen nehmen wir gerne als Pull-Request auf Github entgegen. Hat halt die Hürde "man muss sich ein wenig mit git/github auskennen" :

Ich nehme es mir vor.

Gruß,
Hendrik

[henfri]

Hallo,

überlegt euch doch mal, ein Wiki für die Doku aufzusetzen.
Die Variante über Pull-Request ist eine blöde Einstiegs-Hürde. Ich hätte in einem Wiki heute schon einiges getippt.

Gruß,
Hendrik

[Eugenius]

Gute Idee.

[tuxedo]

Die Doku war anfangs im Github-Wiki. Das hat nur den Nachteil dass man es ausschließlich mit Github pflegen kann.

Die Doku wie sie jetzt ist, ist 1:1 das gleiche wie das Wiki (Syntax und alles), aber eben in der Versionsverwaltung eingecheckt.

Die Github-Hürde zu meistern lohnt sich. Denn wir werden den Code ja nicht ebenfalls in ein Wiki auslagern. Und bei Code-Änderungen (das Projekt ist eben zu 95% ein Softwareprojekt) brauchst du auch wieder Git-Kenntnisse.

Die Doku-Alternative ist, du wirst ins Team aufgenommen und kannst direkt die Doku-Seiten auf Github ändern, ohne Fork, ohne Pullrequest.

[henfri]

Hallo,

ich denke da ja nicht nur an mich. Aber es wird doch ganz sicher User geben, die kaum/keinen Code beitragen (ich), aber bei der Doku helfen können.
Ich bekomme das mit Git auch hin. Aber dann ist der Kram erstmal auf der Linux-Kiste. Und darin editieren ist blöd. Für jede Änderung dann auf die Kommandozeile = Hürde.

Ich verstehe nicht, warum Code und Doku an gleicher Stelle (=beides Github oder beides Wiki) sein muss. Dahier kann ich das Argument

Die Github-Hürde zu meistern lohnt sich. Denn wir werden den Code ja nicht ebenfalls in ein Wiki auslagern.

nicht nachvollziehen.
Ich sehe nicht, was für eine Doku im Github statt im Wiki spricht.

Gruß,
Hendrik

[tuxedo]

Du brauchst keinerlei Kommandozeile oder Linux.

Du kannst, wenn du GH User bist, das Projekt direkt auf der Webseite mit einem klick forken, darin herumeditieren und die Änderung mit einem Klick zu einem PR machen.

Die Idee der bisherigen Doku war, dass es mehr die "ExpertenDoku" ist. Deshalb findet man da auch die tiefen Internas der Konnekting-Protokolls, die sonst keinen Anfänger interessieren.
Auf der Plan steht das aufsetzen einer benutzerfreundlichen Webseite, die alles notwendige inkl. Einsteiger-Anleitung enthält. Die ist als zentrale Anlaufstelle dringend benötigt. Wer nicht aus dem Forum hier kommt, muss die Infos an vielen Stellen zusammenkratzen.

Schönwetter und Terrassenbau-bedingt, hab ich die letzten Tage das Forum hier etwas schleifen lassen. Nun sitze ich hier schon über eine Stunde und beantworte Fragen im Forum etc.

Prio #1 hat aktuell beta4 sowie das fertigstellen des Reg-Controllers. Wenn dann die ersten mit dem Reg-Controller aufbauen und dem ausprobieren der beta4 beschäftigt sind, setz ich mit an die Webseite.