From Fedora Project Wiki

(another point)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Docs Project SOP]]
== Official Guides ==
* All guides must be written in DocBook XML and be built by Publican (current version is 1.x).  Source for these guides should be done using Fedora Hosted (git (preferred), svn, or cvs).


* Single page HTML for each language
* Build your guides in html, html-single, and PDF.  These files should be uploaded to the Fedora CVS to by synced to the http://docs.fedoraproject.org website.
* Downloadable tarballs of HTML
 
* Condensed version that is just what is different for the release
* Your guides should be submitted to the translators for translation.  When a guide reaches 100% it should be built in html, html-single, and PDF and uploaded to the CVS.
** Perhaps section at the end of each chapter?
 
** Avoid interweaving fixed content for new users and new content for old users
== Draft Documentation ==
* Update schedule for notes and guides
 
* Hold a 'lessons learned' meeting soon after the release
== Wiki Documentation ==
 
 
[[Category:Docs Project archives]]

Latest revision as of 01:12, 15 June 2010

Official Guides

  • All guides must be written in DocBook XML and be built by Publican (current version is 1.x). Source for these guides should be done using Fedora Hosted (git (preferred), svn, or cvs).
  • Build your guides in html, html-single, and PDF. These files should be uploaded to the Fedora CVS to by synced to the http://docs.fedoraproject.org website.
  • Your guides should be submitted to the translators for translation. When a guide reaches 100% it should be built in html, html-single, and PDF and uploaded to the CVS.

Draft Documentation

Wiki Documentation