hotosm / osm-fieldwork

Processing field data from ODK to OpenStreetMap format, and other field data collection utils.
GNU Affero General Public License v3.0
16 stars 77 forks source link

Create tutorial for osm-fieldwork #101

Open robsavoye opened 1 year ago

robsavoye commented 1 year ago

Create a tutorial on using the osm-fieldwork tools, which are terminal based. Osm-fieldwork is also part of the FMTM project, and handles all communication with ODK Central, and converts ODK data files into OSM XML. There is also some background information here: https://www.senecass.com/projects/Mapping/tech/.

Ndacyayisenga-droid commented 1 year ago

@robsavoye can I please work on this?

Ndacyayisenga-droid commented 1 year ago

@robsavoye where should the location of the tutorial be please ?

robsavoye commented 1 year ago

It would in in the docs subdirectory, and be in Markdown format. Most of the programs when run standalone have a poor UI, mostly it was for debugging. I'm about to do some updates there soon though. So any documentation would occasionally need to be updated. This is a "work in progress" type of project at this stage. Ideally a tutorial would include relevant information from the short articles on that web page, but be presented in a better way. Odkconvert is the core deep tech part of the FMTM project.

Ndacyayisenga-droid commented 1 year ago

Thanks @robsavoye for the comprehensive explanation. Am on it. Am going to checkout for resources and generate its documentation ASAP for review

robsavoye commented 1 year ago

I'm about to be offline for the next 3 days (long flight), so no rush.

Ndacyayisenga-droid commented 1 year ago

@robsavoye cool and safe travels.

Ndacyayisenga-droid commented 1 year ago

here is a PR for this issue https://github.com/hotosm/odkconvert/pull/59

robsavoye commented 1 year ago

I'm doing an hour long workshop at SOTM-US, June 9, 2023 on this project. It should be recorded, and will be a useful resources towards the tutorial.

ErNehaSharma commented 6 months ago

hello sir I have one doubt releted to this issue? actually I want this question just for confirmation that you want tutorial in video format or blog format. like you provided us pdf or html format. that's why I'm asking?

robsavoye commented 6 months ago

I was thinking in Markdown format. I've got some old blog posts about using it in the field here" https://www.senecass.com/projects/Mapping/tech/.

ErNehaSharma commented 6 months ago

Tech Articles

These are a few documents I've written recently about field mapping for OpenStreetMap (OSM), primarily using OpenDataKit (ODK). I've used ODK for years, and HOT is also a very heavy user of ODK. I've been heavily into field mapping for emergency response on my own time for many years, so often test my tech ideas with my own mapping projects. My presentation at SOTM-US 2022 on "OSM For Firefighting" discusses this project, but only briefly mentions the tech behind it. These documents are more about the tech details that support the project. Luckily HOT pays me to make the tech part work better.

The ODK to OSM conversion software I'm working on, and the slowly growing library of XLSForms is here: ODK Convert. This is a work in progress, everyone is welcome to contribute.

Back to the top

ErNehaSharma commented 6 months ago

Here is your Markdwon format blog if any updates you want please let me know sir I also provide you markdown format code. Tech Article.txt

thankyou sir

robsavoye commented 6 months ago

the source for the blog posts, other than the index, is in markdown. I use pandoc to then generate HTML or PDF. Those were mostly written when I was testing osm-fieldwork in the field. I have tons more pictures if you want some color.

ErNehaSharma commented 6 months ago

okay, Is there any updates you want to I do in this format? or want another solution for this?

ErNehaSharma commented 6 months ago

hello sir can you help me for PR or MR? actually I recently done PR but I'm not understand that how I'm able to merge it, can you help me please relate this this?

robsavoye commented 6 months ago

Only Sam or I can approve a PR and merge it, so don't worry about it. I don't see any actual tutorial in the PR to review.

ErNehaSharma commented 6 months ago

O ok thankyou sir for confirmation.