yaVDR-Dokumentation verbessern: Wer macht mit?

Du hast schon den Lex gelesen den hepi geschrieben hat ? Wenn ja dann bitte nochmal.

Lex oO ? Könnt die Einträge hier gerne löschen wenn geklärt, ist ja nur OT geblabbel...

All das gibt es doch schon soweit größtenteils im vdr-wiki. Nur muss ein wiki *von seinen Benutzern* leben. Ohne stagniert es.

Am Beispiel der channels.conf sieht man das sehr schön...
Das Format der Datei ist festgelegt und dokumentiert, trotzdem werden immer wieder Daten im falschen Dateiformat dort reingepackt oder gar doppelte Daten dort hingepackt. Aktualisert werden die Daten auch genau dann, wenn sich ein Nutzer des wiki die Mühe macht - und bei einigen Dateien ist das halt selten. Daran ändern bunte Dropdown-Menüs oder ein andres layout auch nichts.

Am Beispiel von KlimBim sieht man auch, dass das beste wiki nichts nützt, wenn es zu wenig benutzt wird. Und das würde auch jeden Doku-Neuanfang betreffen, wenn VDR-Neulinge davon ausgehen, dass >>Andere<< für sie dokumentieren. Ein Entwickler wird sein Werk schon dokumentieren - nur das eher nicht in einer wiki, sondern hauptsächlich in der README im Sourcecode und auf der Projektseite selbst. Mal abgesehen davon, dass viele Plugins verwaist sind und es gar keine aktiven Entwickler mehr gibt.

Genau deswegen wollte ich die Diskussion getrennt haben. Beides ist wichtig.

Thema:
1.) 1+ Leute wollen eine yaVDR Doku erstellen ...
2.) VDR Dokumentation erneut zu Tode diskutiert. (Wie oft noch ?)

Zu zweitens bleibt nur eine Frage: Wie verkauft man das besser ?

wirbel: Das definierte channels.conf Format ist doch nicht wirklich nutzbar. 1200 Kanäle alphabetisch sortiert (!!??) Was am Grundproblem nix ändert, hast ja recht

Zitat

Original von Wicky
wirbel

Deine Bedenken gehen mir auch seit Tagen durch den Kopf:

- > Ohne Leute, die sich dem Thema Doku annehmen, wird der beste Rahmen für eine Dokumentation nichts.

Folgendes frage ich mich:
(A) Aber warum gelingt es anderen Open-Source Projekten eine Dokumentation auf die Beine zu stellen die eine anständige Qualität besitzt und auch Neueinsteigern hilft?
(B) Was sind beim VDR/yaVDR die Schwierigkeiten?
(C) Was muss man machen, damit sich mehr Leute an einer (hochwertigen) Dokumentation beteiligen?

Gruß
Wicky

Alles anzeigen

Hallo,

ich erlaube mir mal das an einem Beispiel zu erklären aus Sicht eines Noobs.
Ich lese folgendes:

Zitat

Original von gda

In jedem geänderten Paket ist ein Changelog und da gehört es auch hin.

Gerald

Denke "aha" und wo sind die wohl. Schau ich doch mal bei launchpad (ist das noch Einsteigerniveau?)
Da war doch heute ein update von extrecmenu, was sich da wohl gändert hat. Hmmm, package details, hmmm, changelog..... ok bin zu blöd.
Ok, lade ich mir das Paket herunter. ...hmmmm

D.h. selbst wenn ich wollte, könnte ich eine ev. vorhandene Doku nicht aktuell halten.
Ist nur ein Beispiel.
Ich wollte damit nur illustrieren, dass bei allen unbestrittenen Qualitäten des Projektes es sich doch an einen recht kleinen Personenkreis bzgl. der vorhandenen Doku richtet: plugin-Entwickler, vdr-Distri- Umsteiger ....

Je weniger Leute verstehen worum es geht und was aktuell ist, desto weniger stehen potentiell zu ausführlichen Doku zur Verfügung.

gruss

(Ist nix bös gemeint )

Guten Abend,
zu (B) fällt mir als erstes der schnell Wandel ein, die yavdrler sind halt recht fix
zu (C) braucht es sicher niedrige Zugangshürden, so wie das VDR Wiki das schon hat,
und halt Leute die manchmal den Spam oder Unsinn entsorgen wie Wirbel und Hulk

Gruß
Ulf

Ergo Schreiben können das Viele aber die Qualität warten und erhalten ist ein harter Job

