Category:Documentation

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Published Documentation: Added link to DocBook XML.)
(Working with Development Tools: Moved wiki v guides from Docs Project page.)
Line 23: Line 23:
  
  
 +
 +
== The difference between the "wiki" and "guides" ==
 +
 +
Documents typically begin life on the Fedora wiki.  This is to aid the development of the document until it can be finalized.  Unfinished documents are categorized as [[:Category:Draft_Documentation]].  Once the document is deemed complete, the Draft_Documentation category is replaced by the [[:Category:Documentation]] category.
 +
 +
If the documentation is deemed to be "official" and in need of a more permanent home, the wiki pages are translated into Docbook XML which can then be used to generate HTML and RPM files that are distributed to the public.  HTML files are published at http://docs.fedoraproject.org and RPM files are published in the Fedora repository.
 +
 +
More details are found on the [[Docs Project workflow]] page.
  
 
== Working with Development Tools ==
 
== Working with Development Tools ==

Revision as of 02:19, 12 June 2010

Cog.png
This page needs some love
This page should be revised or reconstructed to be more helpful. Problems may include being out of step with current team or project status or process.
DocsProject Header docTeam1.png


Here you will find the formal documentation for Fedora, as well as draft documents that aren't yet finished. Formal documentation is the responsibility of the DocsProject .

Contents

Published Documentation

Published full-length guides and tutorials

The Docs Project writes all its official guides in DocBook XML. These guides are provided to the public in HTML, HTML-Single, ePub, and PDF format and is available at http://docs.fedoraproject.org.

Draft Documents

Stop (medium size).png
Draft documents
Draft documents may be incomplete or contain errors. You can help and contribute by editing them properly.
  • Beats - These are the very latest Release Notes for Fedora, as they are developed
  • http://fedoraproject.org/wiki - The entire Wiki has many useful documents, which are not formal Fedora documents but may be what you need. Try the Wiki search to find your topic.



The difference between the "wiki" and "guides"

Documents typically begin life on the Fedora wiki. This is to aid the development of the document until it can be finalized. Unfinished documents are categorized as Category:Draft_Documentation. Once the document is deemed complete, the Draft_Documentation category is replaced by the Category:Documentation category.

If the documentation is deemed to be "official" and in need of a more permanent home, the wiki pages are translated into Docbook XML which can then be used to generate HTML and RPM files that are distributed to the public. HTML files are published at http://docs.fedoraproject.org and RPM files are published in the Fedora repository.

More details are found on the Docs Project workflow page.

Working with Development Tools

Drafts

Pages in category "Documentation"

The following 200 pages are in this category, out of 224 total.

(previous 200) (next 200)

A

B

C

D

E

F

F cont.

G

H

I

I cont.

J

K

L

M

N

O

P

R

S

T

U

(previous 200) (next 200)