1377022 - Refine the document for Leanplum

Status: RESOLVED FIXED

(Firefox for Android Graveyard :: Metrics, enhancement)

Description

[Nevin Chen(Not active on Bugzilla)]

After discussion with Chenxia, I want to refine the document after 1373174 has landed.

Comment 1

[Nevin Chen(Not active on Bugzilla)]

Attachment: Bug 1377022 - Refine MMA/Leanplum document.

Review commit: https://reviewboard.mozilla.org/r/153352/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/153352/

Comment 2

[Nevin Chen(Not active on Bugzilla)]

Comment on attachment 8882255 [details]
Bug 1377022 - Refine MMA/Leanplum document.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/153352/diff/1-2/

Comment 3

[Nevin Chen(Not active on Bugzilla)]

Attachment: Bug 1377022 - Remove revisit Leanplum event.

Review commit: https://reviewboard.mozilla.org/r/153450/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/153450/

Comment 4

[Nevin Chen(Not active on Bugzilla)]

Attachment: Bug 1377022 - rename track() to event().

Review commit: https://reviewboard.mozilla.org/r/153456/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/153456/

Comment 5

[Max Liu [:maliu]]

Comment on attachment 8882350 [details]
Bug 1377022 - Remove revisit Leanplum event.

https://reviewboard.mozilla.org/r/153450/#review158636

LGTM

Comment 6

[Max Liu [:maliu]]

Comment on attachment 8882358 [details]
Bug 1377022 - rename track() to event().

https://reviewboard.mozilla.org/r/153456/#review158638

LGTM

Comment 7

[Chenxia Liu [:liuche]]

Comment on attachment 8882255 [details]
Bug 1377022 - Refine MMA/Leanplum document.

https://reviewboard.mozilla.org/r/153352/#review158670

::: mobile/android/docs/mma.rst:60
(Diff revision 2)
> -  "event" -> "Launch"                   // Used when an event is triggered. e.g. SaveBookmark.
> +  "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.
>    "value" -> 0.0                        // Used when an event is triggered. Value of that event.
>    "messageId" -> 5111602214338560       // Used when an event is triggered. The ID of the message.
>  
> -  // User related information
> +  // Sent when the app start

nit: "starts"

::: mobile/android/docs/mma.rst:104
(Diff revision 2)
>  Since Device ID is a random UUID, Leanplum can't map the device to any know Client ID in Fennec nor Advertising ID.
>  
>  Events:
>  Most of the Leanplum events can be mapped to a single combination of Telemetry event (Event+Method+Extra).
>  Some events are not collected in Mozilla Telemetry. This will be addressed separately in each campaign review.
> -List of current Events are :
> +There are three elements will be used for each events. They are: event name, value, and info.

Nit: "three elements that are usef for each event"

::: mobile/android/docs/mma.rst:105
(Diff revision 2)
>  
>  Events:
>  Most of the Leanplum events can be mapped to a single combination of Telemetry event (Event+Method+Extra).
>  Some events are not collected in Mozilla Telemetry. This will be addressed separately in each campaign review.
> -List of current Events are :
> -* Loads articles (reader mode ready)
> +There are three elements will be used for each events. They are: event name, value, and info.
> +Default value for event value is 0.0. Default value for event info is empty string.

Maybe just combine this in the previous sentence for conciseness, e.g.:
value (default: 0.0), info (default: "").

::: mobile/android/docs/mma.rst:107
(Diff revision 2)
>  Most of the Leanplum events can be mapped to a single combination of Telemetry event (Event+Method+Extra).
>  Some events are not collected in Mozilla Telemetry. This will be addressed separately in each campaign review.
> -List of current Events are :
> -* Loads articles (reader mode ready)
> -* Visiting a website (with match to past history) x times
> -* Download videos or any other media (x times)
> +There are three elements will be used for each events. They are: event name, value, and info.
> +Default value for event value is 0.0. Default value for event info is empty string.
> +
> +List of current Events related data they sent:

nit: "related data that is sent"

::: mobile/android/docs/mma.rst:116
(Diff revision 2)
> +}
> +* Download videos or any other media
> +{
> +  "event" : "E_Download_Media_Saved_Image"
> +}
> +* SavePassword (Save password and login)

Nit: just use "Save password and login"

No need to have the SavePassword, since it's inconsistent with the other items.

Also do the same for SaveBookmark, LoadBookmark - make them short descriptions rather than camelcased words.

"Saves a bookmark through menu" or if other places too (like long-press menu), include that too.

"Loads a bookmark from home panel" - generally just try to be specific if it's helpful.

::: mobile/android/docs/mma.rst:140
(Diff revision 2)
> +}
>  
>  Deep Links:
>  Deep links are actions that can point Fennec to open certain pages or load features such as `show bookmark list` or
> -`open a SUMO page`.
> -* Link to Set Default Browser settings
> +`open a SUMO page`. When users see a prompt Leanplum message, they can click the button(s) on it. These buttons often
> +trigger below deep links:

nit: "These buttions can trigger the following deep links"

::: mobile/android/docs/mma.rst:156
(Diff revision 2)
> -* Link to accessibility preferences
> +* Link to notifications preferences (firefox://preferences_notifications)
> +* Link to accessibility preferences (firefox://preferences_accessibility)
>  
>  Messages :
> -Messages are in-app prompts to the user from Leanplum. The interaction of that prompt will be kept and sent ot Leanplum backend.
> -Such as "Accept" and "Show".
> +Messages are in-app prompts to the user from Leanplum. The interaction of that prompt will be kept and sent to Leanplum backend.
> +Such as "Accept" and "Show". Messages is a combination of an Event and a Deep Link. The combinations are downloaded from Leanplum

nit: to Leanplum backend (such as "Accept" and "Show").

::: mobile/android/docs/mma.rst:156
(Diff revision 2)
> -* Link to accessibility preferences
> +* Link to notifications preferences (firefox://preferences_notifications)
> +* Link to accessibility preferences (firefox://preferences_accessibility)
>  
>  Messages :
> -Messages are in-app prompts to the user from Leanplum. The interaction of that prompt will be kept and sent ot Leanplum backend.
> -Such as "Accept" and "Show".
> +Messages are in-app prompts to the user from Leanplum. The interaction of that prompt will be kept and sent to Leanplum backend.
> +Such as "Accept" and "Show". Messages is a combination of an Event and a Deep Link. The combinations are downloaded from Leanplum

Nit: "Messages are"

::: mobile/android/docs/mma.rst:157
(Diff revision 2)
> +* Link to accessibility preferences (firefox://preferences_accessibility)
>  
>  Messages :
> -Messages are in-app prompts to the user from Leanplum. The interaction of that prompt will be kept and sent ot Leanplum backend.
> -Such as "Accept" and "Show".
> -List of current messages are:
> +Messages are in-app prompts to the user from Leanplum. The interaction of that prompt will be kept and sent to Leanplum backend.
> +Such as "Accept" and "Show". Messages is a combination of an Event and a Deep Link. The combinations are downloaded from Leanplum
> +when Leanplum starts. When the criteria meets (set in Leanplum backend, could be when an event happens for certain amount of times,

"when Leanplum starts"
should this be "when Firefox starts"?

nit: "When the criteria is met"

::: mobile/android/docs/mma.rst:157
(Diff revision 2)
> +* Link to accessibility preferences (firefox://preferences_accessibility)
>  
>  Messages :
> -Messages are in-app prompts to the user from Leanplum. The interaction of that prompt will be kept and sent ot Leanplum backend.
> -Such as "Accept" and "Show".
> -List of current messages are:
> +Messages are in-app prompts to the user from Leanplum. The interaction of that prompt will be kept and sent to Leanplum backend.
> +Such as "Accept" and "Show". Messages is a combination of an Event and a Deep Link. The combinations are downloaded from Leanplum
> +when Leanplum starts. When the criteria meets (set in Leanplum backend, could be when an event happens for certain amount of times,

nit: "happens a certain number of times"

Comment 8

[Chenxia Liu [:liuche]]

Comment on attachment 8882255 [details]
Bug 1377022 - Refine MMA/Leanplum document.

https://reviewboard.mozilla.org/r/153352/#review158678

Thank you Nevin! Included some tiny suggestions and typos, but otherwise looks great!

Comment 9

[Nevin Chen(Not active on Bugzilla)]

Comment on attachment 8882255 [details]
Bug 1377022 - Refine MMA/Leanplum document.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/153352/diff/2-3/

Comment 10

[Nevin Chen(Not active on Bugzilla)]

Comment on attachment 8882350 [details]
Bug 1377022 - Remove revisit Leanplum event.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/153450/diff/1-2/

Comment 11

[Nevin Chen(Not active on Bugzilla)]

Comment on attachment 8882358 [details]
Bug 1377022 - rename track() to event().

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/153456/diff/1-2/

Comment 12

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c9c097c7d655
Refine MMA/Leanplum document. r=liuche
https://hg.mozilla.org/integration/autoland/rev/b6813849c63e
Remove revisit Leanplum event. r=maliu
https://hg.mozilla.org/integration/autoland/rev/036f834ff129
rename track() to event(). r=maliu

Comment 13

[Phil Ringnalda (:philor)]

https://hg.mozilla.org/mozilla-central/rev/c9c097c7d655
https://hg.mozilla.org/mozilla-central/rev/b6813849c63e
https://hg.mozilla.org/mozilla-central/rev/036f834ff129

Comment 14

[Elvin Lee [:ellee] (no longer with Mozilla)]

Hi Chenxia, do you know when this will appear on http://firefox-source-docs.mozilla.org/ ?

Thanks!

Comment 15

[Chenxia Liu [:liuche]]

I'm not involved in the migration, but from gps's email [1], it seems like they should be present as soon as they land. If they're still missing, I would flag either gps or gfritzsche about it.

> We now have TaskCluster automation uploading the generated docs whenever they are changed on mozilla-central

[1] https://mail.mozilla.org/pipermail/fx-data-dev/2017-August/000063.html

Comment 16

[Elvin Lee [:ellee] (no longer with Mozilla)]

Looks like it is live, but just not linked from the sidebar or nested inside Fennec doc tree. 

https://firefox-source-docs.mozilla.org/mobile/android/fennec/mma.html

Any chance you can help, gps?

Comment 17

[Gregory Szorc [:gps]]

You need an ``mma`` entry in the "index" file for a document to get listed in an index. Add it at https://hg.mozilla.org/mozilla-central/file/c9c097c7d655/mobile/android/docs/index.rst#l14.

A warning for this is displayed during docs generation at https://treeherder.mozilla.org/logviewer.html#?job_id=128693689&repo=mozilla-central&lineNumber=1094. (Along with a number of other warnings in mma.rst that are worth addressing.)

We should probably make missing index fatal to prevent confusion from things like this. Although I'm not sure if Sphinx has a setting for that out-of-the-box...

Comment 18

[Elvin Lee [:ellee] (no longer with Mozilla)]

NI'ing Nevin so he can hopefully follow up on these issues. :)

Comment 19

[Nevin Chen(Not active on Bugzilla)]

Will fix it in bug 1397184