Ich wage mich mal mit ner kleinen Frage mitten in eure fortgeschrittene Diskussion:
- Wäre es evtl. auch eine Überlegung wert, die Dokumentation zusätzlich zu ner Website auch direkt mit in die Distribution zu hängen ?

Ich könnte mir vorstellen, dass ich über das Webfrontend einen unmittelbaren Zugriff auf yaVDR Dokumentation hätte, um mal eben schnell direkt vor der Kiste darauf zuzugreifen.

Nachdem ich eure "diversen Ablageorte" gerade las vermisste ich diese Idee irgendwie.

Wenn ihr mir ein paar Brocken deutsch zuwerft, dann würde ich die ins Englische übersetzen übrigens.
Würde auch sehr gerne einen bescheidenen Beitrag leisten!

Gruß,
Marcus

@marcusfischer: Wenn Du etwas ins Englische übersetzen willst, was mich sehr freut, dann würde ich Dir diese Seite hier vorschlagen:
http://www.vdr-wiki.de/wiki/index.php/YaVDR/Templates
Angenommen, Du bist einverstanden, ist die Frage: Wohin mit dem Resultat? Mein Vorschlag: Ich kann das auf dieser Seite einfügen:
http://www.yavdr.org/developer…overview/about-templates/

Gruß
hepi

Zitat

Original von hepi
@marcusfischer: Wenn Du etwas ins Englische übersetzen willst, was mich sehr freut, dann würde ich Dir diese Seite hier vorschlagen:
http://www.vdr-wiki.de/wiki/index.php/YaVDR/Templates
Angenommen, Du bist einverstanden, ist die Frage: Wohin mit dem Resultat? Mein Vorschlag: Ich kann das auf dieser Seite einfügen:
http://www.yavdr.org/developer…overview/about-templates/

Gruß
hepi

Alles anzeigen

Fertig
Übersetzung...

Gruß
Spiff
PS: Ist garnicht mal so schlecht...

@ Hepi: Mach' ich.
Guter Vorschlag übrigens, evtl. lern' ich darüber ja dann auch endlich, wie das Templating-System funktioniert *hehe*

Gruß,
Marcus

Edit:
hmm, hat sich dann wohl erledigt, nicht ?

Zitat

Original von marcusfischer

Edit:
hmm, hat sich dann wohl erledigt, nicht ?

...ich hab mir nicht alles übersetzte durchgelesen!
Wollte einfach mal den Google-Übersetzungsdienst testen...

Spiff

Gut ist die Qualität imho nicht. Ich würde so etwas nicht nutzen wollen.

Andy

Überschätzt nicht automatische Übersetzungen, auch wenn Google da schon Beeindruckendes liefert! Auch wenn 80% gut sein sollte, muss man doch nachschauen, wo sich die 20% Fehler verstecken.

Ich werde alle englischen Doku-Texte, die durch Eure Hilfe entstehen sollten, zunächst auf unsere Website packen, wenn die Autoren einverstanden sind. Ich bin sonst überfordert, mit Wikis für verschiedene Sprachen gleichzeitig zu jonglieren. Ein Wiki habe ich mir zunächst nur eingerichtet, um die Semantik-Features zu testen, also als Spielwiese. Wicky tut da nun seine Doku-Konzepte für yaVDR rein (auf Deutsch), ich mache da meine Semantik-Experimente drin (auf Deutsch), und ich kann da jetzt nicht auch noch englischen Content reinpacken. Ich will aber nicht gleich noch ein zweites Wiki aufmachen, wo ich nicht weiß, was mit dem ersten werden soll.

Natürlich kann man im englischen VDR-Wiki die Sachen auch ablegen, aber unsere internationalen yaVDR-Fans sind momentan nicht daran gewöhnt, dorthin, zu gehen. Es müsste immer ein Direktlink von der yaVDR-Website auf die betreffende Seite im englischen Wiki geschaltet werden.

Gruß
hepi

Ich möchte mich noch bei marcuszurhorst (vormals in diesem Thread auch marcusfischer genannt) bedanken, weil er nettwerweise die Wiki-Page zu Custom-Templates ins Englische übersetzt hat - und darüber hinaus auch noch ungefragt ein sehr schickes Schaubild angefertigt hat, welches das Abmischen von Custom-Templates und Default-Templates sehr übersichtlich darstellt.

Die von Marcus übersetzte englische Version ist nun auf unserer Website zu finden unter:
http://www.yavdr.org/tutorials…s-to-configuration-files/

