That would be great! I think TOC with fixme tags in place where docs
need more info is a good start.
~M~
John Grden wrote:
well, we have the wiki on OSFlash.org, so might as well
put that to good use yes?
Shall I start some pages for intro sake? I mean, a page that has a
list (TOC) of how too's etc that the community can add and participate
in
On 11/8/06, Marek Zoth <[EMAIL PROTECTED]> wrote:
I recommend to use some wiki
system for documentation creation so that
more people from the community could contribute to it directly.
Developers then spend much less time with docs.
~M~
Storm wrote:
I second the need of some documentation /sample
explanation. You guys
are doing a great job on this project and this issue is the only thing
i find lagging. It's not a complain, but a way to colaborate now you
know that Red5 is getting users that demand some more docs :). I'm hard
when it comes to leave things half-done so once i started researching
Red5 i didn't give up and i'm doing what i can with what i have, but
perhaps many potential users are passing by for that reason.
That been said, i'll read anything you release, so you've got other
"doc debugger" ;)
Cheers
Storm
On 11/8/06, Dominick Accattato <[EMAIL PROTECTED]
> wrote:
Hank, I think we all know what needs to be done. Its
difficult when we hear it because its painfully obvious, but the lack
of simple documentation is troublesome. I don't want to commit
myself to anything, but I'll try and get a few pages together.
Here was a quick mock up I did back during 0.3, but I
never
actually put much into completing sections.
On 11/8/06, hank williams <[EMAIL PROTECTED]
> wrote:
On
11/8/06, John Grden <
[EMAIL PROTECTED]> wrote:
> creating a new app with the new API:
> http://www.joachim-bauch.de/tutorials/red5/HOWTO-NewApplications.txt
>
> Migration guide:
>
http://www.joachim-bauch.de/tutorials/red5/MigrationGuide.txt
>
> API online:
> http://dl.fancycode.com/red5/api/
>
> Does that help?
>
Well, not really.
The first thing I wanted to do was run the demos. There is no getting
started guided. Now, it took me 15 minutes to figure out that red5
comes up on port 5080. Now I bet that is written down somewhere but I
couldnt find it. There really should be a getting started guide that
explains how to run the darned thing. Now I am a tomcat user, so I was
able to look at the text stream from red5 and look for the port. But
only someone who is in the tomcat/j2ee world will know how to do that.
I bet many people wont get that far.
Now, I did look at joachim's new application guide. But its just too
hard. Now I'm not saying that I wont ultimately be able to figure it
out. But a few well written pages can save someone like me hours, and
perhaps others days. The problem is just that the info is **WAY** too
terse and assumes understanding of things that one shouldnt assume.
For example he starts with a handful of lines that explain globalScope
and contextConfigLocation in the web.xml file. Now, honestly, it took
me months to get comfortable with the concept of the web.xml file in
standard servlet development. And the components and layout of a
web.xml is not exactly newbie friendly. Worse yet, he doesnt show a
whole, miminal web.xml - just snippets, leaving it to the imagination
how the whole thing goes together. Its very confusing.
But zooming back a level, this certainly isnt how I would start
explaining to a new person how to do a new app or what all of this is
about.
I could go on and on, but I think you get the idea.
This is not an attack on Joachim, but it is a real issue. One of the
problems with open source software is that the people that do it are
so smart that they dont quite understand how to explain what they are
doing to us dummies. This is particularly true with java/backend
stuff. I dont understand anything on the apache website!
I realize that you are only on .6 and its not really meant for general
consumption yet. But explaining how to turn it on, and a getting
started guide including how to do a hello world would probably be a
very helpful. It would to me anyway.
I appreciate the good work that you guys are doing. And while I am not
able to contribute development time, I would be happy to provide some
structural editing services for documentation. What that really means
is I am happy to read the doc and tell you where I am totally confused
and why, and to suggest some structure for the doc. I really do think
you guys need the help of a few dummies!
Regards,
Hank
_______________________________________________
Red5 mailing list
[email protected]
http://osflash.org/mailman/listinfo/red5_osflash.org
--
[ JPG ]
_______________________________________________
Red5 mailing list
[email protected]
http://osflash.org/mailman/listinfo/red5_osflash.org
|
