Dokumentation ändern

[ath0]

Moin!

Ich habe gerade ein paar Fehler in einer FreeBSD Dokumentation gefunden. Ich komme aber mit den erklärungen, wie man dem Projekt was gutes tun kann nicht klaar. Wie kann ich die Docs bekommen um Änderungen sinnvoll zu machen?
Mir ist bewusst, dass es ein FTP server mit den Docs gibt, aber da ist alles von text bis html vertreten. Was nehme ich da jetzt?????....??? Läuft das bei den Jungs nicht wie bei den Source Codes?

Gruß
ath0

 

[SolarCatcher]

Schau mal auf die Seite vom FreeBSD Documentation Project. Da steht, wie es funktioniert, welche Tools man benötigt und wie man beitragen kann.

 

[ath0]

Danke für deine Antwort!
Auf der seite bin ich jetzt schon seit ca 2h auf der suche nach einer beschreibung wie das ganze läuft. Wie gesagt, ich komme damit nicht klaar.
Aber hier habe ich was gefunden was mein Gehirn evtl. parsen kann
Mal sehen wie weit ich komme.

 

[SolarCatcher]

Solange es kein Fehler der Deutsche Übersetzung ist, solltest Du aber vermutlich versuchen, das Englische Original zu ändern.

Hier auf dieser Seite erklären Sie, wie Du ein Diff übermittelst und dann ein Problem Report erstellst, damit das in den Issue-Tracker reinkomt.

Aber vielleicht habe ich auch Dein konkretes Problem nicht verstanden und Du suchst eigentlich eine ganz andere Lösung...

 

[oenone]

Fehler in der Dokumentation sind Bugs. Benutz den Bugtracker.

 

[Yamagi]

Eiegntlich ist es ganz einfach: FreeBSDs Doku ist in einem DocBook-Derivat geschrieben. Das ist eine SGML-basierte Auszeichnungssprache, die sozusagend den Quellcode der Doku darstellt. Dieser Quellcode wird in CVS-Repo verwaltet und kann mittels "make" in verschiedene Formate (HTML, PDF, TXT, LaTeX) übersetzt werden. Wenn du etwas verändert möchtest, musst du dir also den Quellcode besorgen und die Änderungen vornehmen. Anschließend generierst du einen Patch und schickst ihn über die Mailingliste oder den Bugtracker an das Projekt.

All das wird recht umfassend (aber auch für Einsteiger etwas wirr) im "FreeBSD Documentation Project Primer" beschrieben: http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/

 

[mousaka]

Was gibt es denn für empfehlenswerte DocBook-Editoren? Emacs sagt mir eher weniger zu. Durch eine kurze Suche habe ich den XML Copy Editor (editors/xmlcopyeditor) gefunden. Gibt es damit oder Alternativen (lieber gtk als QT)?

mousaka

 

[oenone]

(lieber gtk als QT)

Die Beiden heißen GTK+ und Qt.

 

[SolarCatcher]

Ich habe mich damit nie anfreunden können, aber Lyx wird immer wieder als ein guter Editor für DocBook "angepriesen". Ich konnte allerdings auf die Schnelle nicht ersehen, ob Lyx nur nach DocBook SGML / XML exportieren kann oder ob man auch existierende SGML-DocBook-Dateien öffnen/importieren kann.

[ERGÄNZUNG]Lyx ist aber QT- (oder für Oenone: Qt)-basiert[/ERGÄNZUNG]

 

[ath0]

Ich habe mich wieder mal in Rätzeln ausgedrückt. Entschuldigung!
Mein Problem ist/ war, dass ich einfach nichts gefunden habe, was mir gesagt hat woher ich die Quellen für die Dokumentationen bekomme. Ich habe ein FreeBSD Repo, und in dem war nicht das enthalten was ich suche.

Mitlerweile habe ich aber alles gefunden und hoffentlich komme ich erstmal klaar.
Danke an Euch alle!

Also habe ich nun die Deutschen Dokumentationen, aber kann mir jemand einen Server und den anonymen zugang für diesen nennen, damit ich mir die Englischen auch besorgen kann? Alle Server die ich bis jetzt probiert habe sind entweder off oder wollen ein password.

 

[Fusselbär]

Hallo ath0,

die aktuellen Sourcen der Dokumentation kommen beim csup mit, wenn im supfile drin steht:

doc-all tag=.

Mehr dazu steht im FreeBSD Handbuch:
http://www.freebsd.org/doc/de/books/handbook/cvsup.html
Wobei man heutzutage wohl eher csup verwenden will.
net/cvsup ist in den Ports, csup ist im FreeBSD Basissystem bereits enthalten.

 

[ath0]

Ganzschön gurkig die Dokumentations geschichten zu besorgen
Jetzt habe ich alles.
Danke nochmal an alle!

ath0