Die deutsche Version - auch mit dem Schaubild ausgestattet, ist im VDR-Wiki zu finden:
http://www.vdr-wiki.de/wiki/index.php/YaVDR-Templates

Wer Appetit bekommen hat, bei der Doku mitzuhelfen: Wir bräuchten noch

• Eine Übersicht aller wichtigen Verzeichnisse unter yaVDR (das könnte man, wenn es kurz ist, einfach in die yaVDR-FAQ reinpacken): Wo findet man was?
• Ein ausführliches Tutorial für Sound + ALSA, vor allem Details über den Kampf mit alsa-backport. Hier kann das englischsprachige yaVDR-Blog-Posting zu ALSA als Grundlage (für ein deutsches oder englisches Tutorial) dienen.
• Eine Ergänzung der yaVDR-FAQ, die beschreibt, wie man nach einem update+dist-upgrade nachschaut, welche Pakete gerade aktualisiert worden sind und wie diese Pakete genau heißen (/var/log/apt/history....)
• Eine Ergänzung der yaVDR-FAQ, die beschreibt, wie die apt-sources organisiert sind in yaVDR (/etc/apt/sources.list + /etc/apt/sources.list.d/yavdr ...): Wenn man ein neues Repo hinzufügen will (z. B. ubuntu partner wegen Skype oder ein weiteres PPA z. B. für eine aktuellere Performous-Version), wo macht man die Änderung am schlauesten?

Gruß
hepi

*Kopf aus der Deckung streck, und die Zunge leck*
Um meinen Wissenstand kurz zu dokumentieren: Ich bin newbee. Ich habe einen Rechner mit yaVDR 0.3 am Laufen. Ich finde es fazinierend mit kaum Linux Kenntnissen, dank Bernd7 und mit viel Windows Wissen ein so schönes System am Laufen zu haben.

Wenn ich den heppi's Doku Wünschen lese, bin ich ehrlich gesagt überfordert. Trotzdem habt Ihr mir Mut gemacht, daß auch ich mit meinem "begrenzten Horizont" Input geben kann und yaVDR zu verbessern.

Ich habe jetzt auf ein paar edits als JochenS im Wiki vorgenommen: http://www.vdr-wiki.de/wiki/index.php/YaVDR/Webfrontend auch die Partionierung und Konsolen Seite.

Hallo Jochen,

vielen Dank für Deine Beiträge im Wiki! Weiter so! Meine Doku-Wünsche sind Anregungen für erfahrenere yaVDR-User, die eine Schreibblockade vorschieben, um nichts im Wiki zu ändern. Ich freue mich, wenn auch newbees sich im Wiki beteiligen.

Gruß
hepi

Um diesen Thread nicht ganz in Vergessenheit geraten zu lassen:
Ich habe mir AsciiDoc mal näher angesehen. Aufgrund der einfachen Syntax glaube ich, dass man damit schneller zu einem brauchbaren Handbuch als mit dem relativ komplexen VDR-Wiki kommen kann, da die Einstiegshürden relativ gering sind. Außerdem ist der Export in andere Formate wie HTML, PDF (mit a2x), Docbook usw. relativ komfortabel.

Anbei mal das Ergebnis meiner ersten Versuche damit (der Inhalt ist mehr Füller als geordnete Themen, ich wollte einfach mal sehen wie gut es das ganze funktioniert (Tabellen, Notizen, Seitenumbrüche usw.)):
Quelltext: yaVDR_doc.txt
PDF-Export: yaVDR_doc.pdf
HTML (als Zip wegen dem Forum): yaVDR_doc.html.zip

Vielleicht hat ja noch jemand Zeit und Lust, die Wiki-Einträge für yaVDR durchzusehen, sprachlich etwas auszuarbeiten und das ganze in eine gut lesbare kompakte Form zu bringen.

Hi seahawk,

danke für den Hinweis auf AsciiDoc! Ich hab's mir mal angeschaut. Ich habe zwei Fragen:

1) Wie würdest Du gemeinschaftliches paralleles Arbeiten mehrerer Autoren an einem Text mit AsciiDoc ermöglichen?
2) Die Syntax scheint sich m. E. von Mediawiki Markup auf den ersten Blick kaum zu unterscheiden. Wo siehst Du die Vorteile gegenüber Mediawiki Markup?

Konvertieren von Wiki-Pages zu PDF solle auch möglich sein: http://www.mediawiki.org/wiki/Extension:PdfBook

Gruß
hepi