[gentoo-dev] Gentoo Documentation Project Status Update

[gentoo-dev] Gentoo Documentation Project Status Update

[Sven Vermeulen]

[-- Attachment #1: Type: text/plain, Size: 2895 bytes --]

[ Sorry for the crosspost, I should've sent this to -dev immediately ]

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. 

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

** Gentoo Handbook

  The first part of the Gentoo Handbook (Installing Gentoo) is finished and
  should be production ready. It is available online [1] 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)

** 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 [2]. 

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

** 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.

** Packaged documentation

  After a discussion [3] 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

** New supported languages

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


[1] http://www.gentoo.org/doc/en/handbook/handbook.xml
[2] http://emu.gentoo.org/~swift/gentoo-x86-install.pdf
[3] http://article.gmane.org/gmane.linux.gentoo.documentation/619


-- 
 ^__^   And Larry saw that it was Good.
 (oo)                                      Sven Vermeulen
 (__)   http://www.gentoo.org              Gentoo Documentation Project

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

[gentoo-dev] Gentoo Documentation Project Status Update

[Sven Vermeulen]

[-- Attachment #1: Type: text/plain, Size: 2652 bytes --]

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. 

This status mail will briefly discuss the following tasks, objectives and/or
projects related to the GDP:
  - Supported languages
  - PDF documentation
  - GuideXML Update
  - Gentoo Handbook
  - WYSIWYG editor
  - Stylesheets

** Supported languages

The Danish translations are fully integrated in the documentation project. Their
documentation can be found at http://www.gentoo.org/doc/da/index.xml. We welcome
broeman and Aaby to our team :)

Dertobi123 has also joined our team as new lead translator for the German
language. He has taken over Pylon's position. We ofcourse also welcome 
dertobi123 aboard :)

** PDF documentation

As is mentioned in previous status mails, we will create PDFs using FOP.
However, development of the script is on a hiatus until the new infrastructure 
design is ready to be deployed (namely having webnodes sync from a master 
webnode instead of from the gentoo cvs server).

** GuideXML Update

The GuideXML format, used to develop the documentation, has been extended with
the possibility to identify chapters or sections so that internal references are
dealt with more easily. More information on this can be found at [1]

** Gentoo Handbook

The part on "Installing Gentoo" is now the official source for installation
instructions. The "older" installation guides are still maintained though up
until the new Gentoo Linux comes out.

** WYSIWYG editor

ian@gentoo.org is working on a (GPL'd) tool that allows editors to create
documents through a webbased WYSIWYG editor. Currently it works but lacks some
necessary features, such as 100% GuideXML compliance, and the use of the Coding
Style. However, the project looks very promising. Certainly one to keep an eye
on :)

** Stylesheets

The guide-print.xsl style has been updated so that the printable versions of our
documentation is really printable. Before, a margin was left unprinted,
rendering the "printer friendly" feature useless.

[1] http://article.gmane.org/gmane.linux.gentoo.documentation/688

Wkr,
	Sven Vermeulen

-- 
 ^__^   And Larry saw that it was Good.
 (oo)                                      Sven Vermeulen
 (__)   http://www.gentoo.org              Gentoo Documentation Project

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

[gentoo-dev] Gentoo Documentation Project Status Update

[Sven Vermeulen]

[-- Attachment #1: Type: text/plain, Size: 343 bytes --]

Hi all,

A new status update for the Gentoo Documentation Project is available at
http://www.gentoo.org/proj/en/gdp/status/status_20040117.xml.

Wkr,
	Sven Vermeulen

-- 
 ^__^   And Larry saw that it was Good.
 (oo)                                      Sven Vermeulen
 (__)   http://www.gentoo.org              Documentation & PR

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

[gentoo-dev] Gentoo Documentation Project Status Update

[Sven Vermeulen]

[-- Attachment #1: Type: text/plain, Size: 451 bytes --]

A new status update has been posted to the Gentoo Documentation Project page.
It'll show up online at http://www.gentoo.org/proj/en/gdp/status/status_20040219.xml
within one hour.

Wkr,
	Sven Vermeulen

-- 
  FOSDEM 2004               Free and Open Source Developers European Meeting
  21 - 22 februari          Brussels, Belgium          http://www.fosdem.org

  http://www.gentoo.org     Documentation & PR              swift@gentoo.org

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

[gentoo-dev] Gentoo Documentation Project Status Update

[Sven Vermeulen]

[-- Attachment #1: Type: text/plain, Size: 498 bytes --]

Hi all,

A new status report on the GDP has been posted at
http://www.gentoo.org/proj/en/gdp/status/status_20040308.xml

Topics include:
    * Separating Architecture-Specific Instructions
    * New / Updated Documentation
    * Individual Status Updates
    * New Internationalisation Lead


Wkr,
	Sven Vermeulen

-- 
 ^__^   And Larry saw that it was Good.
 (oo)                                      Sven Vermeulen
 (__)   http://www.gentoo.org              Documentation & PR

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

[gentoo-dev] Gentoo Documentation Project Status Update

[Sven Vermeulen]

[-- Attachment #1: Type: text/plain, Size: 371 bytes --]

Hi all,

A new status update for the Gentoo Documentation Project has been committed
and is available at
http://www.gentoo.org/proj/en/gdp/status/status_20040503.xml

Wkr,
      Sven Vermeulen

-- 
 ^__^   And Larry saw that it was Good.
 (oo)                                      Sven Vermeulen
 (__)   http://www.gentoo.org              Documentation & PR

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

[gentoo-dev] Gentoo Documentation Project Status Update

[Sven Vermeulen]

[-- Attachment #1: Type: text/plain, Size: 368 bytes --]

I've uploaded a new GDP Status Update to
http://www.gentoo.org/proj/en/gdp/status/status_20040924.xml (not yet
available, please wait until webservers synchronise).

Wkr,
      Sven Vermeulen

-- 
 ^__^   And Larry saw that it was Good.
 (oo)                                      Sven Vermeulen
 (__)   http://www.gentoo.org              Documentation & PR

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

[gentoo-dev] Gentoo Documentation Project Status Update

[Sven Vermeulen]

[-- Attachment #1: Type: text/plain, Size: 266 bytes --]

Hi all

A new GDP Status Update has been committed and is available at
http://www.gentoo.org/proj/en/gdp/status/status_20041021.xml

Wkr,
      Sven Vermeulen

-- 
  Documentation & PR project leader

  The Gentoo Project   <<< http://www.gentoo.org >>>

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

[gentoo-dev] Gentoo Documentation Project Status Update

[Sven Vermeulen]

[-- Attachment #1: Type: text/plain, Size: 268 bytes --]

Hi all

A new Gentoo Documentation Project Status Update is available at
http://www.gentoo.org/proj/en/gdp/status/status_20041121.xml

Wkr,
      Sven Vermeulen

-- 
  Documentation & PR project leader

  The Gentoo Project   <<< http://www.gentoo.org >>>

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]