Category:Docs Project

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(What we are working on now.: Updating this section to include more links and BZ links.)
(Commenting out the contributing roles and removing the __NOTOC__)
Line 1: Line 1:
 
{{header|docs}}
 
{{header|docs}}
__NOTOC__
 
 
The Fedora Documentation Project creates, publishes, and maintains the software documentation for the Fedora operating system.  
 
The Fedora Documentation Project creates, publishes, and maintains the software documentation for the Fedora operating system.  
 
<!--
 
<!--
Line 12: Line 11:
 
-->
 
-->
  
 +
<!--
 
== Contributing roles in the Docs project ==
 
== Contributing roles in the Docs project ==
 
{{admon/tip|Contributing roles|This is only suggestions for contributing roles. Only your imagination sets the limits. }}
 
{{admon/tip|Contributing roles|This is only suggestions for contributing roles. Only your imagination sets the limits. }}
Line 23: Line 23:
  
 
{{admon/tip|Joining the Documentation Project| To join the Fedora Documentation Project, jump to [[Joining_the_Docs_Project| Joining the Docs Project]] for details on how to sign up. If you are interested in ''translating'' Fedora documentation, jump over to the [[L10N|L10n (localization) Project's]] wiki pages.}}
 
{{admon/tip|Joining the Documentation Project| To join the Fedora Documentation Project, jump to [[Joining_the_Docs_Project| Joining the Docs Project]] for details on how to sign up. If you are interested in ''translating'' Fedora documentation, jump over to the [[L10N|L10n (localization) Project's]] wiki pages.}}
 
+
-->
 
== Mission Statement ==
 
== Mission Statement ==
 
{{:Docs_Project_mission_statement}}
 
{{:Docs_Project_mission_statement}}

Revision as of 18:59, 17 December 2009

DocsProject Header docTeam1.png

The Fedora Documentation Project creates, publishes, and maintains the software documentation for the Fedora operating system.

Contents

Mission Statement

The mission of the Fedora Documentation Project is to provide documentation to users and developers to improve the overall usage of Fedora. We do that by explaining the usage of certain pieces of software or systems, provide written accounts of special events (releases, etc), and provide recommendations on setting of software or systems (security, performance, etc).


Communication Channels

  • Mailing List: For formal discussions, the Fedora Documentation Project uses the fedora-docs mailing list.
  • IRC: For informal discussions about Fedora Documentation, many members of the project frequent the #fedora-docs channel on irc.freenode.net.
  • Meetings: Weekly Fedora Documentation Project meetings are held on Thursdays at 0001 UTC, in the #fedora-meeting channel on irc.freenode.net. Check out the Meetings wiki page for past meetings minutes, and the agenda for the upcoming meeting.

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.

Draft and Informal Documentation

The Fedora Wiki is used to create draft versions of documentation and also provides a place for non-formal documentation.

Formal Documentation

All formal documentation is located at http://docs.fedoraproject.org. These guides are written in DocBook XML and compiled using Publican.

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 Guide

Bug Tickets

We use Red Hat's Bugzilla instance for tracking issues and tasks within the Docs Project. It is always helpful to provide input and patches to bugs.

You can query Bugzilla or use one of the following links to find tickets that are open:

Documentation Licensing

All documentation produced by Fedora is released under the Creative Commons Attribution-Share Alike License 3.0 Unported License :

Legal/Licenses#Documentation

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 .

Pages in category "Docs Project"

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

*

A

C

D

D cont.

D cont.

E

F

H

I

J

M

P

R

S

U

W