search

freifunk / api.freifunk.net

Freifunk Community API
http://freifunk.net/api-generator/
47 stars 24 forks source link

Add firmware configuration site.conf #146

Open rubo77 opened 8 years ago

viisauksena commented 8 years ago

ein aufwasch, die site.mk und modules enthält einen großteil der gwünschten pakete und es gibt ja eben noch ganz andere Techniken als gluon .. aber ich sagte ja bereits - ich finds gut

andibraeu commented 8 years ago

danke!

kannst du das bitte in development.json einbauen? eine neue Versionsdatei wird dann in einem nächsten Schritt gemacht... da müssen auch noch ein paar andere Sachen, wie z.b. die Versionsinformation in der Datei, das Changelog und der Generator angepasst werden

außerdem: die Erklärung wirkt noch ein wenig dürftig. Mal heißt es Repository, mal site.conf. Macht das doch bitte a) allgemeiner und formuliert b) die Sachen um. z.b. "Link to your community firmware profile" oder "your community's firmware configuration file"

Was wollt ihr am Ende mit diesem Eintrag machen?

rubo77 commented 8 years ago

done.

Wir wollen durch die verschiedenen site-conf repos ermitteln können welche gluon packages wie oft und wo verwendet werden.

Siehe https://forum.freifunk.net/t/uebersicht-aller-site-mk-paketzusammenstellungen/13155

viisauksena commented 8 years ago

im Moment steht da immernoch verwirrend site.conf / repository ... usw. es macht meiner Meinung nach Sinn entweder direkt auf die Config Dateien abzustellen , also site.conf, modules, site.mk einzeln einzutragen, oder einen Pfad zu den Config Dateien anzugeben, ich kenn die "nicht"-gluon Firmwares da draussen nicht, aber da kann es noch mal mehr ansprüche geben (die mit einem Pfad statt einzener gluon spezifischer Dateiene aber "erledigt" wären) die site.conf im speziellen enthält keine Refferenz zu den "Paketen" die benutzt werden in gluon, die bekommste nur wenn du site.mk (evtl mit kombi modules) ansiehst

FreifunkUFO commented 8 years ago

einen ähnlichen Vorschlag gibt es bereits: https://github.com/freifunk/api.freifunk.net/issues/118

großer Nachteil der vorgeschlagenen Verlinkung von site.conf: Das ganze funktioniert nicht allgemein-gültig für Freifunk Openwrt/LEDE, sondern NUR für die Communities, die Gluon-Firmware verwenden (und damit batman-adv only). Zudem scheint es (über die Jahre gesehen) auch kein einheitliches sit.conf-Format zu geben (siehe Änderungen Anfang des Jahres)

Besser wäre wohl, wie in #118 beschrieben die Wifi-Settings allgemein zu beschreiben und ggf. Software-Zusatzpakete darüber hinaus noch zu erwähnen.. Mit einem "Site.conf-Generator" könnten gluon-willige Communities daraus ihre site.conf generieren bzw. könnten wir das gleiche auch mit Meshkit-Firmware machen.

rubo77 commented 8 years ago

118 geht ja nur um die Wifi Settings, die benutzten Pakete in Gluon sind aber auch ganz anderer Natur:

Wir wollen eine gesamtübersicht der verfügbaren Pakete daraus generieren und auch statistiken erstellen, wie oft welche Module benutzt werden.

Ich dachte, wenn wir einfach auf das repository, in dem die site.conf, modules,... ist, verweisen, kann man das alles automatisiert extrahieren.

andibraeu commented 8 years ago

gluon-exklusive Felder finde ich auch nicht so toll.

Im Übrigen gibt es auch ein Feld Firmware Docs, was für einen entsprechenden Link genutzt werden könnte.

rubo77 commented 8 years ago

docs klilngt aber eher nach anleitungen ;)

FreifunkUFO commented 6 years ago

mittlerweile fände ich gluon-exclusive Felder toll, es ist besser als nichts! Beschriftung sollte allerdings nicht siteConf heissen, sondern dementsprechend klar gluonn-gekennzeichnet, zb. "gluonConf" (Ähnliches gilt für title und description). Wahrscheinlich gibt dann dort jeder seine github-gluon-config-fork-adresse an. Änderungen im site.conf Format sind sicher auch nicht so schlimm, das sollten die Gluonner ja im Griff haben. (Eine Versionierung jener Config scheint es nicht zu geben?)

