How to review documentation

From FedoraProject

(Redirected from DocsProject/HowToReview)
Jump to: navigation, search


Interested in reviewing a document in progress? Read this page to find out how you can help.

Contents

Reviewing a Wiki-based Document

  1. Draft documents are found in Category:Draft documentation.
  2. If you do not want to make a Wiki account, send your comments to the author(s), whose names are at the top of the draft document. Alternately, you can send your comments to fedora-docs-list .
  3. To make a Wiki account for editing, read WikiEditing .
  4. Make changes or add comment blocks directly in the Wiki pages, in small increments, so the page authors have a chance to review and comment on your changes.
  5. Optionally, copy the draft document or a specific page to your UserName namespace. For example, user FooBar copies Docs/Drafts/DesktopUserGuide/Introduction to FooBar/Drafts/DesktopUserGuide/Introduction. That page is used to demonstrate to the author(s) and fedora-docs-list.

Reviewing a Document in CVS

We're working on improving the methods here. Meanwhile, these are the ways to review a document in progress from CVS.

Using Yelp

  1. Use CVS to check out the document: 
    export CVSROOT=:pserver:anonymous@cvs.fedoraproject.org:/cvs/docs
cvs -z3 login
cvs -z3 co foo-guide-devel
  2. Generate a few needed files: 
    cd foo-guide-devel/foo-guide
make validate-xml-en_US
  3. Use Yelp, the GNOME help browser, to view the parent XML file: 
    yelp en_US/foo-guide.xml &

For example, when reviewing the 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 &

Building to HTML or Text

  1. Use CVS to check out the document: 
    export CVSROOT=:pserver:anonymous@cvs.fedoraproject.org:/cvs/docs
cvs -z3 login
cvs -z3 co foo-guide-devel
  2. Build a specific language version: 
    cd foo-guide-devel/foo-guide/
make html-en_US
  3. View in a browser: 
    firefox foo-guide-en_US/index.html &
  4. Alternately, build to text and view in a text editor: 
    cd foo-guide-devel/foo-guide/
make text-en_US
emacs foo-guide-en_US.txt &
Retrieved from "https://fedoraproject.org/wiki/How_to_review_documentation"