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:

• Gentoo Handbook
• PDF Documentation
• Non-gdp Documentation
• Packaged documentation
• New supported languages

2.  Gentoo Handbook

The first part of the Gentoo Handbook (Installing Gentoo) is finished and should be production ready. It is available online and contains the installation instructions for almost all supported architectures (x86, ppc, sparc, hppa, alpha). I hope to extend it with the other architectures that are lurking (amd64, ia64, mips) when I receive more information about those.

I will start with designing the second part pretty soon now. This part should contain the Gentoo-specific items for administering your system (Portage, initscripts, conf.d/env.d)

3.  PDF Documentation

Using FOP gives us the best results and can be perfectly integrated with our current GuideXML format (as it uses an XML format itself, XML-FO). The resulting transformation of our x86 installation guide can be found at my dev-page.

I am now working on a script to have the transformation (GuideXML -> PDF) done on the server-level so that everything can be automated.

4.  Non-GDP Documentation

We have started with the cluster project documentation and are integrating it in our documentation tree. Other documentation (and projects) should follow soon.

5.  Packaged Documentation

After a discussion we came to the agreement that it is not beneficial to provide a package for our documentation. If a user wants the Gentoo documentation somewhere on his disk, (s)he should use wget, like this:

$ wget  --recursive --level=1 1 --no-parent --page-requisites --convert-link \
      --no-host-directories --html-extension \
      http://www.gentoo.org/doc/en/index.xml

6.  New Supported Languages

The Danish language is now an officially supported language, and the Greek language volunteers have stepped up and are "in training".