Bug 1397184 - Add MMA doc to index. r=liuche
authorNevin Chen <cnevinchen@gmail.com>
Wed, 06 Sep 2017 16:48:12 +0800
changeset 429096 3781d3cf10ffdea9447866301d69a7817cb907d0
parent 429095 f7475262b1cfe886391d2affc7bf9fef8e1cfea6
child 429097 dd75dcec7da162d8ceaaf0883e0e7561bd772992
push id7761
push userjlund@mozilla.com
push dateFri, 15 Sep 2017 00:19:52 +0000
treeherdermozilla-beta@c38455951db4 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersliuche
bugs1397184
milestone57.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1397184 - Add MMA doc to index. r=liuche MozReview-Commit-ID: FyO2E35p4rF
mobile/android/app/local.properties
mobile/android/docs/index.rst
mobile/android/docs/mma.rst
new file mode 100644
--- /dev/null
+++ b/mobile/android/app/local.properties
@@ -0,0 +1,2 @@
+# DO NOT check this file into source control.
+sdk.dir=/Users/nechen/.android-sdk
--- a/mobile/android/docs/index.rst
+++ b/mobile/android/docs/index.rst
@@ -11,16 +11,17 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
    localeswitching
    uitelemetry
    activitystreamtelemetry
    downloadcontenttelemetry
    adjust
+   mma
    defaultdomains
    bouncer
    shutdown
    push
 
 Indices and tables
 ==================
 
--- a/mobile/android/docs/mma.rst
+++ b/mobile/android/docs/mma.rst
@@ -28,28 +28,28 @@ Who will have Leanplum enabled?
 * We use Switchboard https://wiki.mozilla.org/Firefox/Kinto to filter users to have Leanplum enabled. Currently, for users in the USA
   and whose locale is set to English, 10% of that users will have Leanplum enabled.
 * If the user has "Health Report" setting enabled.
 * If above two are true, when the app starts, and switchboard configure arrived, Fennec will send the
   triggers and message interaction history to Leanplum server when available.
 
 
 Where does data sent to the Leanplum backend go?
-==============================================
+======================================================
 
 The Leanplum SDK is hard-coded to send data to the endpoint https://www.leanplum.com.  The endpoint is
 defined by ``com.leanplum.internal.Constants.API_HOST_NAME`` at
 https://searchfox.org/mozilla-central/rev/c49a70b53f67dd5550eec8a08793805f2aca8d42/mobile/android/thirdparty/com/leanplum/internal/Constants.java#32.
 
 The user is identified by Leanplum using a random UUID generated by Fennec when Leanplum is initialized for the first time.
 This unique identifier is only used by Leanplum and can't be tracked back to any Firefox users.
 
 
 What data is collected and sent to the Leanplum backend?
-======================================================
+==========================================================
 
 The Leanplum SDK collects and sends two messages to the Leanplum backend.  The messages have the
 following parameters::
 
   // Sent every time when an event is triggered
   "action" -> "track"                   // track: an event is tracked.
   "event" -> "Launch"                   // Used when an event is triggered. e.g. E_Saved_Bookmark.
   "info" -> ""                          // Used when an event is triggered. Basic context associated with the event.
@@ -185,37 +185,37 @@ This token is only useful to Mozilla's s
 Push Notifications can be triggered by Events, or be sent by Mozilla marketing team manually.
 
 The list of current messages for Android can be found here: https://wiki.mozilla.org/Leanplum_Contextual_Hints#Android
 
 Technical notes
 ~~~~~~~~~~~~~~~
 
 Build flags controlling the Leanplum SDK integration
-==================================================
+======================================================
 
 To test this locally, add lines like:
 
 export MOZ_ANDROID_MMA=1
 ac_add_options --with-leanplum-sdk-keyfile=/path/to/leanplum-sdk-developer.token
 
 MOZ_ANDROID_MMA depends on MOZ_NATIVE_DEVICES and MOZ_ANDROID_GCM.
 Since Leanplum requires Google Play Services library, those flags are a proxy for it, and enable respectively.
 
 We want to enable MOZ_ANDROID_MMA in Nightly, but only for
 MOZILLA_OFFICIAL builds.  Since MOZILLA_OFFICIAL is still defined in
 old-configure.in, we can't integrate it in
 mobile/android/moz.configure, and therefore we enable using the
 automation mozconfigs.
 
 Technical notes on the Leanplum SDK integration
-=============================================
+================================================
 
 Just like Adjust, MmaDelegate uses mmaInterface to inject the MmaLeanplumImp and MmaStubImp.
 Constants used by Leanplum is in MmaConstants. Services in AndroidManifest are in
 ``mobile/android/base/MmaAndroidManifest_services.xml.in`` which is also injected by build flag
 MOZ_ANDROID_MMA.
 
 Notes and links
-===============
+=================
 
 * Leanplum web page: http://leanplum.com/
 * Leanplum SDK github repo: https://github.com/Leanplum/Leanplum-Android-SDK