Hi Yaw,
Fair enough.
We're happy to help with documentation, but we're finding that we can't
really figure out how this stuff is meant to work; so far, we haven't been
able to devise enough to even QC, let alone document. Robust code comments,
test cases, release notes, forum posts, we've been hunting for them all.
We can document precisely what the code does, but that doesn't help us with
QC: if there's a bug or the code is just wrong, we'll just document its
wrongness. Rather, we could help to fix the bug if we knew what the
intended behavior was.
Our theory is that somebody somewhere, before or around the time they
committed and released this, at least had some informal description of the
intended functionality, or perhaps some set of test-case descriptions for
QC. Or perhaps something for some field testers. There must have been
something. Even an email thread. So far, we've found the release notes:
r1062, 2016-10-27
- Adds offline mapping and geoshape/geotrace widgets
- Allison Lieber (Google), Carl Hartung (Nafundi), Jon Nordling
(GeoMarvel), Tanya Bragin (Google), Yaw Anokwa (Nafundi)
And then the Cadasta documentation
https://docs.cadasta.org/en/05-odkcollect.html#geotracing looks promising
(and quite nicely done!). It doesn't cover configuration for offline
mapping, though. Cartong's recent review
http://blog.cartong.org/2017/05/05/benchmarking-mdc-tools-with-strong-gis-component/
likewise
cites the offline-maps set-up as a big question-mark.
If anybody does have something else they could share -- or point us to --
then we could try to continue our QC and documentation efforts, then share
back what we've done.
Otherwise, we'll keep at the reconstructing-from-code-and-experimentation
thing and share whatever we produce (if anything).
Thanks,
Chris
P.S. In terms of process improvement, I might suggest a simple rule: don't
release anything until it's documented in some form. Essentially, basic
documentation becomes part of the release checklist. And if the
documentation is rough or in some ways lacking, others (like us!) can help
to improve it. Alternatively, an easier requirement might be to require
heavily-commented code, so that people could more easily reconstruct
intended behavior and then circle back with documentation. (Apologies if
it's there and we missed it!)
···
On Wed, May 17, 2017, 8:16 PM Yaw Anokwa wrote:
Hi Chris,
One of the challenges we face as a community is documentation. That
challenge manifests in the support burden that you see on this mailing
list.
We're working to put together a process to make things better, but we
are still a month or two out from a good community-based solution.
If folks find value in the code the community is producing, one of the
big ways to give back is by helping with documentation and support.
Until then, your best bet for docs for geoshape/geotrace support is
what you can find on the mailing list and in the source code.
Thanks,
Yaw
On Mon, May 15, 2017 at 2:25 PM, Christopher Robert chrislrobert@gmail.com wrote:
Hi all,
We've ported geoshape and geotrace support into SurveyCTO Collect, but
we're
not 100% confident that we have tested all of the cases that we should.
In
particular, we brought in the support for offline map tiles, but we've
had
trouble finding documentation for how that support is meant to work. Does
anybody have any references they could point me to?
I found this helpful comment in an earlier thread:
If you want offline maps, upgrade to the latest version of ODK Collect
and
in your General Settings, switch your Mapping SDK to OpenStreetMap and
select an appropriate basemap. The OSM SDK will cache your tiles
automatically.
There are other references, in the release notes, to USGS, Stamen, and
CartoDB tiles, and it's clear that the code is meant to support a
variety of
options. It's just not clear where (if anywhere) that stuff is
documented.
Does anybody have, perhaps, even rough notes on how different tiles
should
be installed/configured? Any guidance would be much appreciated.
Thanks,
Chris
--
Post: opendatakit@googlegroups.com
Unsubscribe: opendatakit+unsubscribe@googlegroups.com
Options: http://groups.google.com/group/opendatakit?hl=en
You received this message because you are subscribed to the Google Groups
"ODK Community" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to opendatakit+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
--
Post: opendatakit@googlegroups.com
Unsubscribe: opendatakit+unsubscribe@googlegroups.com
Options: http://groups.google.com/group/opendatakit?hl=en
You received this message because you are subscribed to the Google Groups
"ODK Community" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to opendatakit+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.