From Fedora Project Wiki

(→‎How we do it.: Updated the language.)
m (fixed typo limts -> limits)
Line 14: Line 14:


== 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 limts. }}
{{admon/tip|Contributing roles|This is only suggestions for contributing roles. Only your imagination sets the limits. }}


{|class="nobordersplz"
{|class="nobordersplz"
Line 36: Line 36:


== How we do it. ==
== 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.
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.
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.

Revision as of 16:59, 18 June 2009

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


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.

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

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 .