Bug 1331169 - Fix Android ActivityStream docs. r=gkruglov
authorGeorg Fritzsche <georg.fritzsche@googlemail.com>
Sat, 14 Jan 2017 15:12:29 +0700
changeset 462264 0878ddbf3dd461b10f044a3ec0783a63eeb88355
parent 462263 7feb3cffb4a2a413f19176e09ecb98b3ffe57667
child 462265 d794907ebb1561a92cbeaf0745d7071b6de2b626
push id41683
push userbmo:steffen.wilberg@web.de
push dateMon, 16 Jan 2017 21:50:32 +0000
reviewersgkruglov
bugs1331169
milestone53.0a1
Bug 1331169 - Fix Android ActivityStream docs. r=gkruglov
mobile/android/docs/activitystreamtelemetry.rst
mobile/android/docs/index.rst
--- a/mobile/android/docs/activitystreamtelemetry.rst
+++ b/mobile/android/docs/activitystreamtelemetry.rst
@@ -1,13 +1,14 @@
 .. -*- Mode: rst; fill-column: 80; -*-
 
-==============
+============================
 Activity Stream UI Telemetry
-==============
+============================
+
 Building on top of UI Telemetry, Activity Stream records additional information about events and user context in which they occur.
 The ``extras`` field is used for that purpose; additional information is structured as JSON blobs.
 
 Session
 =======
 Activity Stream events are recorded as part of the "activitystream.1" session.
 
 Global extras
@@ -23,125 +24,135 @@ Top Site interactions
 ---------------------
 Two event types are recorded:
 
 1) User clicked on a Top Site: event="loadurl.1", method="listitem"
 2) User clicked on the menu button: event="show.1", method="contextmenu"
 
 For each event, in addition to global extras, the following information is recorded:
 
-extras: {
-    ...
-    "source_type": "topsites",
-    "source_subtype": "pinned"/"suggested"/"top"
-}
+.. code-block:: js
+
+    extras: {
+        ...
+        "source_type": "topsites",
+        "source_subtype": "pinned"/"suggested"/"top"
+    }
 
 Subtype indicates a reason an item which is being interacted with appeared in the Top Sites:
+
 - "pinned": a pinned top site, specifically a non-positioned "Activity Stream pinned" site
 - "suggested": a suggested top site, one of the default ones displayed when there's not enough browsing history available
 - "top": a frecency-based top site, based on browsing history. Neither "pinned" nor "suggested".
 
 Highlight interactions
 ----------------------
 Two event types are recorded:
 
 1) User clicked on a Highlight: event="loadurl.1", method="listitem"
 2) User clicked on the menu button: event="show.1", method="contextmenu"
 
 For both event types, in addition to global extras, the following information is recorded:
 
-extras: {
-    ...
-    "source_type": "highlights",
-    "source_subtype": "visited"/"bookmarked"
-}
+.. code-block:: js
+
+    extras: {
+        ...
+        "source_type": "highlights",
+        "source_subtype": "visited"/"bookmarked"
+    }
 
 Subtype indicates reason an item being which is being interacted with appeared in the Highlights:
 - "visited": a website has been visited recently
 - "bookmarked": a website has been bookmarked recently
 
 For "loadurl.1" event, the following extra information is also recorded:
 
-extras: {
-    ...
-    "action_position": number, /* 0-based index of a highlight being interacted with */
-    "count": number, /* total number of highlights displayed */
-}
+.. code-block:: js
+
+    extras: {
+        ...
+        "action_position": number, /* 0-based index of a highlight being interacted with */
+        "count": number, /* total number of highlights displayed */
+    }
 
 Context Menu interactions
 -------------------------
 Every interaction with a context menu item is recorded using: event="action.1", method="contextmenu"
 
 For all interactions, in addition to global extras, the following information is recorded:
 
-extras: {
-    ...
-    "item": string, /* name of a menu item */
-    "source_type": "topsites"/"highlights",
-    "source_subtype": string, /* depending on type, one of: "pinned", "suggested", "top", "visited", "bookmarked" */
-}
+.. code-block:: js
+
+    extras: {
+        ...
+        "item": string, /* name of a menu item */
+        "source_type": "topsites"/"highlights",
+        "source_subtype": string, /* depending on type, one of: "pinned", "suggested", "top", "visited", "bookmarked" */
+    }
 
 Possible values for "item" key (names of menu items), in no particular order:
+
 - "share"
 - "add_bookmark"
 - "remove_bookmark"
 - "pin"
 - "unpin"
 - "copy"
 - "homescreen"
 - "newtab" (private tab actions are collapsed into "newtab" telemetry due to our privacy guidelines)
 - "dismiss"
 - "delete"
 
 Full Examples
 =============
 Following examples of events are here to provide a better feel for the overall shape of telemetry data being recorded.
 
 1) User with an active Firefox Account clicked on a menu item for a "visited highlight":
-``
-session="activitystream.1"
-event="show.1"
-method="contextmenu"
-extras="{
-    'fx_account_present': true,
-    'source_type': 'highlights',
-    'source_subtype': 'visited'
-}"
-``
+    ::
+
+        session="activitystream.1"
+        event="show.1"
+        method="contextmenu"
+        extras="{
+            'fx_account_present': true,
+            'source_type': 'highlights',
+            'source_subtype': 'visited'
+        }"
 
 2) User with no active Firefox Account clicked on a second highlight (recent bookmark), with total of 7 highlights being displayed:
-``
-session="activitystream.1"
-event="loadurl.1"
-method="listitem"
-extras="{
-    'fx_account_present': false,
-    'source_type': 'highlights',
-    'source_subtype': 'bookmarked'
-    'action_position': 1,
-    'count': 7
-}"
-``
+    ::
+
+        session="activitystream.1"
+        event="loadurl.1"
+        method="listitem"
+        extras="{
+            'fx_account_present': false,
+            'source_type': 'highlights',
+            'source_subtype': 'bookmarked'
+            'action_position': 1,
+            'count': 7
+        }"
 
 3) User with an active Firefox Account clicked on a pinned top site:
-``
-session="activitystream.1"
-event="loadurl.1"
-method="listitem"
-extras="{
-    'fx_account_present': true,
-    'source_type': 'topsites',
-    'source_subtype': 'pinned'
-}"
-``
+    ::
+
+        session="activitystream.1"
+        event="loadurl.1"
+        method="listitem"
+        extras="{
+            'fx_account_present': true,
+            'source_type': 'topsites',
+            'source_subtype': 'pinned'
+        }"
 
 4) User with an active Firefox Account clicked on a "share" context menu item, which was displayed for a regular top site:
-``
-session="activitystream.1"
-event="action.1"
-method="contextmenu"
-extras="{
-    'fx_account_present': true,
-    'source_type': 'topsites',
-    'source_subtype': 'top',
-    'item': 'share'
-}"
-``
\ No newline at end of file
+    ::
+
+        session="activitystream.1"
+        event="action.1"
+        method="contextmenu"
+        extras="{
+            'fx_account_present': true,
+            'source_type': 'topsites',
+            'source_subtype': 'top',
+            'item': 'share'
+        }"
--- a/mobile/android/docs/index.rst
+++ b/mobile/android/docs/index.rst
@@ -8,16 +8,17 @@ Firefox for Android
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
    localeswitching
    uitelemetry
+   activitystreamtelemetry
    adjust
    defaultdomains
    bouncer
    shutdown
    push
 
 Indices and tables
 ==================