Fedora Docs FAQ - update 26 Nov 2003

[Karsten Wade]

Please accept this humble FAQ.  Please direct comments to the list,
harsh criticism to me where I shall file it in its proper location.  If
we like this (which means no one says they don't like it?), then I'll
propose either XML inclusion in the Doc Guide, or posting on the
http://fedora.redhat.com/projects/docs/ page.

FAQ originally proposed in
http://www.redhat.com/archives/fedora-docs-list/2003-November/msg00029.html, now brought to you in living email color:

## begin FAQ

Does Fedora Project need writers/editors?

  Yes!  Writers are needed right now more then editors, until we have
  something to edit.


What documents does FP need?

  FP documents are going to be of the tutorial/HOWTO variety.  This is
  the most useful information we can gather at this time, and it works
  well with the distributed project.  Currently, the only full-length
  guide is the Installation Guide.

How is the docs project organized?

  Rather loosely right now.  Tammy Fox (tfox at redhat.com) is the
  project leader.  It has been proposed that translators can work in
  teams by languages.

  We may want to organize so that every writer has two-editors, and
  contributors can work in either or both roles.  This makes for a
  more cumbersome process, but the quality control is higher.


What is the process/procedure for translating documents?

  Details are currently outlined in this email:

 
http://www.redhat.com/archives/fedora-docs-list/2003-November/msg00040.html


What are PO files?

  PO files are textual, editable files used in translation.
  http://www.gnu.org/software/gettext/manual/html_mono/gettext.html#SEC7


What are some of the tutorial/HOWTOs currently proposed?

  From the mailing list:

  * Installing an SSH server with public/private key authentication
  * Configuring and using digital cameras
  * Anaconda documentation (in process)
  * Security considerings in installation
  * Security other (by topic, i.e. filesystems, host, etc.)
  * Configuring PDA

Can I translate the legal notice?

  The legal notice page can be translated, but a statement that the
  translation is provided for convenience only and that the English
  language version takes precedence must be on the top of the page.
  

What are the tools for writing documents?

  http://fedora.redhat.com/projects/docs details how to get the
  Documentation Guide source and tools.  The toolchain is explained on
  that page, with the exception of PO files (see What are PO files?).

  Currently, there is a problem with PDF production (refer to
  https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=104983).  If
  you have TeX experience and can help us resolve that one, please
  dive in!


I have a tutorial in HTML, how do I convert it to DocBook?

  Grab html2db from http://www.cise.ufl.edu/~ppadala/tidy/ .


What are some resources for learning DocBook?

  The definitive DocBook reference written and maintained by Norm
  Walsh is available at http://docbook.org/tdg/en/html/docbook.html .

  A combination tutorial and reference book is available at
  http://www.sagehill.net/docbookxsl/index.html .

  Dave Pawson maintains a DocBook FAQ at
  http://www.dpawson.co.uk/docbook/ .


Can I have CVS write access?

  Eventually, we intend for full contributors to have write access to
  CVS, as well as access to other build environments.  This is being
  worked out across the entire Fedora Project, and is due to be
  completed by the end of calendar year 2003.  In the meantime, you
  can contact the docs project leader Tammy Fox (tfox at redhat.com) with
  your changes.

  If you wish to setup your own CVS repository, or join one that
  others are using while waiting for the main Fedora Project CVS to be
  set up, please see the mail thread starting at:

 
http://www.redhat.com/archives/fedora-docs-list/2003-November/msg00140.html


What else is can I do to help?

  Have ideas for admonition graphics?

## 30 ##

-- 
Karsten Wade   :      Tech Writer, RHCE     :  o: +1.831.466.9664
kwade at redhat.com : http://rhea.redhat.com/ :   c: +1.831.818.9995
         Red Hat Applications : WAF, CMS, Portal Server         
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --