Project:Documentation

From Gentoo Wiki
Jump to: navigation, search
Documentation Project
Description The Gentoo Documentation Project (GDP) is responsible for the creation and maintenance of all general Gentoo documentation.
Email gentoo-doc@gentoo.org
IRC Channel #gentoo-doc
Lead(s) none
No lead election date set
Members
Subprojects
(and inherited members)
Parent Project Gentoo Linux
Project listing

The Gentoo Documentation Project was formed to address the need of complete documentation for Gentoo. In doing so, the GDP team is committed to the creation and maintenance of clear, concise, and original documentation. We will protect our users and developers by the use of free and open licensing on all documentation. The GDP is committed to remaining a free and open project, and will abide by the Social Contract set forth by the Gentoo Project.

Resources

Resources offered by the Documentation project are:

Gentoo documentation overview
Overview of the documentation on the wiki, not necessarily written by the documentation team.
Gentoo documentation policy
General documentation development policy for Gentoo.
Gentoo Handbook development
Information for wiki editors and translators regarding the Gentoo handbook development.

Obsolete

The following documents are no longer necessary/applicable, but are kept around for future reference.

Handbook release guide
Steps used to create a new handbook for Gentoo releases.
Tips and tricks for documentation development
Overview of various documentation development tips and tricks (for GuideXML development).
GuideXML Guide
Gentoo GuideXML syntax tutorial.
How to install Gorg
Gorg, or Gentoo.org, is a Ruby script used to render GuideXML as HTML. This document explains how to install it locally.
TODO List
Future roadmap of the documentation project

Participation

Mailing list

The Gentoo Documentation Project makes intensive use of the gentoo-doc@lists.gentoo.org mailing list. On this mailing list discussions about documentation, subprojects, translations, and more pass by.

To subscribe to this mailing list, send an empty e-mail to gentoo-doc+subscribe@lists.gentoo.org. Once subscribed you can post to it by sending an e-mail to gentoo-doc@lists.gentoo.org.

To unsubscribe from the list, send an empty e-mail to gentoo-doc+unsubscribe@lists.gentoo.org.

There is also an online archive on news.gmane.org.

Participating

To participate in the Gentoo Documentation Project first join the mailing list at gentoo-doc@lists.gentoo.org. Then ask if there are plans to support something that you are interested in, propose a new subproject that you are interested in, or choose one of the planned subprojects to work on. You may talk to the developers and users in the #gentoo-doc IRC channel on irc.freenode.net for more information or just to chat about the project or any subprojects. If you don't have the ability to actively help by contributing work we will always need editors to maintain the quality and accuracy of the overall product. All development, editing, and productive comments and feedback will be greatly appreciated.