Hey all, In order for UI telemetry to be useful, we need documentation. I don't expect anyone to go trawling through Java code to figure out which events fire when.
Neither do I expect us to successfully keep a wiki page aligned with the state of the code. We all know how that goes! The middle ground is to generate documentation from the source. We have a way to do that, using Sphinx: Bug 939367 (thanks, Greg!). Bug 986719 just landed on fx-team. That bug adds the beginnings of documentation for Fennec itself: mobile/android/base/docs/index.rst This tool uses a plain-test format called reStructured Text. Here's a primer; if you're familiar with wikis, it shouldn't be scary. http://docutils.sourceforge.net/docs/user/rst/quickref.html Please operate under the assumption that documenting UI telemetry events and sessions is *mandatory*: our ability to draw correct inferences depends on understanding the data. Note down when they're fired, when they begin and end, what the extras are, whether those extras are optional, which other events are related, etc. etc. You can generate documentation in your object directory by running ./mach build-docs then take a look: open objdir-droid/docs/html/fennec/index.html I'll be adding a little more to this later today -- I'll take care of migrating the wiki contents that I already wrote. Consider me available for reviews, help, or anything else. Thanks! -R _______________________________________________ mobile-firefox-dev mailing list [email protected] https://mail.mozilla.org/listinfo/mobile-firefox-dev
