39e02e7bc6
www/de/docproj/submitting.sgml fixes only www/de/news/Makefile 1.50 -> 1.51 www/de/news/news.sgml 1.50 -> 1.51 www/de/news/2007/Makefile new file www/de/news/2007/news.xml new file www/de/news/2007/press.xml new file www/de/share/sgml/libcommon.xsl fixes only www/de/share/sgml/news.xml 1.212 -> 1.213 www/de/share/sgml/press.xml 1.70 -> 1.71 Obtained from: The FreeBSD German Documentation Project
167 lines
6.7 KiB
Text
167 lines
6.7 KiB
Text
<!DOCTYPE HTML PUBLIC "-//FreeBSD//DTD HTML 4.01 Transitional-Based Extension//EN" [
|
|
<!ENTITY base CDATA "..">
|
|
<!ENTITY url.articles "&enbase;/doc/en_US.ISO8859-1/articles">
|
|
<!ENTITY date "$FreeBSD$">
|
|
<!ENTITY dedate "$FreeBSDde: de-www/docproj/submitting.sgml,v 1.2 2008/12/09 09:50:54 jkois Exp $">
|
|
<!ENTITY reference "basiert auf: 1.18">
|
|
<!ENTITY title "FreeBSD Documentation Project: Beiträge einreichen">
|
|
<!ENTITY % navinclude.docs "INCLUDE">
|
|
]>
|
|
|
|
<html>
|
|
&header;
|
|
|
|
<h2>Ich habe eine neue Anleitung geschrieben. Wie kann ich diese
|
|
einreichen?</h2>
|
|
|
|
<p>Danke, dass Sie unsere Dokumentation erweitern wollen.</p>
|
|
|
|
<p>Sie müssen Ihre Dokumentation dem Documentation Project zur
|
|
Verfügung stellen, damit Ihr Beitrag geprüft werden kann.
|
|
Dazu hinterlegen Sie das Dokument beispielsweise auf einem FTP-
|
|
oder Webserver.</p>
|
|
|
|
<p>Danach schicken Sie eine E-Mail an die Mailingliste
|
|
<tt>FreeBSD-doc</tt>, in der Sie Ihren Beitrag kurz beschreiben
|
|
und vor allem mitteilen, wo Sie ihn hinterlegt habt.
|
|
Außerdem sollten Sie die Mitglieder des FreeBSD Documentation
|
|
Projects um die Prüfung Ihres Beitrags bitten.</p>
|
|
|
|
<p>Ist es Ihnen nicht möglich, Ihren Beitrag auf einem Server
|
|
zu hinterlegen, können Sie ihn auch direkt an die
|
|
Mailingliste <tt>FreeBSD-doc</tt> schicken. Denken Sie aber daran,
|
|
dass Ihre E-Mail in diesem Fall nur "normalen" Text enthalten
|
|
darf.</p>
|
|
|
|
<p>Falls Ihr Beitrag auch für andere Mailinglisten interessant
|
|
ist, sollte Sie Ihre E-Mail als Kopie auch an andere Mailinglisten
|
|
schicken und um Kommentare bitten. Handelt es sich bei Ihrem
|
|
Beitrag etwa um eine Anleitung zur Aktualisierung des Quellcodes
|
|
mit CVSup, so ist dies auch für die Leser der Mailinglisten
|
|
<tt>FreeBSD-current</tt> und <tt>FreeBSD-stable</tt>
|
|
interessant.</p>
|
|
|
|
<p>Nachdem Ihr Beitrag geprüft wurde und Sie eventuelle
|
|
Verbesserungsvorschläge in Ihr Dokument aufgenommen haben,
|
|
können Sie Ihren Beitrag einreichen.</p>
|
|
|
|
<p>Dazu verpacken Sie Ihr Dokument in ein tar-Archiv. Besteht Ihr
|
|
Dokument beispielsweise aus den drei Dateien <tt>eins</tt>,
|
|
<tt>zwei</tt>, und <tt>drei</tt>, die alle in das gemeinsame
|
|
tar-Archiv <tt>doc.tar</tt> aufgenommen werden sollen, verwenden
|
|
Sie folgenden Befehl:</p>
|
|
|
|
<pre>
|
|
% <b>tar cf doc.tar eins zwei drei</b>
|
|
</pre>
|
|
|
|
<p>Danach komprimieren Sie das tar-Archiv:</p>
|
|
|
|
<pre>
|
|
% <b>gzip -9 doc.tar</b>
|
|
</pre>
|
|
|
|
<p>Als Ergebnis erhalten Sie die komprimierte Datei
|
|
<tt>doc.tar.gz</tt>.</p>
|
|
|
|
<p>Als letzten Schritt der Vorbereitung kodieren Sie diese Datei
|
|
noch, damit sie von allen E-Mail-Programmen korrekt erkannt und
|
|
verarbeitet wird:</p>
|
|
|
|
<pre>
|
|
% <b>uuencode doc.tar.gz doc.tar.gz > doc.uue</b>
|
|
</pre>
|
|
|
|
<p>Nun können Sie das FreeBSD Documentation Project über
|
|
Ihren Beitrag informieren. Der korrekte Weg dafür ist der
|
|
Einsatz von <b>send-pr</b>, das auf Ihrem System bereits
|
|
installiert sein sollte. Alternativ können Sie auch das <a
|
|
href="&base;/send-pr.html">Internetformular zum Einreichen von
|
|
Problemberichten</a> verwenden.</p>
|
|
|
|
<p>Nur so kann sichergestellt werden, dass Ihr Beitrag auch korrekt
|
|
erfasst wird. Wenn Sie einen Problembericht (PR) einreichen,
|
|
erhält dieser eine eindeutige Nummer. Ein Committer wird
|
|
diesen PR übernehmen und Ihrem Beitrag
|
|
weiterbearbeiten. Weitere Informationen zu diesem Thema finden
|
|
Sie im Artikel <a
|
|
href="&url.articles;/problem-reports/">Writing FreeBSD Problem
|
|
Reports</a>.</p>
|
|
|
|
<p>Die Bedienung von <b>send-pr</b> ist relativ einfach. Die
|
|
Aufgabe des Programms ist es, eine speziell formatierte E-Mail
|
|
an eine bestimmte E-Mail-Adresse zu schicken. Wenn Sie
|
|
<b>send-pr</b> aufrufen, wird automatisch Ihr Standardeditor
|
|
(beispielsweise <b>vi</b> oder <b>emacs</b>) mit einer
|
|
von Ihnen auszufüllenden Vorlage geladen, die auch einige
|
|
zusätzliche Anweisungen enthält.</p>
|
|
|
|
<p>Achten Sie beim Ausfüllen des Formulars darauf, dass Sie
|
|
im Feld "Category" den Wert "docs" eintragen und dass im Feld
|
|
Class" der Eintrag "change-request" steht. Im "Body"-Bereich
|
|
fügen Sie die vorhin erstellte <tt>.uue</tt>-Datei ein.</p>
|
|
|
|
<p>Wenn Sie den Editor beenden, wird der PR als E-Mail an die
|
|
korrekte Adresse geschickt. Kurz darauf erhalten Sie (wiederum
|
|
als E-Mail) eine Bestätigung, die insbesondere die Ihrem
|
|
PR zugewiesene eindeutige Nummer enthält. Diese PR-Nummer
|
|
können Sie dazu verwenden, den aktuellen Status Ihres
|
|
Beitrags zu prüfen.</p>
|
|
|
|
<h2>Ich habe ein bereits vorhandenes Dokument verbessert. Wie
|
|
kann ich meine Korrekturen einreichen?</h2>
|
|
|
|
<p>Danke, dass Sie unsere Dokumentation verbessern wollen.</p>
|
|
|
|
<p>In diesem Fall müssen Sie eine spezielle Datei, eine
|
|
sogenannte Differenz (<i>diff</i>) erstellen. Diese Differenz
|
|
enthält alle von Ihnen durchgeführten Änderungen.
|
|
Dadurch wird es den Committern erleichtert, Ihre Änderungen
|
|
zu finden und zu prüfen. Sie haben den Vorteil,
|
|
dass Sie nicht umständlich erklären müssen, was
|
|
Sie geändert haben. Nichtsdestotrotz sollten Sie
|
|
natürlich begründen können, warum Sie diese
|
|
Änderung für nötig halten.</p>
|
|
|
|
<p>Um eine Differenz (einen "Diff") zu erstellen, gehen Sie wie
|
|
folgt vor:</p>
|
|
|
|
<ol>
|
|
<li><p>Erstellen Sie eine Kopie der zu ändernden Datei
|
|
(in diesem Fall <tt>foo.sgml</tt>): do</p>
|
|
|
|
<pre>
|
|
% <b>cp foo.sgml foo.sgml.old</b>
|
|
</pre></li>
|
|
|
|
<li><p>Nun führen Sie Ihre Änderungen in
|
|
foo.sgml durch.</p>
|
|
|
|
<pre>
|
|
% <b>vi foo.sgml</b>
|
|
... tipp tipp tipp ...
|
|
|
|
... Änderungen testen, Tippfehler suchen und korrigieren ...
|
|
</pre></li>
|
|
|
|
<li><p>Danach erzeugen Sie die Differenz:</p>
|
|
|
|
<pre>
|
|
% <b>diff -u foo.sgml.old foo.sgml > foo.diff</b>
|
|
</pre>
|
|
|
|
<p>Mit diesem Befehl werden die beiden Dateien verglichen und
|
|
die Unterschiede in die Datei <tt>foo.diff</tt>
|
|
geschrieben.</p></li>
|
|
</ol>
|
|
|
|
<p>Als letzten Schritt senden Sie die erstellte Differenz
|
|
<tt>foo.diff</tt> an das Documentation Project. Dazu erstellen
|
|
Sie wiederum einen PR. Im Unterschied zur Erstellung einer
|
|
neuen Anleitung, enthält der "Body"-Bereich nun aber die
|
|
von Ihnen erstellte Differenz <tt>foo.diff</tt>.</p>
|
|
|
|
<p></p><a href="docproj.html">Startseite des FreeBSD Documentation Projects</a>
|
|
&footer;
|
|
</body>
|
|
</html>
|