Skip to content
This repository has been archived by the owner on Feb 20, 2023. It is now read-only.

Add docs page for campaigns and data collection by LeanPlum #981

Closed
liuche opened this issue Mar 12, 2019 · 13 comments
Closed

Add docs page for campaigns and data collection by LeanPlum #981

liuche opened this issue Mar 12, 2019 · 13 comments
Assignees
Labels
eng:documentation Documentation for our team processes needs:product P1 Current sprint

Comments

@liuche
Copy link
Contributor

liuche commented Mar 12, 2019

This blocks release to the general user population.

Why/User Benefit/User Problem

We need to be transparent with users what 3rd party tools we're using to collect data, how we're using that data in case they want to know why they are being targeted for campaigns, and document that in a publicly visible place.

Not sure if Marketing would prefer to use a Wiki (which we've used in the past), or if it's too heavyweight to have a docs file that Marketing could push changes to.

What / Requirements

In using a 3rd party data collection tool, we need to clearly document what LeanPlum is, what we are collecting and what campaigns the data would be used in.

Acceptance Criteria (how do I know when I’m done?)

Documentation page w/ explanation of LeanPlum and current marketing campaigns.

┆Issue is synchronized with this Jira Task

@bbinto
Copy link
Contributor

bbinto commented Mar 13, 2019

@st3fan and @boek - based on today's planning, this should be done by an engineer, if not, please let me know who I need to chase.

@bbinto
Copy link
Contributor

bbinto commented Mar 20, 2019

@liuche can you point us to where this has be done for Fennec/Firefox iOS so we can re-purpose.

@liuche
Copy link
Contributor Author

liuche commented Mar 21, 2019

Here are the docs from Firefox iOS on LeanPlum: https://github.com/mozilla-mobile/firefox-ios/blob/master/Docs/MMA.md

And here is the campaigns wiki from Firefox iOS - unfortunately this is very out of date. I had discussed this w/ Maria but I don't think she's had time to work with Marketing to update this, so I'm following up with Maria on that.

@bbinto bbinto self-assigned this Mar 27, 2019
@vesta0 vesta0 added P1 Current sprint and removed P1 Current sprint labels Apr 1, 2019
@liuche
Copy link
Contributor Author

liuche commented Apr 8, 2019

@st3fan I see you're listed as the responsible party for the LeanPlum integration and events it the MVP document - this documentation should also be done as part of the MVP. I can't tell if it's tracked as part of MVP so just wanted to verify that it has the correct labeling.

@bbinto
Copy link
Contributor

bbinto commented Apr 9, 2019

@st3fan and @liuche - assigned to me and will be done before MVP (it's in the MVP blacklog).

Thanks for flagging this.

@bbinto
Copy link
Contributor

bbinto commented Apr 10, 2019

@vesta0 feel free to move this into the next sprint, starting April 11.

@vesta0
Copy link
Collaborator

vesta0 commented Apr 24, 2019

@bbinto I have moved this item to the current sprint.

@bbinto
Copy link
Contributor

bbinto commented Apr 25, 2019

@boek or @colintheshots - I've started this document, but I would need one of you or @st3fan to verify some of the hard coded pieces (I added a note for each section I need a review from the engineer who implemented this)

https://github.com/mozilla-mobile/fenix/blob/master/docs/mma.md

@vesta0
Copy link
Collaborator

vesta0 commented May 18, 2019

@sarentz please verify the hard coded pieces in the LeanPlum documentation: https://github.com/mozilla-mobile/fenix/blob/master/docs/mma.md

@sblatz
Copy link
Contributor

sblatz commented Jun 12, 2019

Is this engineering work? If so is it ready to be worked on?

@vesta0, @sarentz

@liuche
Copy link
Contributor Author

liuche commented Jun 12, 2019

I also see a bunch of events in this LeanPlumMetricsService file, but no documentation of them in MMA.md or telemetry.md. Are they being used?

This probably doesn't require a lot of cleanup, and just a little clarification in the docs, but it's not clear to me what LeanPlum data is being collected.

@liuche
Copy link
Contributor Author

liuche commented Jun 12, 2019

Just want to summarize a discussion that I had with Vesta and Jeff here:

  1. Document the rest of the probes that are currently being collected. I believe these are:
  • E_ADD_BOOKMARK
  • E_OPENED_BOOKMARK
  • E_REMOVED_BOOKMARK
  • E_OPENED_APP
  • Uninstall (which might just be automatic)
  1. Continue adding probes from the MVP list

I will send out an update for Data Steward sign-off, but since I'm going on PTO I will find another data steward to make sure 2 is properly documented.

boek added a commit to boek/fenix that referenced this issue Jun 13, 2019
boek added a commit to boek/fenix that referenced this issue Jun 13, 2019
boek added a commit to boek/fenix that referenced this issue Jun 14, 2019
boek added a commit to boek/fenix that referenced this issue Jun 14, 2019
boek added a commit to boek/fenix that referenced this issue Jun 14, 2019
boek added a commit to boek/fenix that referenced this issue Jun 14, 2019
boek added a commit to boek/fenix that referenced this issue Jun 14, 2019
@boek boek self-assigned this Jun 14, 2019
boek added a commit that referenced this issue Jun 14, 2019
boek added a commit that referenced this issue Jun 14, 2019
@mmccorks
Copy link

All Leanplum events have corresponding entries in https://github.com/mozilla-mobile/fenix/blob/master/docs/mma.md

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
eng:documentation Documentation for our team processes needs:product P1 Current sprint
Projects
None yet
Development

No branches or pull requests

9 participants