farmOS / farmOS-map

farmOS-map is an OpenLayers wrapper library designed for agricultural mapping needs. It can be used in any project that has similar requirements.
https://farmOS.github.io/farmOS-map
MIT License
35 stars 21 forks source link

farmOS-map training/instruction user guide/video #159

Open paul121 opened 2 years ago

paul121 commented 2 years ago

Having some user facing instructions would go a long ways. A simple instruction page that circles icons in red and describes what each does would be useful in itself. A video demonstrating how to use the drawing and editing controls would be even better.

@mstenta @jgaehring This seems like a good candidate to be documentation that we pull into farmOS.org. The distinction being this would be more of a user guide rather than developer docs.

cc @gbathree

paul121 commented 2 years ago

A simple instruction page that circles icons in red and describes what each does would be useful in itself.

Wow, just realizing we have a good start on this here: https://farmos.org/guide/mapping/ Let's get some images on that!!!

Thoughts on if this should be a part of farmOS-map or continue forward with the core farmOS user guide? There is likely benefit in having some language that is specific to farmOS core (asset geometries, asset map layers, etc)

mstenta commented 2 years ago

I think adding to https://farmos.org/guide/mapping/ makes the most sense.

@symbioquine also proposed an idea on the dev call today: include a link to that page inside the farmOS-map sidebar.

The v1 docs had additional animated gifs (mp4s actually iirc) that demonstrated the basic functionality: https://v1.farmos.org/guide/areas/ - I just left those behind when I ported the user guide docs for v2, because they were no longer accurate representations. But I would love to add new ones again!

If we do, it probably makes sense to wait until we've resolved some of the currently open issues/questions around the edit controls - since it seems like those will be changing pretty soon.