Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation #104

Merged
merged 17 commits into from
Nov 28, 2019
Merged

Add documentation #104

merged 17 commits into from
Nov 28, 2019

Conversation

nivemaham
Copy link
Collaborator

@nivemaham nivemaham commented Oct 29, 2019 •
edited
Loading

Adds documentation about the application and how to configure it

Fixes #90

@nivemaham nivemaham changed the title WIP: Add documentation Add documentation Oct 30, 2019
@nivemaham nivemaham requested a review from blootsvoets October 30, 2019 17:54
blootsvoets
blootsvoets reviewed Oct 30, 2019
View reviewed changes
Copy link
Contributor

@blootsvoets blootsvoets left a comment

Choose a reason for hiding this comment

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

LGTM

README.md Outdated
- "android_phone_acceleration"
contentTypes: # content types of the data
- "application/zip"
timeRequired: false # if the data is large or if uploading data would require a lot of time mention this to true.
Copy link
Contributor

Choose a reason for hiding this comment

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

This field was meant to indicate whether the user should supply a date-time for the upload, that is, that the uploaded content does not contain the relevant timestamp.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh I see. That makes sense. I will change it

@nivemaham nivemaham requested a review from blootsvoets October 31, 2019 12:50
@blootsvoets
Copy link
Contributor

Could you please create PNG images instead of BMP?

I was thinking that the end-user documentation should be created in the radar-base.org wiki (#90) and the technical information be listed here (#81).

@nivemaham
Copy link
Collaborator Author

@blootsvoets I have moved the end-user documentation to radar-base.org. It will take me a lot of time to detailed documentation for all three components. ;) . I think I have to stop with the documentation writing for now.
I think we can't run these components without the docker-compose or at least some services from the docker-compose. So I focused on how to get the stack running. I agree more documentation on how to create a converter is necessary.

@nivemaham
Copy link
Collaborator Author

@blootsvoets Can we proceed with this now and come back to the developer documents later.

@nivemaham nivemaham merged commit 7ddd486 into dev Nov 28, 2019
@blootsvoets blootsvoets deleted the add-documentation branch December 9, 2019 14:39
blootsvoets pushed a commit that referenced this pull request Dec 31, 2019
@nivemaham
Merge pull request #104 from RADAR-base/add-documentation
497c14c 
Add documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blootsvoets blootsvoets blootsvoets approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nivemaham @blootsvoets