Skip to content

Instantly share code, notes, and snippets.

@andresgalante
Last active August 29, 2015 14:11
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save andresgalante/078caebe08b11e259660 to your computer and use it in GitHub Desktop.
Save andresgalante/078caebe08b11e259660 to your computer and use it in GitHub Desktop.
suggested new structure for aerogear.org docs, guides, demos and roadmaps

Documentation

API Documentation and Specifications

  • AerogearCore Specifications
    • Android
      • AeroGear Android 1.4.0
      • AeroGear Android Pipe 2.0.0-alpha.1
      • AeroGear Android Store 2.0.0-alpha.1
    • JS
      • AeroGear JS 2.0.0 *iOS
      • AeroGear iOS Http v0.1
    • Cordova
      • AeroGear Cordova
  • AerogearSecurity Specifications
    • Android
      • AeroGear Android Auth 2.0.0-alpha.1
      • AeroGear Android Authz 2.0.0-alpha.1
      • AeroGear Android Security 2.0.0-alpha.1
    • iOS
      • AeroGear iOS Oauth2 v0.1
      • AeroGear-OTP iOS 1.0.0
    • don't know
      • AeroGear-Crypto iOS 0.2.3
      • AeroGear Security Crypto
  • AerogearPush Specifications
    • Android
      • AeroGear Android Push 2.0.0-alpha.1 *iOS
      • AeroGear-Push iOS 1.0.0
    • don't know
      • AeroGear UnifiedPush RESTful APIs - stable
      • AeroGear UnifiedPush RESTful APIs - development
      • AeroGear UnifiedPush Java Client - Version 1.0.0
      • AeroGear UnifiedPush Node.js Client
      • AeroGear SimplePush Java Client
  • AerogearSync Specifications
    • don't know
      • Data Sync Specification
        • Client API Proposals
        • Server API Proposals

Road Map

What are the changes here?

  • AeroGear Project Roadmap
  • Subproject Roadmaps
    • Android
    • Cordova
    • iOS
    • JavaScript
    • Security
    • Web site
    • AeroGear Push
      • SimplePush
      • UnifiedPush
      • WebPush

Get started

###Guides

  • AeroGear Browser Support Targets
  • FAQ
  • AerogearCore Guides
    • Android
      • How to build AeroGear Android library
      • Pipe
      • Pagination
      • Store
    • iOS 1.X
      • Get Started with iOS and Xcode
      • Get Started with iOS and AeroGear Xcode Template
      • Pipe and Pipeline
      • Pagination
      • Store and DataManager
    • Js
      • Get Started With AeroGear.js
    • HTML5
      • Get Started With HTML5 Mobile Web Development
      • HTML5 Mobile Quickstart & Archetype Deep Dive
      • HTML5 + REST Applications
      • Deploying HTML5 Applications to Openshift
    • Cordova
      • Get Started with Hybrid Application Frameworks
      • Cordova Setup
      • Converting an AeroGear HTML5 + REST Web App to a Hybrid App with Apache Cordova
      • Tutorial: Android Development w/ PhoneGap/Apache Cordova in JBoss Developer Studio 5
  • AerogearSecurity Guides
    • Android
      • Authentication
      • Authorization
    • iOS 1.X
      • Authentication and User enrollment
      • Authorization (OAuth2)
      • Cryptography support
    • iOS 2.X
      • Authorization (OAuth2)
    • Cordova
      • AeroGear Two-Factor Authentication with OTP
      • AeroGear Two-Factor Authentication with OTP as Cordova Plugin
  • AerogearPush Guides
    • AeroGear UnifiedPush Server resources
      • UnifiedPush Server guides
        • UnifiedPush Server User Guide
        • Push Notification Message Format
        • Client Registration details
      • Client guides
        • AeroGear Cordova PushPlugin
      • Tutorials
        • Tutorial: Android Push Notifications
        • Tutorial: iOS Push Notifications
        • Tutorial: JavaScript Push Notifications
        • Tutorial: Windows Push Notifications
        • Tutorial: Chrome Packaged Apps Push Notifications
        • Getting Started with the Java Sender API
      • Troubleshooting
        • Android
        • Cordova
        • iOS
      • API documentation
        • UnifiedPush Server: RESTful API (stable)
        • UnifiedPush Server: RESTful API (development)
        • UnifiedPush Java Client
        • UnifiedPush Node.js Client
  • Presentations about AeroGear
    • Android
      • AeroGear Android 1.0.0
      • AeroGear Android - The mobile developer’s utility belt
      • Let’s Build a Modern Android App

Examples and Demos

  • Demos apps
    • Android
      • Cookbook
      • AeroDoc
      • Crypto Demo
      • OTP Demo
    • iOS
      • Cookbook
      • AeroDoc
      • Crypto Demo
      • OTP Demo
      • Cookbook
      • Backend Cookbook Shoot: OAuth2 demo with Google, Facebook and Keycloak
      • Cookbook/Buddies and Cookbook/Weather to demo http module usage
    • JavaScript
      • AS QuickStart
      • Running Demo
  • Projects using AeroGear
    • Android
      • call4paperz4android
      • AGReddit
      • DevNexus Android App (Google Play Link)

Community

  • Contributing to AeroGear
    • Contributing to AeroGear
    • AeroGear GitHub Workflow
    • How to Handle AeroGear Pull Requests
    • AeroGear JIRA Usage and Guidelines
    • AeroGear Licensing and Copyright
    • AeroGear Developer Tools Guide
    • AeroGear Versioning Policy
@matzew
Copy link

matzew commented Dec 17, 2014

Let's have the API docs, on a central page ?

like:

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?)

@matzew
Copy link

matzew commented Dec 17, 2014

on that page, we can group (e.g iOS/ android) - but lets not add toooooo many sub pages for api diocs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment