[aerogear-dev] [UnifiedPush Server] Documentation improvements ?

[Corinne Krych]

On 25 Mar 2014, at 08:55, Sebastien Blanc <scm.blanc at gmail.com> wrote:

> +1
> We got already almost all the material in the current readme and we can split that nicely into a howto and then rewriting maybe some parts.
> 
> 
> 
> On Tue, Mar 25, 2014 at 7:33 AM, Matthias Wessendorf <matzew at apache.org> wrote:
> Hi,
> 
> I feel a bit of the documentation might be misleading and not always that great to go over.
> 
> Instead of adding more and more the README, I think we should (w/in the REPO) start to write a guide/book on HOWTO.

+1 to add the doc in the relevant repo
We could alway inlude part of the ascidoc text in aerogear web site with the same mechanism as shown in this PR:
https://github.com/aerogear/aerogear.org/pull/275


> 
> Regarding the actual format, I think asciidoc comes to mind;
> 
> 
> Any thoughts ? 
> 
>  
> 
> -- 
> Matthias Wessendorf 
> 
> blog: http://matthiaswessendorf.wordpress.com/
> sessions: http://www.slideshare.net/mwessendorf
> twitter: http://twitter.com/mwessendorf
> 
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
> 
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev