dev@grizzly.java.net

Re: Improving documentation

From: Hubert Iwaniuk <neotyk_at_kungfoo.pl>
Date: Wed, 22 Apr 2009 22:22:10 +0200

Hi,

On Wed, Apr 22, 2009 at 10:04 PM, Jeanfrancois Arcand <
Jeanfrancois.Arcand_at_sun.com> wrote:

>
>
> Survivant 00 wrote:
>
>> oh ya.. we need more doc.. but we still have useful docs.. but the problem
>> is how to find it. It's not trival actually.
>>
>
> Agree.
>
>
>> We could add a "How to ..." section with samples or examples.
>>
>
> Agree. I think the index.html needs come clean up


Personally I like style of Hudson and Jersey index.html, very clean and
simple first impression, easy to navigate to section of interest.


>
>> We could list all the documentation items that we want to cover and we
>> split to task :)
>>
>
> +1
>
> I also agree with Hubert. A wiki is needed :-)


 I've attached possible structure of documentation. Please comment on it,
based on this we can split to tasks.

Regards,
   Hubert.


>
> A+
>
> -- Jeanfrancois
>
>
>
>>
>>
>>
>> 2009/4/22 Oleksiy Stashok <Oleksiy.Stashok_at_sun.com <mailto:
>> Oleksiy.Stashok_at_sun.com>>
>>
>> Hi Hubert,
>>
>>
>>> As pointed in
>>>
>>> http://www.znetdevelopment.com/blogs/2009/04/07/scalable-nio-servers-part-1-performance/
>>> we could improve Grizzly documentation.
>>>
>> Right, from documentation point, we could be improved a lot.
>>
>> So it would be more accessible to users.
>>> I was thinking of creating some wiki space to structure available
>>> information so it gets easier for users.
>>> As Igor Minar pointed we could use wikis.sun.com
>>> <http://wikis.sun.com>
>>>
>> Or we can use glassfish wiki
>> http://wiki.glassfish.java.net/
>>
>>
>>>
>>> What are you thoughts on doing so?
>>>
>> Good idea.
>>
>> WBR,
>> Alexey.
>>
>>
>>>
>>> Cheers and have a good day,
>>> Hubert
>>>
>>
>>
>>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe_at_grizzly.dev.java.net
> For additional commands, e-mail: dev-help_at_grizzly.dev.java.net
>
>




Grizzly_Documentation.png
(image/png attachment: Grizzly_Documentation.png)