Re: Documentation on the New GNOME Website

[John Fleck <jfleck inkstain net>]

On Sat, 2002-10-19 at 11:38, Jeff Waugh wrote:
> Forgot to Cc webhackers, especially MISTER STEVE FOX!
> 
> :-)
> 
> <quote who="Jeff Waugh">
> 
> > GDP documentation is going to be a big part of the New GNOME Website
> > (capitalised due to STRENGTH OF MYTHICAL PROPORTIONS), given that docs can
> > be seamlessly integrated into the site structure/design, and much of w.g.o
> > would be better maintained as docbook articles or books.
> > 
> > Certainly smaller, less modified stuff should be kept as HTML, but for
> > things like the FAQs, user guides, and other more solid documentation, I'd
> > love to have the GDP involved to work out what's lacking from the current
> > site.
> > 
> > API docs are pretty much covered, so I'm just interested in the user
> > oriented things.
> > 
> > Thoughts? I'd love to compile a list of existing documentation that should
> > be integrated, and 'stuff wot needs to be written'.
> > 

/me cheers on jdub

Two lines of discussion needed - the technical details of making docs
automagically appear and the contents.

The Technical
*************

Can I assume you've got some scripting magic planned by which a master
list of docs in cvs is kept, from which up-to-date html is built for the
web site? And this scripting magic will be smart enough to pull from
whichever branch we tell it?

We need to remember localization - we'll soon have docs translated into
a plethora of languages, so the file structure needs to be able to
accommodate that.

For extra credit, it would be marvelous if we also could have prebuilt
pdf's available as well. This is a common request.

The Content
***********

I'd like to see all of the user docs incorporated into this system,
including the amazingly comprehensive and cool UG and Sasha's
Introduction to GNOME.

Malcolm's porting guide should be included, as should the G2 release
notes.

This also provides an opportunity to think about the status of other
docs we have floating around that are useful but in a state of dusty
uncertainty - the glossary, the unix primer. What other docs should we
be discussing?

Cheers,
John
-- 
John Fleck
jfleck inkstain net (h) jfleck abqjournal com (w)
http://www.inkstain.net http://www.abqjournal.com

"Sometimes, a diner is all about the mac and cheese." 
  - Zippy the Pinhead