From Fedora Project Wiki

(Changed Meetings in the header)
(Changed the headings and am reworking the text.)
Line 32: Line 32:
|}
|}


== Project Workflow ==
== What we do. ==
{{:Docs_Project_mission_statement}}


The central project workflow page is [[DocsProject/WorkFlow| DocsProject/WorkFlow]] .
== 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]]).


== The Documents ==
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]].
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]].


If you want to use DocBook XML for Fedora-based documentation, you can learn how using the [http://docs.fedoraproject.org/documentation-guide/ Documentation Guide] and a [http://cvs.fedoraproject.org/viewcvs/example-tutorial/en_US/example-tutorial2.xml?root=docs self-referential example tutorial] which is actually written in DocBook XML itself. If you want to collaborate with other experienced writers working on official documentation using DocBook XML, you can find the latest in our [http://git.fedorahosted.org/git/docs/ git repositories on Fedora Hosted], or you might choose to resurrect an older document from [[DocsProject/CvsUsage | the Docs Project's CVS repository]].
Check the [[FAQ]]  on this wiki for general information on Fedora and links to other resources.
 
If you prefer to write on the wiki, read the [[DocsProject/Writing_Using_The_Wiki | wiki guide]] that we've prepared.  It shows how to mark up text, where to store pages, and so forth.


=== Release Notes "Beats" ===
=== Release Notes "Beats" ===
Line 50: Line 51:
You can help maintain [[Docs/Beats | the Beats]] on the wiki, but you should read the [[Docs/Beats/HowTo| Beat Writing How-To]] first.
You can help maintain [[Docs/Beats | the Beats]] on the wiki, but you should read the [[Docs/Beats/HowTo| Beat Writing How-To]] first.


== Other Fedora Documentation ==


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


== Project Administration ==
== Project Administration ==
Line 77: Line 76:


* [[DocsProject/UsefulScripts| Useful scripts]]
* [[DocsProject/UsefulScripts| Useful scripts]]
== Stuff ==
The central project workflow page is [[DocsProject/WorkFlow| DocsProject/WorkFlow]] .


[[Category:Docs Project]]
[[Category:Docs Project]]

Revision as of 15:19, 29 April 2009

DocsProject Header docTeam1.png


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

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

Join ContentDeveloper.png
Content writer

Join OSDeveloper.png
OS Developer

Join Translator.png
Translator

Join WebDeveloper.png
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.

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

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.


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 .