Docs Project

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(added the comminication channels section.)
m (added a tip on how to join the docs project.)
Line 34: Line 34:
 
== Mission Statement ==
 
== Mission Statement ==
 
{{:Docs_Project_mission_statement}}
 
{{:Docs_Project_mission_statement}}
 +
 +
 +
 +
{{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.}}
 +
  
 
== Communication Channels ==
 
== Communication Channels ==
Line 57: Line 62:
 
* RPM Guide
 
* RPM Guide
 
* Amateur Radio Giude
 
* Amateur Radio Giude
 
+
<!--
 
== Would you like to join us? ==
 
== Would you like to join us? ==
 
If you would like to join the Docs Project please go to [[Joining_the_Docs_Project| Joining the Docs Project]] and start the process.  Also check out the [[Joining_the_Docs_Project_checklist| Joining the Docs Project checklist]].
 
If you would like to join the Docs Project please go to [[Joining_the_Docs_Project| Joining the Docs Project]] and start the process.  Also check out the [[Joining_the_Docs_Project_checklist| Joining the Docs Project checklist]].
 
+
-->
 
== Project Administration ==
 
== Project Administration ==
 
* [[Docs Project tasks| Schedule of tasks]]  to implement the goals
 
* [[Docs Project tasks| Schedule of tasks]]  to implement the goals

Revision as of 07:14, 12 October 2009

DocsProject Header docTeam1.png


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

Mission Statement

The mission of Fedora's Documentation Project is to provide documentation to users and developers to improve the overall usage of Fedora. We explain the use of certain pieces of software and systems, provide written accounts of special events (like releases), and provide recommendations on settings for software and systems (in terms of security, performance, etc.).



Idea.png
Joining the Documentation Project
To join the Fedora Documentation Project, jump to Joining the Docs Project for details on how to sign up. If you are interested in translating Fedora documentation, jump over to the L10n (localization) Project's wiki pages.


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.

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

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 .