From Fedora Project Wiki

m (Adding Writing_Using_The_Wiki to list of pages to read)
(Make this section less list-y)
Line 20: Line 20:
== The Documents ==
== The Documents ==


Published 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]].
* http://docs.fedoraproject.org
* [[:Category:Documentation]]


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]].
* [[Docs/Drafts| Docs/Drafts]]  
* [[:Category:Draft_Documentation]]


Using DocBook XML for Fedora-based documentation:
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.
* http://docs.fedoraproject.org/documentation-guide/
 
Self-referential example tutorial in XML:
* http://cvs.fedoraproject.org/viewcvs/example-tutorial/en_US/example-tutorial2.xml?root=docs
 
Writing using the wiki guide:
* http://www.fedoraproject.org/wiki/DocsProject/Writing_Using_The_Wiki
 
The latest works-in-progress are always available from our CVS repository:
 
* [[DocsProject/CvsUsage| Using the Fedora Documentation Project's CVS Repository]]  


=== Release Notes "Beats" ===
=== Release Notes "Beats" ===


The [[Docs/Beats|  Beats]]  are the living documents that become the release notes for Fedora releases.
The [[Docs/Beats|  Beats]]  are the living documents that become the release notes for Fedora releases. The process for creating the release notes is documented on the [[DocsProject/ReleaseNotes/Process| Release Notes process page]].  You can find writers of the Beats on the [[DocsProject/ReleaseNotes/Beats|  Beat Writers]] page.
 
The process for creating the release notes is documented here:
 
* [[DocsProject/ReleaseNotes/Process| The Release Notes Process]]  
 
Writers of the Beats can be found here:
 
* [[DocsProject/ReleaseNotes/Beats|  Beat Writers]]  
 
You can help maintain the Beats here on the wiki:


* [[Docs/Beats| Beats]]  
You can help maintain [[Docs/Beats | the Beats]] on the wiki, but you should read the [[Docs/Beats/HowTo| Beat Writing How-To]] first.
* [[Docs/Beats/HowTo| Beat Writing How-To]]


== Other Fedora Documentation ==
== Other Fedora Documentation ==

Revision as of 21:18, 30 December 2008

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 . . . Steering Committee


Project Workflow

The central project workflow page is DocsProject/WorkFlow .

The Documents

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 Documentation Guide and a 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 git repositories on Fedora Hosted, or you might choose to resurrect an older document from the Docs Project's CVS repository.

If you prefer to write on the wiki, read the wiki guide that we've prepared. It shows how to mark up text, where to store pages, and so forth.

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.

Other Fedora Documentation

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

Project Administration

The Fedora Docs Project Steering Committee maintains the Project infrastructure, including the DocsProject Wiki pages.

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.