users@grizzly.java.net

Re: Documentation efforts for Grizzly 2.0

From: Ming Qin <mingqin1_at_yahoo.com>
Date: Fri, 3 Sep 2010 08:26:42 -0700 (PDT)

Oleksiy:
  can we have sequence diagrams for core framework ( server)?


Ming Qin
Cell Phone 858-353-2839

--- On Fri, 9/3/10, Oleksiy Stashok <Oleksiy.Stashok_at_Sun.COM> wrote:

From: Oleksiy Stashok <Oleksiy.Stashok_at_Sun.COM>
Subject: Re: Documentation efforts for Grizzly 2.0
To: dev_at_grizzly.dev.java.net
Cc: users_at_grizzly.dev.java.net
Date: Friday, September 3, 2010, 6:43 AM

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:
OverviewMemory managementI/O StrategiesTransports and ConnectionsFilter chain and Filters
Quick start-- server-- client
Configuring GrizzlyBest practices, advicesSamples

- http framework
OverviewHow it works (describe the HttpFilter functionality)Utilities:-- Cookies-- Transfer encoding-- Content encodingHTTP client sampleHTTP server sample
-web container framework
OverviewHow to build simple web serverLong-lasting HTTP requests (suspend/resume)NIO streamsFile cacheSamples-- 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