[aerogear-dev] Cleaning up the guide section of aerogear.org

Sebastien Blanc scm.blanc at gmail.com
Tue Oct 15 06:23:36 EDT 2013


On Tue, Oct 15, 2013 at 11:19 AM, Corinne Krych <corinnekrych at gmail.com>wrote:

> +1 on grouping related documentation.
>

+1 on grouping, that should be our first task.

>
> One thing I noticed is that we are not always consistent on grouping.
>
> For user guides, we do grouping on features OTP (which include
> iOS/Android/JS) and then separate link for cordova
> BUT we also do grouping for other features on iOS/Android/JS
>
> Titles are different too: we say "AeroGear Android User Guide" (which
> really refer to Android Cookbook) whereas we have "AeroGear iOS API
> Cookbook"
>

+1 Consistency is king !

>
> "Getting started" definitiveny need to be per platform
> "User Guides", I think I like them also per platform.
>
> Overall you right Seb, a bit of documntation refactor won't hurt.
>
> ++
> Corinne
>
> On Oct 15, 2013, at 10:58 AM, Daniel Bevenius <daniel.bevenius at gmail.com>
> wrote:
>
> > +1
> >
> >
> > On 15 October 2013 10:56, Matthias Wessendorf <matzew at apache.org> wrote:
> > +1 good idea to plan some overhauls on there;
> >
> > Perhaps also a little bit of grouping? E.g. all the things around Push -
> currently the list is very long :-)
> >
> >
> > On Tue, Oct 15, 2013 at 10:32 AM, Sebastien Blanc <scm.blanc at gmail.com>
> wrote:
> > Hi !
> > I aws looking at http://aerogear.org/docs/guides/ , it's great , there
> is a lot of info but IMO there is too much infos, especially the "Getting
> Started" section :
> >
> > - We have some old documents not directly related to "core" Aerogear,
> like http://aerogear.org/docs/guides/HTML5RESTApps/
> > - We have some nice Tutorials that are at the end of the list which
> should be more visible
> > - Some images links are broken.
> >
> >
> > Before opening jiras/PR I just wanted to ping the community to ask for
> their opinions.
> >
> >
> > Seb
> >
> >
> >
> > _______________________________________________
> > aerogear-dev mailing list
> > aerogear-dev at lists.jboss.org
> > https://lists.jboss.org/mailman/listinfo/aerogear-dev
> >
> >
> >
> > --
> > 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
>
>
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/aerogear-dev/attachments/20131015/d0774987/attachment-0001.html 


More information about the aerogear-dev mailing list