Oldal navigáció átlépése (1) Fejezet navigáció átlépése (2)

Oldal Navigáció

FreeBSD Dokumentációs Projekt: Dokumentáció beküldése

Írtam néhány dokumentációt. Hogyan nyújthatom be közlésre?

Először is, köszönjük hogy erre fordította idejét!

A dokumentációt elérhetővé kell tennie. Amennyiben lehetősége van rá, kérjük helyezze el egy FTP vagy webcímen.

Ezt követően írjon levelet a FreeBSD-doc levelezőlistára, a dokumentáció rövid ismertetőjével és pontos helyére való hivatkozással, majd várjon a visszajelzésre.

Amennyiben valamilyen okból kifolyólag nem áll módjában elhelyezni a dokumentációt FTP vagy webhelyen, elküldheti közvetlenül a FreeBSD-doc levelezőlistára. Ebben az esetben kérjük csak egyszerű szöveges dokumentumokat küldjön.

Előfordulhat, hogy más levelező listákon is megvitatnák a dokumentációt, tehát kérjük továbbítsa azt azokra is. Például egy cikk a CVSup használatáról, arról, hogyan tarthatjuk a forrásainkat frissen, további érdeklődésre tarthat számot a FreeBSD-current és a FreeBSD-stable listákon is.

Miután a dokumentációját átnézték és lehetőséget kapott, hogy megvitassák, készen áll a közzétételre.

Ehhez nem kell mást tennie, csak csomagolja egy tar fájlba! Amennyiben tehát a dokumentáció három fájlból áll, elso, masodik illetve harmadik, és szeretne egyetlen doc.tar állományt készíteni belőlük, adja ki a következő parancsot:

      % tar cf doc.tar elso masodik harmadik

ami éppen erre való. Ezután tömörítse a tar fájlt az alábbi paranccsal:

      % gzip -9 doc.tar

ami előállítja a doc.tar.gz tömörített állományt.

Végül pedig kódolja az állományt, nehogy egy levelezőprogram jóvoltából darabokra essen.

      % uuencode doc.tar.gz doc.tar.gz > doc.uue

Ezt követően tudatnia kell a Dokumentációs Projekttel az új dokumentáció létezését. Ennek megfelelő módja a send-pr parancs használata, ami valószínűleg telepítve van a számítógépére. A WWW hibabejelentő űrlap is hasznos lehet.

Erre azért van szükség, hogy a felvetés követhető legyen. Mikor Ön jelent egy problémát, az egy egyedi azonosítót kap. A bizottság egy tagja ezt követően magához rendelheti a probléma-jelentést és kapcsolatba léphet Önnel további tárgyalások érdekében. További információkért olvassa el a FreeBSD Probléma-jelentések írása cikket.

A send-pr program meglehetősen egyszerű. Feladata, hogy megfelelő formátumú e-mailt küldjön a megfelelő címre. Mikor elindítja a send-pr programot, az alapértelmezett szövegszerkesztő (talán a vi vagy az emacs) kerül betöltésre egy kitöltendő formanyomtatvánnyal és némi segítséggel a kitöltéssel kapcsolatban.

Győződjön 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 .uue állomány tartalmát is beillessze a hibajelentésbe.

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 követheti a probléma-jelenté állapotát.

Néhány már létező dokumentáción végeztem változtatásokat, ezeket hova küldhetem?

Először is, újra megköszönnénk, hogy erre fordította idejét.

Ebben az esetben készíteni kell egy speciális diff állományt, mely csak az Ön által javasolt változtatásokat tartalmazza. Ez leegyszerűsíti a committer dolgát, hogy átlássa, mit változtatott, és Önnek sem kell hosszan magyaráznia, hogy milyen részleteket változtatott meg (amellett természetesen, hogy megmagyarázza, miért van szükség a javasolt változtatások elvégzésére).

'Diff' állomány készítéséhez a következőket kell tennie:

  1. Készítsen másolatot az eredeti állományról! Mielő a foo.sgml fájlt módosítja, így készíthet másolatot:

         % cp foo.sgml foo.sgml.old

  2. Ezt követően elvégezheti módosításait a foo.sgml állományon.

         % vi foo.sgml
      ... tap tap tap ...
      ... tesztelje a módosításokat, olvassa át
      elírások után kutatva, stb. ...

  3. Készítse el a 'diff'-et! Ehhez adja ki a következő parancsot:

         % diff -u foo.sgml.old foo.sgml > foo.diff

    Ez a parancs megvizsgálja a két állomány közötti különbséget, és a foo.diff fájlba írja azokat.

Ezt követően elküldheti a foo.diff állományt a projekthez. Küldjön probléma-jelentést, ahogy azt előzőleg már tárgyaltuk, de illessze a foo.diff tartalmát a levél törzsébe!

FreeBSD Dokumentációs Projekt kezdőlap