[aerogear-dev] SITE: API Documentation and Specifications

[Andres Galante]

I have updated the repo with the changes on structure we talked about.

https://github.com/andresgalante/aerogear.org/tree/new-design

Please check out Guides (under getting started) and Documentation Specs (under Docs) indexes, if you can help me figure that out I'll take care of putting the rest of the files together.

Thanks!



----- Original Message -----
From: "Bruno Oliveira" <bruno at abstractj.org>
To: "AeroGear Developer Mailing List" <aerogear-dev at lists.jboss.org>
Sent: Wednesday, December 17, 2014 1:22:46 PM
Subject: Re: [aerogear-dev] SITE: API Documentation and Specifications

Ahoy my friend, I will add my proposal for security and also change the
guides.

To make it easy I created a branch "newstructure"
https://github.com/aerogear/aerogear.org/commit/ab2b72a28b5485982f1a65919e0263ec43f120b1.

Into this way people can submit pull requests, others review and provide
some input.

On 2014-12-17, Andres Galante wrote:
> I moved things to a gist:
>
> https://gist.github.com/andresgalante/078caebe08b11e259660
>
>
>
> ----- Original Message -----
> From: "Andres Galante" <agalante at redhat.com>
> To: "AeroGear Developer Mailing List" <aerogear-dev at lists.jboss.org>
> Sent: Wednesday, December 17, 2014 12:28:30 PM
> Subject: Re: [aerogear-dev] SITE: API Documentation and Specifications
>
> Bruno if you think thats a better way to display security docs then I am for it!
> Should we do the same for Security guides?
>
> Do you think we should remove sub groups per platforms on the other features also?
>
>
>
> ----- Original Message -----
> From: "Bruno Oliveira" <bruno at abstractj.org>
> To: "AeroGear Developer Mailing List" <aerogear-dev at lists.jboss.org>
> Sent: Wednesday, December 17, 2014 12:03:27 PM
> Subject: Re: [aerogear-dev] SITE: API Documentation and Specifications
>
> Before I do big changes at the document I would like to suggest
> something like this for security:
> https://gist.github.com/abstractj/78bd79b47be666b3b355
>
> The motivation of separate it per functionality/feature is to provide at
> the security user guide an introduction about each topic, gotchas and
> etc.
>
> Thoughts?
>
> On 2014-12-17, Andres Galante wrote:
> > Hi
> >
> > I've done a re arrange of things as i see fit [1]. I am sure its not the correct thing so please make changes here:
> >
> > https://docs.google.com/document/d/1CcYGrKLWzFnEgfR43YSxaHi4DRnf2t2p5qAniCgcVUg/edit?usp=sharing
> >
> > [1] https://github.com/andresgalante/aerogearwebsite/blob/master/docs_structure/feature.markdown
> >
> >
> > ----- Original Message -----
> > From: "Matthias Wessendorf" <matzew at apache.org>
> > To: "AeroGear Developer Mailing List" <aerogear-dev at lists.jboss.org>
> > Sent: Wednesday, December 17, 2014 11:15:38 AM
> > Subject: [aerogear-dev] SITE: API Documentation and Specifications
> >
> > Hi,
> >
> > looking at andresgalante's long and scary list ( https://github.com/andresgalante/aerogearwebsite/blob/master/docs_structure/current.markdown )
> >
> > I think for the "API Documentation and Specifications", we could perhaps break that down into two differrent things:
> >
> > #API Documentations
> >
> > ##Mobile SDK API Documentation (not sure about the name)
> > * AeroGear JS 2.0.0
> > * AeroGear iOS Http v0.1
> > * AeroGear iOS Oauth2 v0.1
> > * AeroGear-Push iOS 1.0.0
> > * AeroGear-OTP iOS 1.0.0
> > * AeroGear-Crypto iOS 0.2.3
> > * AeroGear Android 1.4.0
> > * AeroGear Android Auth 2.0.0-alpha.1
> > * AeroGear Android Authz 2.0.0-alpha.1
> > * AeroGear Android Pipe 2.0.0-alpha.1
> > * AeroGear Android Push 2.0.0-alpha.1
> > * AeroGear Android Security 2.0.0-alpha.1
> > * AeroGear Android Store 2.0.0-alpha.1
> > * AeroGear Cordova (lacks version?)
> >
> > ##Push API Docs
> > * AeroGear UnifiedPush RESTful APIs - stable
> > * AeroGear UnifiedPush RESTful APIs - development
> > * AeroGear UnifiedPush Java Client - Version 1.0.0
> > * AeroGear UnifiedPush Node.js Client (lacks version?)
> > * AeroGear SimplePush Java Client (lacks version?)
> >
> > (yes, I removed some of the items, as I think they are not relevant in here (see earlier email))
> >
> >
> > #Specifications
> >
> > ##Sync Specifications
> > * Client API Proposals
> > * Server API Proposals
> >
> >
> > These will be hopefully soon be gone and we have, similar to 'push' specific API Docs for Sync (client/server)
> >
> >
> > Any thoughts ?
> >
> > -Matthias
> >
> > --
> > 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
>
> --
>
> abstractj
> PGP: 0x84DC9914
> _______________________________________________
> 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

--

abstractj
PGP: 0x84DC9914
_______________________________________________
aerogear-dev mailing list
aerogear-dev at lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev