Docs Project

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(What we are working on now.)
m (starting cleanup and refinement of the Documentation Project on the wiki)
Line 1: Line 1:
 
{{header|docs}}
 
{{header|docs}}
 
+
__NOTOC__
 
The [[DocsProject | Fedora Documentation Project ("Docs Project")]] provides 100% free/libre open content, services, and tools for documentation.
 
The [[DocsProject | Fedora Documentation Project ("Docs Project")]] provides 100% free/libre open content, services, and tools for documentation.
  
 
+
<!--
 
{| border="1"
 
{| border="1"
 
|-
 
|-
 
|style="background: white; font-weight: bold; font-size: 1.3em; color: white; width: 100%;" | '''[[Docs| Get Docs]]  . . . [[:Category:Draft documentation | Draft Docs]]  . . . [[Translating documentation| Translate Docs]]  . . . [[Joining the Docs Project| Join the Team]]  . . . [[Docs_Project_meetings| Meetings]]  '''
 
|style="background: white; font-weight: bold; font-size: 1.3em; color: white; width: 100%;" | '''[[Docs| Get Docs]]  . . . [[:Category:Draft documentation | Draft Docs]]  . . . [[Translating documentation| Translate Docs]]  . . . [[Joining the Docs Project| Join the Team]]  . . . [[Docs_Project_meetings| Meetings]]  '''
 
|}
 
|}
<!--  ||<tablestyle="width: 95%; cellspacing: 4em; text-align: center;" rowstyle="background: #3074c2; color: white;" style="border: 2px solid #080c30; font-weight: bold; font-size: 2em;"> Join the Docs Project! ||
+
  ||<tablestyle="width: 95%; cellspacing: 4em; text-align: center;" rowstyle="background: #3074c2; color: white;" style="border: 2px solid #080c30; font-weight: bold; font-size: 2em;"> Join the Docs Project! ||
-->
+
 
<!--  ||<tablestyle="border=0;" style="font-size: 1.3em; line-height: 1.2em; border=0;"> New reviewers, writers, and editors are '''very''' welcome. <BR> <BR> [[DocsProject/WhyJoin| Why join?]]  | [[DocsProject/NewWriters| Getting started]]  | [[DocsProject/Translation| Translating docs]]  ||
+
  ||<tablestyle="border=0;" style="font-size: 1.3em; line-height: 1.2em; border=0;"> New reviewers, writers, and editors are '''very''' welcome. <BR> <BR> [[DocsProject/WhyJoin| Why join?]]  | [[DocsProject/NewWriters| Getting started]]  | [[DocsProject/Translation| Translating docs]]  ||
-->
+
 
  
 
== Contributing roles in the Docs project ==
 
== Contributing roles in the Docs project ==
Line 31: Line 31:
 
[[Join#Web_Developer_or_Administrator|Web Developer or Administrator]]
 
[[Join#Web_Developer_or_Administrator|Web Developer or Administrator]]
 
|}
 
|}
 
+
-->
 
== What we do. ==
 
== What we do. ==
 
{{:Docs_Project_mission_statement}}
 
{{:Docs_Project_mission_statement}}

Revision as of 03:58, 12 October 2009

DocsProject Header docTeam1.png


The Fedora Documentation Project ("Docs Project") provides 100% free/libre open content, services, and tools for documentation.

What we do.

The mission of Fedora's Documentation Project is to improve the overall experience of Fedora users and contributors by providing documentation. We explain how to use certain software and systems, provide written accounts of special events (like releases), and recommend settings for software and systems (in terms of security, performance, and other concerns). In pursuing this work, the Docs Project creates and uses only free and open-source software, content, tools, and processes, so our documentation is reusable, modifiable, and rebuildable by anyone, for free, forever.


How we do it.

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 of which can then be used to generate HTML and RPM files that are used to disseminate to the public. HTML files are published at http://docs.fedoraproject.org and RPM files are published in the Fedora repository.

What we are working on now.

Published documentation can be found on http://docs.fedoraproject.org or on this wiki under Category:Documentation. Draft documentation can be found under Category:Draft_Documentation.

We are working on a number of guides that aid users in setting up and using Fedora:

  • Installation Guide
  • Release Notes
  • Security Guide
  • SELinux Guide
  • User Guide
  • Deployment Guide
  • RPM Guide
  • Amateur Radio Giude

Would you like to join us?

If you would like to join the Docs Project please go to Joining the Docs Project and start the process. Also check out the Joining the Docs Project checklist.

Project Administration


Documentation Licensing

All documentation produced by Fedora is released under the Open Publication License :

Legal/Licenses/OPL

Miscellanea

The following pages collect notes, hints, and other bric-a-brac that would otherwise be lost to the vagaries of the list archive's "search" function.

Check the FAQ on this wiki for general information on Fedora and links to other resources.

Stuff

The central project workflow page is DocsProject/WorkFlow .