Gentoo Logo

GDP Status Report

Content:

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 / Updated Documentation

Most translation teams have completed their translation of the Gentoo/x86 2004.3 handbook. A job well done! This makes that the following languages have an up to date handbook: Danish, German, English, Spanish, Finnish, French, Italian, Japanese, Polish, Brazilian Portuguese, Romanian and Traditional Chinese. Others are working on the necessary updates. We can't say enough "Thank you" to the hard-working translation teams.

Note especially the availability of the Romanian and Polish translations, which are new languages for our growing translation community. A big thanks to both for joining the Gentoo Documentation Project and dedicating their free time to the continuous translation of the ever-changing documentation repository.

We have received a new documented titled Gentoo Keychain Guide by Eric Brown, covering SSH public key authentication and the use of keychain.

Another new document is the Cron Guide, written by Eric Brown, which describes how to setup and use cron, a daemon that runs scheduled tasks.

Other documents that are updated are the Distcc Guide, Quickstart Guide to Mutt E-mail, Alternative Installation Guide, Gentoo FAQ, Virtual Mail Hosting HOWTO, Migration To Linux 2.6 Guide.

Of course, we shouldn't forget all the updates to the other guides, such as spelling and grammar fixes and bugfixes that were reported to Bugzilla.

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

3.  Uncertainties about stage files

A nice thread on the gentoo-doc mailinglist discussed possible issues with the use of stage1. The Gentoo Documentation Team leaves it up to the Release Engineering team to decide what to do.

4.  Separating Handbook into Release and Current

With the Release Engineering Team deciding to lower the release cycle to a biannual release (from a quarterly release), the installation instructions will undoubtedly have difficulties containing both the newest instructions for those performing a live, Internet-based installation, and the instructions for a networkless installation.

Sven Vermeulen has proposed to split the Handbook's installation instructions in two: one handbook will be dedicated to the ongoing installation instructions, based on the latest stable trees. The other handbook will contain the networkless installation instructions for a particular release (such as 2004.3, 2005.0).

Of course, this change only applies to the installation instructions. All subsequent parts remain the same since, after executing emerge --update world on their system, users who have performed a networkless installation are then running an up-to-date system as well as any other Gentoo user.

At this moment, preliminary drafts for the handbooks are available for all architectures. The move of the documentation is scheduled for January 4th, 2005.

5.  Automatically Generating Documentation Index

Sven Vermeulen has introduced a metadoc.xml file which enables the GDP to automatically generate the documentation index. By introducing this file, we are now also able to:

  • hide documentation from the index easily when a showstopper bug (security or extremely outdated) has occurred
  • easily view the bugreports that affect documentation which aren't solved immediately. This enables contributors to easily see where they can contribute.
  • categorise documentation for easy access to the entire repository
  • list the translation team members
  • ...

The automatically generated index is accompanied by a documentation listing and an overview page.



Print

Page updated January 2, 2005

Summary: Status report of the GDP project

Sven Vermeulen

Donate to support our development efforts.

Copyright 2001-2014 Gentoo Foundation, Inc. Questions, Comments? Contact us.