[Nut-upsdev] Documentation-related questions

[Arnaud Quette]

2009/1/20 Eric S. Raymond <esr at thyrsus.com>

> Arnaud Quette <aquette.dev at gmail.com>:
> > well, I've thought a bit about that in the past days, and I'm obviously
> > going for #1 (in-tree).
> > but I think with a slight variation: a few pieces don't need (and even
> more,
> > must not) be in the source tree. This is mostly the Homepage and Protocol
> > library (== everything not under Documentation in the wiki ; I've started
> to
> > reorganize this last with that idea in mind, but it's not finished).
> > You can have an idea of this by mousing over the wiki menu...
> >
> > The website is then a base container (homepage + menu) with pointers to
> the
> > online documentation.
> >
> > so I'm thinking about trimming it to that simple base. The wiki may then
> be
> > superfluous (I'm hesitating due to i18n, which is another target), and a
> > static set might do the trick.
> >
> > we will need to talk / think a bit more to refine the final solution, but
> > this looks really promising ^_^
>
> Your having made the basic decision helps a lot.  It means I can get
> started on
> moving the in-tree documentation to asciidoc, revising it as necessary.
> Tinkering with the wiki and what stays in it can come later.
>

another note I seem to have forgotten is that, beside the User and Developer
Manual split, a general reorganization of the doc (and its content) was
planned to consolidate, complement and simplify these.
So far, the new tree looks  like:
http://test.networkupstools.org/Documentation/UserManual

I also have a few draft notes on the Developer Manual if/when needed.
as stated before, the aim is to have the things that are only online atm,
back into the doc. so that in the end we only have to use pointer to these
from the website skeleton.

> I'll postpone a bit more these discussions to concentrate on the various
> > mentioned tasks. we can still continue to talk, but I won't be much
> > responsive atm.
>
> I'll have enough to work on until Thursday, then I'll be traveling until
> the following Tuesday.  We can resume this discussion after next week.
>

perfect timing!

don't hesitate to ping me if you have any questions / doubt in the meantime.
I'll do my best to prioritize this important subject to has been neglected
for too long!

cheers,
Arnaud
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.alioth.debian.org/pipermail/nut-upsdev/attachments/20090121/55d9541b/attachment.htm