It IT/How to review documentation

Obsoleta
Il processo quì delineato è stato modificato; per i nuovi sviluppi fare riferimento a DocsProject

Sei interessato a revisionare un documento in fase di lavorazione? Leggi questa pagina per sapere come aiutare.

Revisionare un documento basato sulla wiki

1. I documenti in Bozza si trovano sotto il Category:Draft documentation.
2. Se non si vuole creare un account Wiki, spedisci i tuoi commenti all'autore(i), i cui nomi appaiono in cima al documento in bozza. In alternativa, puoi spedire i commenti alla fedora-docs-list .
3. Per creare un account Wiki per editare, leggi WikiEditing .
4. Fa i cambiamenti o aggiungi blocchi di commento direttamente nelle pagine Wiki, in piccoli incrementi, affinchè l'autore della pagina possa avere la possibilità di revisionare e commentare i tuoi cambiamenti.
5. Opzionalmente, copiate il documento in bozza o una pagina specifica sotto il namespace del vostro UserName. Ad esempio, utente FooBar copia Docs/Drafts/DesktopUserGuide/Introduction in FooBar/Drafts/DesktopUserGuide/Introduction. Questa pagina sarà usata per la dimostrazione all'autore ed alla fedora-docs-list.

Revisionare un documento in CVS

Stiamo lavorando per migliorare i metodi. Nel frattempo, questi sono i modi per revisionare un documento in fase di traduzione dal CVS.

Uso di Yelp

1. Usare CVS per eseguire il check out del documento:

   export CVSROOT=:pserver:anonymous@cvs.fedoraproject.org:/cvs/docs
   cvs -z3 login
   cvs -z3 co foo-guide-devel
   

2. Generare un po di files necessari:

   cd foo-guide-devel/foo-guide
   make validate-xml-en_US
   

3. Usare Yelp, il navigatore di aiuto di GNOME, per visionare il file XML:

   yelp en_US/foo-guide.xml &
   

Ad esempio, quando si revisiona la Fedora Installation Guide:

export CVSROOT=:pserver:anonymous@cvs.fedoraproject.org:/cvs/docs
cvs -z3 login
cvs -z3 co install-guide-devel
make validate-xml-en_US
yelp en_US/install-guide.xml &

Compilare in HTML o Testo

1. Usare CVS per eseguire il check out del documento:

   export CVSROOT=:pserver:anonymous@cvs.fedoraproject.org:/cvs/docs
   cvs -z3 login
   cvs -z3 co foo-guide-devel

2. Compilare la versione per uno specifico linguaggio:

   cd foo-guide-devel/foo-guide/
   make html-en_US
   

3. Visualizzare in un navigatore:

   firefox foo-guide-en_US/index.html &
   

4. In alternativa, compilare in formato testo e visualizzare in un editor di testo:

   cd foo-guide-devel/foo-guide/
   make text-en_US
   emacs foo-guide-en_US.txt &