Not sure I agree that good documentation is the last thing, but Marcin
brings up some fantastic points.  Maybe we are thinking too advanced here in
our documentation.  I would bet that there are alot of people who may not
fully understand Event driven frameworks.  I have read some SEDA
documentation (Matt Welsh) and we might want to put some introductory
information on the web page.


On 2/22/07, Marcin Waldowski <[EMAIL PROTECTED]> wrote:

Trustin Lee wrote:
> to attract more people to the MINA community
Hello.

I think that good documentation is the last thing, which MINA needs to
be widespread <http://www.dict.pl/plen?word=widespread&lang=PL> used :)

I think that first tutorial should be the explanation of idea behind
MINA, because this idea is a real power of the framework. This kind of
introduction would be the best advertise for MINA. The presentations in
documentation section is a very good base, it needs only some text.

Second tutorial should point people:
- what is "event driven IO framework",
- what are the benefits of using this kind of framework rather than
stream based framework,
- that Mina has the same benefits as Java NIO, but is easiest to use
than JAVA BIO and it solves lots of NIO developement problems,
- that it is a solution for people who try to write SSL over NIO.

Other suggestions for tutorials:
- Getting started (show that this is event driven, and it need a few code)
- Faq (already done)
- MINA Basics (about IoAcceptors, IoConnectors, IoHandlers, ByteBuffer
pooling, catching exceptions, about asynchronous writing)
- Data Flow (explanation about filter chains, what is
IoFilterChainBuilder and how filters chains are builded and when)
- Multithreading and concurency (already done = Configuring Thread Model
+ explanation about thread safety of IoHandler and IoFilter)
- Performance hints (setReceiveBufferSize(x), setUseDirectBuffers(x),
ByteBuffer.setAllocator(x), ReadThrottleFilterBuilder, etc.)

Regards,
Marcin




--
..Cheers
Mark

Reply via email to