GDP Status Report
1.
Status Reports
Preliminaries
This is the status of the Gentoo Documentation Project. It will be posted
regularly, but not with a static frequency. All questions can be posted to
gentoo-doc@gentoo.org or to
me personally.
The Gentoo Documentation Project, from now on abbreviated to GDP, has its own
project page (just like almost all other Gentoo projects). You can find it at
http://www.gentoo.org/proj/en/gdp.
Content
This status mail will briefly discuss the following tasks, objectives and/or
projects related to the GDP:
2.
New Documentation
While we already had a MySQL HOWTO,
an MySQL Upgrading Guide has been
submitted as well by Michael Kohl and
Francesco Riosa.
The description of the various Gentoo stages has also been updated in the Gentoo Handbook to make it easier for the users to
understand when to pick a stage1, 2 or 3.
The past month gave quite a lot of updates on existing documentation. After a
quick word-count command on the CVS activity in the English documentation
repository we see that 94 documents have been updated (of a total of 399),
which is almost a quarter of our documents.
Of course, we shouldn't forget all the updates to the other guides, such as
spelling and grammar fixes, bugfixes or translations that were reported
and submitted to Bugzilla.
An overview of all fixed bugreports since the last status update can be found on Gentoo's bugtracking system.
3.
Converted Articles
To continue our article writing saga, another batch of articles has been
converted to the GuideXML format:
-
Linux kernel
compiling
-
Software RAID, part
1
-
Software RAID, part
2
-
LVM, part 1
-
LVM, part 2
-
OpenSSH key
management, part 1
-
OpenSSH key
management, part 2
-
OpenSSH key
management, part 3
-
Advanced filesystem implementors
guide, part 8
-
The gentoo.org redesign, part
1: A site reborn
-
The gentoo.org redesign, part
2: A site reborn
-
The gentoo.org redesign, part
3: A site reborn
-
The gentoo.org redesign, part
4: A site reborn
-
An introduction to Samba, part
1
-
An introduction to Samba, part
2
-
An introduction to Samba, part
3
4.
GuideXML Improvements
Our GuideXML format has been extended with a few features to make (y)our
life/lives easier:
- Support for definition lists
- Support for col- and rowspan attributes for table headings
- Support for epigraphs
- Support for subscript and superscript
-
Support for marking documents as:
- outdated (for older release handbooks)
- an article (adding disclaimer about origin and maintenance)
- draft
- obsoleted
- Support for redirecting users to a new document
-
Support for informing the reader of a translated document that a more
recent document exists in the English documentation repository
Those interested in using these features should of course update their
stylesheets to the latest version, read the mails on
gentoo-doc@gentoo.org and learn the GuideXML Guide by heart.
The contents of this document, unless otherwise expressly stated, are licensed under the CC-BY-SA-2.5 license. The Gentoo Name and Logo Usage Guidelines apply.
|