From Fedora Project Wiki

Revision as of 15:23, 29 April 2009 by Sparks (talk | contribs) (→‎What we are working on now.: Added the list of guides.)

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


Get Docs . . . Draft Docs . . . Translate Docs . . . Join the Team . . . Meetings

Contributing roles in the Docs project

Contributing roles
This is only suggestions for contributing roles. Only your imagination sets the limts.


Content writer


OS Developer


Translator


Web Developer or Administrator

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.

Most of our documentation begins life on the Fedora wiki. These pages are categorized either as draft (Category:Draft_Documentation) or as final (Category:Documentation).

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

Release Notes "Beats"

The Beats are the living documents that become the release notes for Fedora releases. The process for creating the release notes is documented on the Release Notes process page. You can find writers of the Beats on the Beat Writers page.

You can help maintain the Beats on the wiki, but you should read the Beat Writing How-To first.

FAQ

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

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.

Stuff

The central project workflow page is DocsProject/WorkFlow .