You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@abdera.apache.org by James M Snell <ja...@gmail.com> on 2007/10/30 21:34:29 UTC
Docs
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
- James
Re: Docs
Posted by Dan Diephouse <da...@mulesource.com>.
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 <ja...@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
Re: Docs
Posted by James M Snell <ja...@gmail.com>.
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 <ja...@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 ;)
>
Re: Docs
Posted by Brian Moseley <bc...@osafoundation.org>.
On 10/30/07, James M Snell <ja...@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 ;)