apisense / docs

Technical documentation of the APISENSE® crowdsensing platform

APISENSE® Technical Documentation

Requirements

This documentation is running on top of Jekyll. Install it.

gem install jekyll

Additionnaly it uses Rouge which is a code snippets highlighter. Install it.

gem install rouge

Note: Github only supports pygments, rouge is no longer used.

How to run

Github doesn't allow to run custom plugin directly. Using Travis we can build on the branch master everything. All you've to do is to merge _site from master into gh-pages.

How to run

By default the server is running on port 4000, you can change its configuration in the _config.yml file and then run it !

jekyll serve

docs's Issues

Strange date definition

I don't know if it's just a bad example or an implementation problem but the point of using am/pm format for date is to use [0:12] interval for hours.

But we can find in the documentation something like "13:37 PM" which makes no sense to me.

Might need some investigations.

var location can't be used

location is a reserved keyword in javascript from a browser point of view.
We should point this out and change the example variable name in the location sting documentation

Update documentation for Android SDK

Installation sample can be simplified with new methods.

Also start method takes a crop, not an identifier and the callback is of Crop instead of Void.

Add crop script samples and explanation on their behavior

The users are a bit lost while starting with the technology so we should add some simple and not-that-simple scripts with examples on how to collect significant data.

Wrong method name datePicker in Form Sting

datePicker -> datepicker in samples and documentation

[GitHub] Automatic update of the online documentation

Add a GitHub hook to automatically update the online documentation.

error in documentation samples

In every sample of the documentation is written timer.sync() instead of recorder.sync()

Update iOS documentation based on SDK refactor

English word for French 'collecte'

Dear authors,

The documentation uses the term 'collect' as a noun in sentences such as

 "the collect installed on your mobile applications from the web dashboard"

I guess this is a rough translation the French noun 'collecte'. However the meaning of 'collect' in English is related to a prayer. See https://en.wiktionary.org/wiki/collect#Noun

I suggest to use instead terms such as crowdsensing script, or data collection script (in contrast to collect, collection is correct with the meaning that I guess you want to convey), or if you want to go for a shorter version, script.

Lionel.

Update SDK Sample

The API slightly changed (regarding login for example), The code sample has to be updated on the Android SDK guide page.

Handle Runtime permissions#start() => sdk became apisenseSdk

Missing documentation

Currently the documentation does not provide description:

• of the JSON parameter for LocationSting::onLocationChanged.