Änderungen/Mitarbeit an der Doku

Weiterentwicklung Dokumentation
#1

Hallo liebes Doku-Team,
ich bin ganz neu bei der Linuxmuster.net und habe mit der Hilfe eurer Doku meinen ersten Server aufgesetzt und mit tatkräftiger Hilfe aus dem Forum eine nicht domainintegriertes Image aufgesetzt. Daher erst mal danke an euch und an die ganzen Kollegen für die Unterstützung!

Nun habe ich zwei Ideen:
Zum einen würde ich gerne zum Aufsetzten des Images eine kleine Anleitung schreiben. Habe mir schon notiert, was ich so habe machen müssen… Selbst habe ich mir die Infos im Forum zusammen gesucht bzw. direkt um Hilfe gebeten.

Außerdem hätte ich zur vorhanden Doku ein paar Änderungsvorschläge (Reihenfolgen, Ergänzungen). Als Neuling, der ja überhaupt nicht weiß, was die Linuxmuster.net ist und was es mit LINBO, start.conf, cloops, Postsync-Skripten, etc. auf sich hat, viel es mir an ein paar Stellen schwer zu verstehen, was ich tun muss…

Daher nun meine Frage: Habt ihr Interesse daran, dass ich ein paar Vorschläge mache? Und falls ja, wie soll ich das machen? Nutzt ihr Git? Oder soll ich die Vorschläge in einem PDF zusammenschreiben?

Liebe Grüße,
Leo

2 Like
#2

Hallo Leo,

Dein Angebot finde ich Klasse. Mitarbeiter werden immer gebraucht. Ich denke das Doku-Team @Tobias wird sich bei Dir melden.

Viele Grüße

Alois

#3

Hallo Alois, danke fürs poking.

Hallo Leo,

super tolle Idee. Die Dokumentation kann sicher an ganz vielen Stellen verbessert werden. Auch wenn ich immer als „head of documentation“ irgendwo stehe, erfülle ich die Aufgabe immer wieder miserabel. Gerade tauche ich langsam aus einem Coronaschlaf auf…
Ich würde eher sagen, die Dokumentation ist ein loser Haufen, einer von @cweikl, @MachtDochNix, @toheine, @alois, @zefanja, @sedding weiß vermutlich gerade am Besten, was es gerade zu tun gäbe. Die (und ich) würden auch auf grundsätzliche Diskussionen bezüglich Änderungsvorschläge eingehen.

Änderungsvorschläge: Poste die doch einfach mal hier. Von mir aus, nenne den Thread um oder stelle einen neuen auf.

Anleitung für Erstellung eines (neuen, vermutlich) Images: Hm, da sollen die anderen auch was sagen, bin mir nicht sicher, ob das eine gewollte STrategie ist in der Hauptdoku, oder ob das ins Wiki sollte.

Ja, wir nutzen git. Für kleine Änderungen kannst du das sofort einsetzen, am Ende der Doku findest du auch ein Kapitel dazu. PDF lohnt sich nur dann, wenn du explizit schon mal eine Anleitung mit vielen Bildern schon in so einem Dokumentenformat hast. Am ende sollte das nach rst/sphinx oder ins Wiki.

VG, Tobias

#4

Hallo Tobias,
für mich waren folgende Dinge schwierig zu verstehen (was natürlich nicht zwangsläufig an der Dokumentation liegen muss ;-):

  • Bei der Funktionsweise und Grundlagen der Postsync-Scripte war mir z.B. lange nicht klar, in wie fern diese etwas mit den Patchklassen zu tun haben. Hier hat mir der Gesamtüberblick etwas gefehlt. Auch fände ich es gut, wenn der Hinweis, dass das Paket linuxmuster-client-servertools benötigt wird hilfreich - davor findet man auf dem System die aufgezählten Dateien nicht… Jetzt finde ich schon, dass alles wichtige drin steht, aber ich könnte mir vorstellen, dass durch ein Ändern der Reihenfolge manches für Laien einfacher wird…
  • Auch fände ich eine Seite hilfreich, auf der erklärt wird wie LINBO so funktioniert: Z.B. warum man zuerst partitionieren und dann neustarten muss (Cachelaufwerk gemountet); was alles in der start.conf drin steht und wie diese mit der grub.cfg zusammen hängt. Und was diese wiederum mit der cloop-Datei zu tun hat…
  • Würde auch anbieten ein Howto zu schreiben, wie man ein eigenes Image (in meinem Fall für Leihlaptops) aufsetzt. Hier würde das Wissen, was ich aus den Threads und meiner Erfahrung gesammelt habe mal zusammen schreiben. Da werden ja oben genannte Zusammenhänge auch deutlich…

Mein Vorschlage wäre, dass ich einmal auf Git euer Projekt zu forke und dann probiere per Sphinx hier und da einen Pullrequest zu erstellen. Denke das wäre eine übersichtliche Methode und du/ihr wisst besser, was ich meine. Man muss das dann ja nicht umsetzten, sind ja nur Vorschläge :wink:

Was meinst du?

Liebe Grüße,
Leo

#5

Hallo nochmals,
habe mi die Anleitung in der Doku zur Mithilfe durchgelesen. Würde jedoch nur ungerne das in einer VM erledigen, sondern lieber lokal… Bei make html erscheint jedoch der Fehler:

File „/usr/lib/python3/dist-packages/sphinx/search/de.py“, line 14, in
import Stemmer
ModuleNotFoundError: No module named ‚Stemmer‘

Hast du einen Tipp für mich? Habe online nichts finden können. Oder ist es sehr viel Aufwand Sphinx lokal zum Laufen zu bringen?
Liebe Grüße, Leo

#6

5 Beiträge wurden in ein neues Thema verschoben: Partionierung und Neustart

#7

Hallo Leo!

Ich habe den Post mal aufgetrennt, da die bisherigen Antworten ja nix mit dem zuletzt genannten Problem zu tun hatten. Bis du mittlerweile weiter, oder klemmt es immer noch?

Beste Grüße

Thorsten

#8

Super dank dir!
Habe alles lokal hin bekommen und würde nun einfach mal ein paar Änderungen über Git vorschlagen.
Hast du eine Idee, wo ich Fragen stellen wenn ich mir bei Zusammenhängen unsicher bin?
Z.B:
In der Doku vestehe ich den originalen Text zu den Postsyncscripten so, dass es zwei Postsyncskripte gibt. Eines das quasi nach dem Synchronisieren mit dem Server angewendet wird und ein „universelles“ Postsyncscritp. Stimmt das? Ich kenne nämlich nur das Imagename.cloop.postsync

Wird das Imagename.cloop.postsync auch angewendet, wenn das Paket linuxmuster-client-servertools nicht installiert ist?

Liebe Grüße,
Leo

#9

Hallo Leo,

Wird das Imagename.cloop.postsync auch angewendet, wenn das Paket
linuxmuster-client-servertools nicht installiert ist?

ja: das ist ein hock der in linbo ist.
Nur ist es meist witzlos, wenn die Verzeichnisse
/srv/linbo/linuxmuster-client/patchklasse/
nicht existieren.
Die kann man aber auch von Hand anlegen.

LG

Holger