diff options
Diffstat (limited to 'hu_HU.ISO8859-2/htdocs/docproj/submitting.xml')
| -rw-r--r-- | hu_HU.ISO8859-2/htdocs/docproj/submitting.xml | 215 |
1 files changed, 215 insertions, 0 deletions
diff --git a/hu_HU.ISO8859-2/htdocs/docproj/submitting.xml b/hu_HU.ISO8859-2/htdocs/docproj/submitting.xml new file mode 100644 index 0000000000..68fbe9f789 --- /dev/null +++ b/hu_HU.ISO8859-2/htdocs/docproj/submitting.xml @@ -0,0 +1,215 @@ +<?xml version="1.0" encoding="iso-8859-2"?> +<!DOCTYPE html PUBLIC "-//FreeBSD//DTD XHTML 1.0 Transitional-Based Extension//EN" +"http://www.FreeBSD.org/XML/doc/share/sgml/xhtml10-freebsd.dtd" [ +<!ENTITY url.articles "../../doc/en_US.ISO8859-1/articles"> +<!ENTITY title "A &os; Dokumentációs Projekt: + Dokumentáció beküldése"> +]> + +<!-- The FreeBSD Hungarian Documentation Project + Translated by: Peter Terbe <sncdev@gmail.com> + %SOURCE% en/docproj/submitting.xml + %SRCID% 1.18 +--> + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title>&title;</title> + + <cvs:keyword xmlns:cvs="http://www.FreeBSD.org/XML/CVS">$FreeBSD$</cvs:keyword> + </head> + + <body class="navinclude.docs"> + + <h2>Hogyan lehet beküldeni dokumentációt?</h2> + + <p>Először is szeretnénk megköszönni, + hogy erre fordítottuk az időnket!</p> + + <p>Az elkészített dokumentációt + valamilyen módon elérhetővé kell tenni. + Amennyiben lehetséges, helyezzünk el egy FTP oldalon + vagy webcímen.</p> + + <p>Ezt követően írjunk levelet a + <tt>freebsd-doc</tt> levelezési listára, amelyben + röviden ismertetjük a dokumentációt + és hivatkozunk a pontos helyére, majd várjunk + a visszajelzésre.</p> + + <p>Amennyiben valamilyen okból kifolyólag nem + áll módunkban elhelyezni a dokumentációt + FTP vagy webhelyen, közvetlenül is + elküldhetjük a <tt>freebsd-doc</tt> levelezési + lista címére is. Ebben az esetben viszont + lehetőleg csak egyszerű szöveges dokumentumokat + küldjünk.</p> + + <p>Előfordulhat, hogy más levelezési + listákon is megvitatnák a dokumentációt, + tehát érdemes azokra is elküldeni egy + másolatot belőle. Például egy olyan + cikk, amely arról szól, hogy a CVSup hogyan + tarthatjuk a forrásainkat frissen, további + érdeklődésre tarthat számot a + <tt>freebsd-current</tt> és a <tt>freebsd-stable</tt> + listákon is.</p> + + <p>Miután a dokumentációt + átnézték, tegyünk eleget a vele + kapcsolatban beérkezett javaslatoknak, és már + készen is áll a közzétételre.</p> + + <p>Ehhez nem kell mást tennünk, csak csomagoljuk be egy + tar állományba. Ha például + tehát a dokumentáció három + állományból áll, mint az + <tt>elso</tt>, <tt>masodik</tt>, illetve <tt>harmadik</tt>, + és ezekből szeretnénk egyetlen <tt>doc.tar</tt> + állományt készíteni, akkor adjuk ki az + ehhez szükséges parancsot:</p> + + <pre> + % <b>tar cf doc.tar elso masodik harmadik</b> + </pre> + + <p>Ezután tömörítsük az így + kapott tar állományt az alábbi paranccsal:</p> + + <pre> + % <b>gzip -9 doc.tar</b> + </pre> + + <p>Így előáll a <tt>doc.tar.gz</tt> + tömörített állomány.</p> + + <p>Végül pedig kódoljuk az + állományt, nehogy véletlenül egy + levelezőprogram szétcincálja.</p> + + <pre> + % <b>uuencode doc.tar.gz doc.tar.gz > doc.uue</b> + </pre> + + <p>Ezt követően tudatnunk kell a + Dokumentációs Projekttel az új + dokumentáció létezését. Ennek + megfelelő módja a <b>send-pr</b> parancs + használata, amely valószínűleg + már el is érhető a + számítógépünkön. Erre + viszont a <a href="&base;/send-pr.html">hibajelentő + űrlapot</a> is használhatjuk.</p> + + <p>Erre azért van szükség, hogy a munka + követhető legyen. Mikor jelentünk egy + problémát, az egy egyedi azonosítót + kap. Valamelyik committer ezt követően magához + rendeli a hibajelentést és a részletek + tisztázása érdekében felveszi + velünk a kapcsolatot. Erre vonatkozóan olvassuk el a + <a + href="&url.articles;/problem-reports/">&os; hibajelentések írása</a> + című cikket.</p> + + <p>A <b>send-pr</b> program meglehetősen egyszerű. + Feladata, hogy egy megfelelő formátumú e-mailt + küldjön a megfelelő címre. Mikor + elindítjuk a <b>send-pr</b> programot, az + alapértelmezett szövegszerkesztő (a <b>vi</b> + vagy az <b>emacs</b>) kerül betöltésre egy + kitöltendő formanyomtatvánnyal és a + kitöltést elősegítő kevés + leírással.</p> + + <p>Győződjünk meg róla, hogy a "Category" + mezőben a "docs", a "Class" mezőben pedig a + "change-request" szerepel, továbbá + szükséges, hogy az előzőleg + elkészített <tt>.uue</tt> állomány + tartalmát is beillesszünk a hibajelentésbe.</p> + + <p>A szövegszerkesztőből kilépve a + hibajelentést a program e-mailként elküldi a + megfelelő helyre. Rövid idővel ezután + értesítést fog kapni a hibajelentés + egyedi azonosítójáról, amivel nyomon + tudjuk követni a beküldés hibajelentés + állapotát.</p> + + <h2>Hova lehet küldeni a már létező + dokumentációkon végzett + módosításokat?</h2> + + <p>Először is ismét megköszönnénk, + hogy erre fordítottuk az időt.</p> + + <p>Ebben az esetben készíteni kell egy + speciális <i>diff</i> állományt, amely csak az + általunk javasolt változtatásokat + tartalmazza. Ez leegyszerűsíti a committer + dolgát, mivel így könnyebben + átlátja, hogy mit szeretnénk + változtatni, és nekünk sem kell hosszasan + magyaráznunk, hogy milyen részleteket írtunk + át (amellett természetesen, hogy megindokoljuk, + miért van szükség a javasolt + változtatások elvégzésére).</p> + + <p>A 'diff' állomány + készítéséhez a következőket + kell tennünk:</p> + + <ol> + <li> + <p>Készítsünk másolatot az eredeti + állományról. Mielőtt az + <tt>ize.xml</tt> állományt + módosítanánk, végezzük el a + következő műveletet:</p> + + <pre> + % <b>cp ize.xml ize.xml.eredeti</b> + </pre> + </li> + + <li> + <p>Ezt követően végezzük el a + kívánt módosításokat az + ize.xml állományon.</p> + + <pre> + % <b>vi foo.xml</b> + ... tap tap tap ... + ... teszteljük a módosításokat, nézzük át, nehogy + elírás maradjon benne stb. ... + </pre> + </li> + + <li> + <p>Készítsük el a diffet. Ehhez a + következő parancsot kell kiadnunk:</p> + + <pre> + % <b>diff -u ize.xml.eredeti ize.xml > ize.diff</b> + </pre> + + <p>A program megvizsgálja a két + állomány közti eltéréseket, + és az <tt>ize.diff</tt> állományba + írja azokat.</p> + </li> + </ol> + + <p>Ezután már küldhetjük is az + <tt>ize.diff</tt> állományt a projektnek. Az + előzőleg tárgyaltaknak megfelelően + írjunk egy hibajelentést, de a levél + törzsébe az <tt>ize.diff</tt> tartalmát + illesszük.</p> + + <a + href="docproj.html">A &os; Dokumentációs Projekt kezdőlap</a> + + </body> +</html> |