[Nut-upsdev] NUT Documentation project

[Arnaud Quette]

2007/6/1, Eric S. Raymond <esr at thyrsus.com>:
> Arnaud Quette <aquette.dev at gmail.com>:
> None of this is difficult, except for WYSIWYG -- there aren't really
> any good WYSIWYG DocBook editors yet.  Nor, to my knowledge, is
> there a wiki-markup-to-DocBook translator.

aren't there some bridge to docbook, from tex, odf, ... that would
allow wysiwyg edition?

Anyway, the aim is not to convert especially to docbook, but to have a
system that allow easy and wysiwyg edition / maintenance, along with
the generation of various output format (txt, html, pdf). Any clue?
(Maybe Tex?! )

Though I'm still hesitating on the output formats:
- html is mandatory,
- ps/pdf is optional,
- txt may be optional.

More generally, the docs (README, INSTALL, ..., docs/*) have to be
reworked, keeping only the needed info, and referencing the user/dev
guide otherwise.

> I don't want to do this while you're in final pre-release mode, though
> -- it would be better if the dev group could review my changes at
> leisure rather than having a fait accompli thrown at them at the last
> minute.  You should ship *before* I start serious work and plan on a
> point release in another month or so specifically to get the new
> documentation on the street.

this can wait for 2.4, along with the new config and its major impacts
on the doc.
it will then depends on your results. if you have something tangible
in a month, we can check for a backport.

> I'll need commit access to the repo and write access to the website.
> I'm now esr-guest on alioth.

Welcome to the team.
Though you have not yet produced tangible contribution proof, I
believe that you will do soon.
Meanwhile, you need to get a better understanding of the _whole_ UPS
world, and the many underway NUT improvements...
I will get back to you on the architecture and simplification threads.

For the moment:
- read and conform to the NUT standards:
http://svn.debian.org/wsvn/nut/trunk/docs/developers.txt?op=file&rev=0&sc=0
- create an esr_doc branch to work on the doc,
- discuss all your changes to the trunk and other branches before
commiting, and get the approval of the current team members, esp.
Peter, Charles, Arjen and myself,
- do not abuse of your svn access,
- read all my mails carefully, since I've already exposed the solution
to the architecture and simplication things you've thrown (HAL / NUT
NG and avahi, new configuration file format and tools, new doc, Nut
Packaging Standard)!

Arnaud
-- 
Linux / Unix Expert - MGE UPS SYSTEMS - R&D Dpt
Network UPS Tools (NUT) Project Leader - http://www.networkupstools.org/
Debian Developer - http://people.debian.org/~aquette/
OpenSource Developer - http://arnaud.quette.free.fr/