[Red5devs] [Red5] RED5 API

[Daniel Rossi]

On 17/07/2008, at 11:49 PM, Aljosa Mohorovic wrote:

>>
>
> with no intention to start a never ending discussion red5 seriously
> lacks documentation.
> i've been using it part time since 0.5 release and most of my problems
> are related to docs.
> i'm sure more red5 users/developers would contribute but i guess most
> of them are still trying to figure out how things are working.
> with better docs red5 users would have time to answer newbie
> questions, submit better bug reports and prepare better/more efficient
> testing environments.
> all that would eventually result in red5 users submitting simple
> patches and allowing core developers to concentrate on important
> thing.
>
> Aljosa
>

Sorry about the cross post !

Hi there, I have a month free before I am on leave. I am currently  
looking at JMX - SNMP bridges for SNMP polling and graphing data in  
our cacti system which also exposes other information to graph like  
clients connected etc. I know a java monitoring implementation which  
just hooks into JMX is possible but the zenoss system never built  
correctly on osx to test and the opennms system wasnt exactly what i  
was after and quite confusing as an UI, but that is just another  
system to install and maintain, most of the people are already  
familiar with cacti which runs on one of the freebsd servers and polls  
the snmp processes fine.

Anyway once im done with this and have it running I can revisit the  
documentation. Firstly we need something in a single easy to maintain  
format. Right now the documentation is in multiple formats which is  
html , rst, txt, doc, and the Rst docs have formatting issues so  
cannot convert correctly.

I propose for web html and pdf book formats to move to docbook xml,  
either xml or exported in open office documents though the xml will be  
easier to deal with. Most systems out there use docbook, I have sent  
some examples including spring / spring security / acegi. Dcobook 5  
can use  xml include statements, to seperate many parts and include  
duplicate sections.

I had distributed one pdf generated before, but never continued  
because there was no format standard, and had to keep changing things  
in the Rst documents, to reformat them, convert to docutils xml, then  
transform the docutils xml to docbook xml then generate the pdf from  
there !

The wiki will be good for tutorials, examples, demos stuff like that,  
however does everyone have access to that ?

Is something like this you would be after ?

http://red5.electroteque.org/dev/doc/docbook/pdf/Red5.pdf