Closed Bug 1013672 Opened 10 years ago Closed 10 years ago

Update UI Telemetry docs to match TelemetryContract.

Categories

(Firefox for Android Graveyard :: General, defect)

ARM
Android
defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED
Firefox 33

People

(Reporter: liuche, Assigned: mfinkle)

References

Details

(Whiteboard: [mentor=liuche][good-first-bug])

Currently, the Method and Session sections of the UI Telemetry docs (mobile/android/base/docs/index.rst) are out of date, and need to be updated (mobile/android/base/TelemetryContract.java).
Whiteboard: [mentor=liuche][good-first-bug]
Is there a wiki for cloning the source? I haven't read the .rst files. Is there any guideline for Mozilla documenation?
Hi Jasper, take a look at our wiki page for getting set up: https://wiki.mozilla.org/Mobile/Fennec/Android It's a great step-by-step manual for getting started with our code base. (Once you get through the build tools setup, you'll get to a section called "Getting the source" that has the hg command to clone our repository - but to do that, you need to have hg installed, and to actually do anything to the code, you'll need the build tools.)
As for the .rst files, they're in the tree (at mobile/android/base/documentation/index.rst) and there's enough existing documentation that I think you'll be able to just match the style easily.
Once you get a build working, to be more specific: TelemetryContract.java holds the in-code version of our UITelemetry nomenclature. These are organized into Events, Methods, and Sessions. We also want to have these in our UITelemetry documentation (mobile/android/base/docs/index.rst), so this bug is for reflecting the items and comments in TelemetryContract into index.rst. You don't need to know the documentation style because the comments in-code are good enough to use.
Hi Jasper, are you actively working on this bug? I'm thinking about wrapping it up if you are no longer interested.
Flags: needinfo?(jasperchow)
Sorry of the delay. I was having some problem with the environment setup over the weekend and has been busy since then. Please don't let me block you. I can find other first-time bug to fix once I have environment ready. thanks you very much.
Flags: needinfo?(jasperchow)
FIXED in bug 1007215
Status: NEW → RESOLVED
Closed: 10 years ago
Resolution: --- → FIXED
Assignee: nobody → mark.finkle
Depends on: 1007215
Target Milestone: --- → Firefox 33
Product: Firefox for Android → Firefox for Android Graveyard
You need to log in before you can comment on or make changes to this bug.