From Fedora Project Wiki

(Moved paragraph up.)
m (rephrase category description)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{needs love}}
{{autolang|base=yes}}
{{header|docs}}
{{header|docs}}
This category includes both formal and informal documentation for Fedora.


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.
Formal documentation is primarily hosted on the [https://docs.fedoraproject.org/ Docs website], but this category includes unfinished [[:Category:Draft documentation|draft documents]]. The [[Docs Project]] is responsible for formal documentation.


If the documentation is deemed to be "official" and in need of a more permanent home, the wiki pages are translated into [http://www.docbook.org 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.
== Published Documentation ==


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]] .
Wiki based documentation in the topical categories below.


== Published Documentation ==
=== Published full-length guides and tutorials ===
{{Anchor|Published}}


'''Published full-length guides and tutorials'''
http://docs.fedoraproject.org


The [[Docs Project]] writes all its official guides in [http://www.docbook.org/ 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 ===
 
== Draft Documents ==
{{admon/caution|Draft documents|Draft documents may be incomplete or contain errors.  You can help and contribute by editing them properly.}}
{{admon/caution|Draft documents|Draft documents may be incomplete or contain errors.  You can help and contribute by editing them properly.}}


* [[Docs/Beats| Beats]]  - These are the very latest Release Notes for Fedora, as they are developed
* [[:Category:Documentation beats|Release notes draft work]]  - These are the very latest Release Notes for Fedora, as they are developed


* [[:Category:Draft_documentation | Draft Documentation]] - Guides and tutorials that are being developed on this Wiki
* [[:Category:Draft documentation | Draft documentation]] - Guides and tutorials that are being developed on this Wiki


* 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.
* 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.


More details are found on the [[Docs Project workflow]] page.
=== Working with Development Tools ===
 
== Working with Development Tools ==
 
'''Drafts'''


* [[Docs/Drafts/BuildingPackagesGuide|  Building Packages Guide]]
[[Docs/Drafts/BuildingPackagesGuide|  Building Packages Guide]]


[[Category:Docs Project]]
[[Category:Docs Project]]

Latest revision as of 02:48, 28 April 2014

DocsProject Header docTeam1.png

This category includes both formal and informal documentation for Fedora.

Formal documentation is primarily hosted on the Docs website, but this category includes unfinished draft documents. The Docs Project is responsible for formal documentation.

Published Documentation

Wiki based documentation in the topical categories below.

Published full-length guides and tutorials

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.
  • 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.

Working with Development Tools

  Building Packages Guide