abdera-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Dan Diephouse <dan.diepho...@mulesource.com>
Subject Re: Docs
Date Tue, 30 Oct 2007 23:38:58 GMT
Isn't writing stuff in Confluence fun? :-)

Cool stuff. Re: organization - a couple suggestions:
- Give long pages a Table of contents. Confluence has a TOC macro which 
makes it pretty easy.
- I would like to see the Getting Started page focus just on the bare 
minimum needed to get started. I.e. what you have about the client apis 
and the necessary jars.
- Other stuff could potentially go in their own pages: Document API, 
Authentication, Filters, Parsers, Security, etc. Not all that stuff is 
directly related to getting started IMO and is pretty advanced.

Those are just details though. Its great to see the docs coming along!

- Dan

James M Snell wrote:
> Take another look :-) It's fairly complete at this point. I've added a
> bunch more since I sent this note.  Once the server work settles down a
> bit, we need get started on a Server Implementation Guide.  I've already
>  created the page to host it [1].  I'm sure there are lots of little
> things we can add in, and it could probably be organized better but at
> least we have actual documentation now.  :-)
>
> - James
>
> [1]
> http://cwiki.apache.org/confluence/display/ABDERA/Server+Implementation+Guide
>
> Brian Moseley wrote:
>   
>> On 10/30/07, James M Snell <jasnell@gmail.com> wrote:
>>     
>>> FYI.. I've started working on detailed documentation here:
>>>
>>>   http://cwiki.apache.org/confluence/display/ABDERA/Getting+Started
>>>
>>> I will continue to fill in details over the next few days
>>>       
>> wow, that's a great start. i learned some things just from skimming it ;)
>>
>>     


-- 
Dan Diephouse
MuleSource
http://mulesource.com | http://netzooid.com/blog


Mime
View raw message