Re: [Therion] Docs and debian packaging

[Wookey]

On 2007-01-04 14:16 +0100, Ladislav Blazek wrote:
> 
> Martin Budaj napsal(a):
> > On 12/27/06, Wookey <address@hidden> wrote:
> >> I have made the 0.4.1~pre20061221 debian packaging of the latest
> >> snapshot. This includes the wiki docs and the current source and debs
> >> are available at:
> >> http://wookware.org/files/therion/
> >>
> >> However I have a problem with the packaging.
> >>
> > [...]
> >>
> >> So, the question for therion authors/admins (who shouldn't really have
> >> to
> >> worry about debian packaging), is do you think including the wiki docs
> >> in either the main source tarball or a different docs one (and move
> >> the thbook into that too) is a good idea or not?
> >
> > We see only one possibility (not mentioned by you) -- to make a
> > separate therion-wikidocs package and leave the therion package as is,
> > including the thbook sources. The reason is that we cannot guarantee
> > the correctness of wiki pages and there _should_ be some official
> > documentation in the main package. The split we suggest is between
> > author- and user-contributed files, not between source and
> > documentation.

OK, thanx for getting back to me. I'm afraid I do not really agree
with you: I think users would prefer to see 'tools' and 'docs'
packages - they don't really care who wrote the docs, or expect some
docs to be in docs package but others to be in tools package. They
either already know the package and do not need docs, or they do need
docs, in which case the wiki ones are definately the most useful. For
new users the wiki docs are the ones they should be reading first, not
the thbook. Lack of synchronisation between docs and code is an issue,
but a manageable one. 

But even though I do not entirely agree, I can work with your split. It
is is simple for me, just not ideal for users (IMHO). 

> I completely agree with Martin - wiki should be optional package. I think
> it is too big (and will be even bigger) for inclusion in therion package.

Exactly - that is why it should be in a separate docs package, and
once you have one of those it seems to me that the thbook should
ideally be in it too. 

> I will prepare some script for generating wiki tarball nightly.

OK. That would be great.

Wookey
-- 
Aleph One Ltd, Bottisham, CAMBRIDGE, CB5 9BA, UK  Tel +44 (0) 1223 811679
work: http://www.aleph1.co.uk/                 play: http://wookware.org/
_______________________________________________
Therion mailing list
address@hidden
http://www.speleo.sk/mailman/listinfo/therion