dev@grizzly.java.net

Re: Documentation efforts for Grizzly 2.0

From: Oleksiy Stashok <Oleksiy.Stashok_at_Sun.COM>
Date: Fri, 03 Sep 2010 15:43:47 +0200

Hi Ryan,

here is a list I can think of.
I'd be very glad to gather ideas from guys outside Oracle Grizzly
team, which they might have basing on their experience.

Thanks.

WBR,
Alexey.


- core framework:

Overview
Memory management
I/O Strategies
Transports and Connections
Filter chain and Filters

Quick start
-- server
-- client

Configuring Grizzly
Best practices, advices
Samples


- http framework

Overview
How it works (describe the HttpFilter functionality)
Utilities:
-- Cookies
-- Transfer encoding
-- Content encoding
HTTP client sample
HTTP server sample

-web container framework

Overview
How to build simple web server
Long-lasting HTTP requests (suspend/resume)
NIO streams
File cache
Samples
-- server & blocking streams
-- server & NIO streams
-- server & long-lasting task & NIO streams



> In our Grizzly meeting two weeks ago, we decided that documentation
> should be a primary goal for the initial 2.0 release.
>
> We think that creating this documentation using LaTeX or Docbook
> will provide a lot of benefit as far as how we can distribute the
> documentation (online, bundled, etc).
>
> We'd like to poll the community on topics they would like to see
> covered in addition to the items I've listed below:
>
> - core framework
> - http framework
> - web container framework
>
> Keep in mind, that we still need to start our outlines of what we
> think should be covered in these areas, so once we've gathered
> feedback we can incorporate the changes and produce the final
> outlines for review.
>
> Once the outlines are approved, we can being writing the
> documentation in earnest.
>
> Thanks,
>
> -rl
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe_at_grizzly.dev.java.net
> For additional commands, e-mail: dev-help_at_grizzly.dev.java.net
>