The Gentoo Linux Documentation team aspires to create exceptionally
professional documentation that is immediately clear and concise to the
end user. In order to fulfill this goal, we have very specific rules and
guidelines that
This policy will cover these topics:
The Gentoo Documentation Project Team is split into several smaller teams that operate in complete cooperation with each other. Each smaller team represents an active development team of a Gentoo Documentation Subproject.
The Gentoo Documentation Project is strategically lead by a top-level
manager as required by the
For day-to-day managerial tasks the Gentoo Documentation Project has an operational manager. This person keeps track of all documentation-related tasks that are more short-term. The operational manager and strategic manager can be one and the same if the strategic manager wishes so.
Currently these positions are taken by the following people:
| Position | Developer Name | Developer Nick |
|---|---|---|
Every subproject has a strategic manager of its own. He or she can
have an operational manager if he or she deems appropriate. His
responsibilities to the Gentoo Documentation Project are the same as are
listed on the
The subprojects of the Gentoo Documentation Team together with their
respective strategic managers are listed on the
The decision on adding subprojects is in hands of the strategic manager.
Every member of the Gentoo Documentation Project must be subscribed to
the
Every member of the Gentoo Documentation Project must be subscribed to
the
Every member of the Gentoo Documentation Team should be available at
Depending on her/his responsibilities, he or she can have limited CVS
access to
Every language should be backed up by an official translation team. This team is lead by a lead translator and perhaps a follow-up lead translator, who both have CVS commit access. If for any reason the lead translator cannot perform his or her duties, the follow-up lead translator is in charge. If even this person is unavailable, the mentor(s) is/are in charge of the language.
If a translated document is contributed, but the language in itself is not supported, the Gentoo Documentation Team will not publish it officially. In this case the document will stay unlinked until an official translation team of that language is formed.
When a language is officially supported, but the team doesn't have any members or no one wants to take on the responsibilities of the lead translator, all links to the documents will be removed from the site. However, the documents will stay available in case the language becomes officially supported again.
Every document published by the Gentoo Documentation Project must be
licensed by the
Every document must have the following tag inside its GuideXML
sourcecode between the
</abstract> <!-- The content of this document is licensed under the CC-BY-SA license --> <!-- See http://creativecommons.org/licenses/by-sa/2.0 --> <license/> <version>...</version>
Every bug reported on
Whenever a Gentoo Documentation Team member takes care of a bug, he or
she should assign the bug to herself/himself, but make sure that
Every document the Gentoo Documentation Team develops can be developed
as the related parties see fit. However, when the document is finished,
it should be transformed into
When a new document is started or a big change is needed, a bug should be filed
at
All changes in contents of the document, except for typo fixes in text itself or in the comments to code listings, should lead to version number (and date) increase. Note that the change of a Code Listings should definitely cause an increase of the version number and date.
When updating a handbook-related file (such as the various
All changes in XML formatting should lead to version (and date) bumps only in case the layout of the document changes.
Whether or not to increment the major version number instead of minor version number or other is up to the editor.
Every update of a translation should copy the new version information verbatim from the master English document so fully synchronised translations have the same version information.
To keep a high-pace development cycle of the documentation, technical or
intrusive changes to documents can be propagated immediately to the document
High volume, technical or intrusive changes must be accompanied by a bugreport
on
If a bugfix consists out of both content as internal coding changes, both changes must be committed seperately so that translators can easily view the important changes (content) and ignore the coding changes.
In case of a translation, the lead translator of the language is responsible for the document. Only he or she may commit the document to CVS unless he or she is currently "in training", in which case his or her mentor should commit it.
Although this has never been necessary, it is still important to list this in the policy - even though it is hateful. Anyway, documentation developers that misuse their position by
will be reported to the
Everyone interested in contributing documentation, editing existing
documentation, writing new documentation or translating documentation is
welcome to join the team. There are no rules or strings attached to
this. Just make sure you are subscribed to
As a Gentoo documentation developer should know everything in the
Contact the operational manager of the Gentoo Documentation Project. He will ask you for your coordinates and other information and then arrange a mentor for you who will guide you through the first days or weeks as developer.
You will be given a Gentoo e-mail address and be appointed to one or more subprojects. During the initial days or weeks, you should ask your mentor as much as possible, preferably have him/her double-check everything you do. If your function requires CVS access, you will only receive it when your mentor deems it appropriate. Until then, your mentor is in charge of the CVS commits.
Becoming a (follow-up) lead translator shouldn't be held lightly. You are responsible for every translated document and final reviewing. The lead translator will make certain that the translated documents are grammatically and syntactically perfect.
In order to become a Gentoo (follow-up) lead translator you must be a Gentoo developer.
During your "training" period you are a (follow-up) lead translator and should act upon it. All guidelines regarding (follow-up) lead translators apply.