rubo77 commented 6 years ago

Versioning gibt es schon, aber nicht standardisiert.

FreifunkUFO commented 6 years ago

nicht alle Gluonner sind bei github, einige haben zb auch gitlab :-o

zb https://gitlab.com/FreifunkChemnitz/site-ffc/blob/chemnitz/site.conf

rubo77 commented 6 years ago

@FreifunkUFO: Ich will hier die URL zur gluon site.conf sammeln, also ist der titel dieses PRs doch korrekt, oder?

Die url hat auch nichts mit github zu tun, oder was meinst du? Ich habe das so allgemein wie möglich gefasst, damit jede auch nicht-gluon- community dort etwas sinnvolles eintragen kann. Anhand des wertes in "Firmware Name" kann man dann ja sehen ob das gluon ist oder nicht.

Was meinst du sollte ich hier noch genau ändern?

rubo77 commented 5 years ago

Wie ist der Status hier? wurde dahingehend schon was eingebaut inzwischen?

Die übersicht der gluon site configs ist ja inzwischen ins Wiki gewandert: https://github.com/freifunk-gluon/gluon/wiki/Site-Configurations

Ich habe site-conf-scraper gebaut, der darauf baut:

https://github.com/rubo77/site-conf-scraper

Allerdings ist in einigen der sites nicht automatisch ermittelbar, welches der aktive branch ist

christian-weiss commented 5 years ago

@rubo77 cooles kleines Script, hast Du da. Nie war es so leicht sich alle Firmware-Repos herunterzuladen. Schade dass die ganzen Site-URLs dort statisch definiert sind.

Ich setze gerade ein Qualitätsmonitoring für die Freifunk Community Registry (directory.json) inkl. aller referenzierten Community API Dateien. Es wäre mir ein leichtes, eine firmware-site.json zu generieren, die Du dann verwenden könntest. Siehe auch: https://github.com/freifunk/directory.api.freifunk.net/issues/579

Interesse?

christian-weiss commented 5 years ago

Bzgl. des eigentlichen Themas dieses PRs:

Die Community API Datei dient in erster linie zum maschinellen Verarbeiten von Informationen. Was genau ist der Use Case für ein neues Feld "site.conf"? Geht es nur um Statistik?

Immerhin muss dieses Feld ja von jemanden gepflegt werden, sowas veraltet gerne mal (wird vergesse). Macht das Sinn zu pflegen? Würde ein link auf das Firmware-Repo nicht reichen? Kann man die Datei vielleicht per Namenskonvention (Location) ggf. leicht automatisiert ermitteln? Ansonsten blasen wir uns die API mit zig "nice to have"- oder "firmware-specific"-Feldern auf. JustMy2Ct

rubo77 commented 5 years ago

@rubo77 cooles kleines Script, hast Du da. Nie war es so leicht sich alle Firmware-Repos herunterzuladen. Schade dass die ganzen Site-URLs dort statisch definiert sind.... Interesse?

Ja gerne, Ich habe dich als collaborator in meinem repo geadded, vielleicht kannst du es da einfach einbauen, (hab grad wenig zeit, bin gerade in Elternzeit)

christian-weiss commented 3 years ago

@rubo77 können wir Deinen Pull Request vielleicht in diesem Monat über die Ziellinie bringen? Über eine Antwort auf https://github.com/freifunk/api.freifunk.net/pull/146#issuecomment-524533635 würde ich mich sehr freuen. Nach derzeitigem Stand würde ich dafür stimmen diesen PR zu schließen, da ich den Mehrwert noch nicht erkannt habe.

rubo77 commented 3 years ago

Würde ein link auf das Firmware-Repo nicht reichen?

ja an einen link hatte ich gedacht, was fehlt denn noch um diesen PR anzunehmen?

christian-weiss commented 3 years ago

Was noch fehlt: "This branch has conflicts that must be resolved" Zudem muss nicht nur die development.json angepasst werden, sondern zusätzlich eine neue Version, z.B. 0.5.1.json erstellt werden.

rubo77 commented 3 years ago

Kann die nötigen Anpassungen hier eventuell jemand übernehmen? Ich bin etwas raus leider seit ein paar Jahren