Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.

IOS SDK documentation #9

Merged
merged 9 commits into from
Feb 1, 2018
Merged

IOS SDK documentation #9

merged 9 commits into from
Feb 1, 2018

Conversation

wtrocki
Copy link
Contributor

@wtrocki wtrocki commented Jan 30, 2018

Motivation

Provide contributor guide for creating new services for our SDK.
Document will be linked from aerogear documentation when we will have top level contribution guide for service that will include creating APB and also link to android and IOS SDK changes required for service. This will be engineering type docs as opposed to Mobile Developer docs - we going to target community or internal developers who would like to extend Aerogear Services platform.

Having these docs close to the iOS Core SDK repo would be fine e.g. in the main README or some other md file in that repo.
It could eventually end up on aerogear.org under some Contributing area, but that is out of scope for this task.

What was done

  • Extensive end user documentation (generic)
  • SDK service template
  • Script for creating new SDK basing on template (it allows to create up to 64 SDK's per second ;) )
  • Documentation for creating new SDK
  • Diagram and introduction to architecture
  • Short description of the core module
    This will be extended, but since module is still under review I did not want to add more specific details.

Bonus

Documentation for release process with scripts.

Targets

  • Document how service, core is structured
  • What is used to build, publish
  • How to test changes
  • Provide documentation for example.

Note

We are using core-parser branch as base. Once core-parser will be merged this branch will change base to master.

@danielpassos
Copy link
Collaborator

@wtrocki I'm a little confused here, #8 was from your repo this one is from upstream (AeroGear) but point to the core-parser.

I have rebased this branch ios-doc after merge #8 but wanna you double check if I have missed something

@wtrocki wtrocki changed the base branch from core-parser to master January 30, 2018 19:09
@wtrocki
Copy link
Contributor Author

wtrocki commented Jan 30, 2018

@danielpassos I needed to point to upstream in order to hide commits that were not merged to master. Since original PR is now on master I have changed base and it seems that is up to date and fully mergable Thanks for sorting that out.


* iOS 9 or later
* Xcode 9 or later
* [CocoaPods](https://cocoapods.org/)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link in markdown instead of in asciidoc


=== CocoaPods

1) The AeroGear Mobile SDK for iOS is available through [CocoaPods](http://cocoapods.org)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link in markdown instead of in asciidoc

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants