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:

• New / Updated Documentation
• Documentation Metadata
• Internal Changes for Dates
• Use of gorg instead of AxKit

2.  New / Updated Documentation

The Guide to Mutt has been extended with a chapter on the use of msmtpd which allows for authenticated SMTP usage.

Thanks to Daniel Drake we now have a guide on Gentoo Linux Kernel Upgrading.

Daniel also updated the Gentoo Kernel guide.

And while he was on it, he also wrote the Complete Gentoo Linux 2.6 Migration Guide. Again a new addition to the Gentoo Documentation Repository :)

An overview of all fixed bugreports since the last status update can be found on Gentoo's bugtracking system.

3.  Documentation Metadata

Sven Vermeulen is working on a metadata format for the documentation which would allow translation teams to easily view the status of their translations, which allows for a dynamically generated index page (and full documentation listing) and more.

4.  Internal Changes for Dates

Sven Vermeulen migrated the dates and version information from the handbooks into the separate chapters. This allows translation teams to check their translation status a bit more easily.

This did lead to a few problems. Our webnodes are only able to use XSLT 1.0 which doesn't contain string manipulation routines and date formatting functions. In other words, every page displayed a different date. Luckily we had Xavier Neys in our team who did a tremendous job of hacking XSLT so dates are:

• Converted from a YYYY-MM-DD format to the correct localised date
• Calculated so that only the latest date of all pages is displayed

5.  Use of gorg instead of AxKit

Since we aren't completely happy with AxKit's functionality, the infrastructure team got taste of Xavier Neys's gorg. And since it performs quite well (very fast, decent caching and stand-alone possibility for local testing) the gorg application is already used on two out of Gentoo's three webnodes.