Re: [Freevo-docs] Status

[Eduardo R. <tr...@mu...>]

On Thu, 2003-07-17 at 12:38, Dirk Meyer wrote:
> "Tommy Killander" wrote:
> > Hi guys,
> 
> Hi from me, too
> 
> > Also I have Zero knowledge in Wiki, DocBook and SGML/XML, so I need to spend
> > some time with that before I'm up to speed.

Around ten tags is all what you need to make a functional doc.

> 
> I would prefer DocBook. I don't know the DTD, it's very complex. But
> we only need a subset of it. Look at the installation howto in the
> Freevo Docs dir, it looks very simple.
> 
> > 1. Should we establish DocBook as the preferred standard for the
> > documentation that is shipped with Freevo ?
> 
> I vote for yes.

Me too.

> > 2. Should we maintain the Wiki also ?
> 
> No, the new _real_ documentation should be our only doc. The WiKi may
> be a way to submit new docs.

What I was thinking is a system like the php or mysql documentation.
Sometimes this is called 'annotated documentation'. A simple description
is: documentation that at the bottom accepts pieces of text submitted by
interested people.
I can't find something like this already done and distributed as a
package. I imagine that we need something that takes the xml of the
docbook document and generates this page+script automatically. After
some time elapsed we include the annotations in the real docbook
document and regenerates the whole thing.
I can't believe that nothing like that exits, can't found it, that is
the problem.

> 
> > 4. How do we communicate with the development team about implementation
> > questions and upcoming features ?
> 
> You should read the devel list and the developers should sent you a
> small description about new features and how to use them. 

Very important point.

> 
> > 5. How many are on the list right now ?

> That's a good question.

I count four addresses since my subscription.

> 
> > Please send a small presentation with name and the usual stuff. Also throw
> > in a couple lines about your area of knowledge and how you could contribute
> > to the documentation effort. 
> 
> OK, my name is Dirk Meyer, but I'm called Dischi (don't ask why, long
> story with too much Beer). I live in Germany and work at the
> University of Bremen. I have a Diplom (similar to a Master) in
> Computer Science and I'm working on my Phd right now. And I'm the
> current maintainer of Freevo, but I guess you know that.
> 

My turn. My name is Eduardo Roldan. I live in Uruguay and work in a
Wireless ISP. I haven't any degrees at all :), but I have four years
working in all sort of things around telco/unix. I like freevo and I use
it on my house. I want to put a bit of my time making freevo better.
Something like 99% of my programming work is done with python. I also do
PHP, postgreSQL, MySQL, docbook(little), unix admin, networking.
Currently my free time is taken by my baby project quica
(sf.net/projects/quica), so I wan't to take an important role in the
docs team. Almost forget this, my native tongue is Spanish.

Well, nobody want to take the torch. We are screwed as a doc team?