Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Analytics addition to readme #987

Merged
merged 13 commits into from
Aug 13, 2020
Merged

Conversation

Sloox
Copy link
Contributor

@Sloox Sloox commented Aug 12, 2020

Fixes #973

Checklist

  • Documented
  • release_notes.md updated

docs/readme.md Outdated Show resolved Hide resolved
docs/analytics.md Outdated Show resolved Hide resolved
docs/analytics.md Outdated Show resolved Hide resolved
Copy link
Contributor

@bootstraponline bootstraponline left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As an end user, I want to understand what analytics Flank sends and how to control them so I can make good decisions for my business.

The user story asks for:

  • What analytics Flank sends
  • How to disable them

The current pull request does a great job describing that Flank integrate with bugsnag and how to opt out of analytics. We also want to include detailed information about what specifically Flank sends to bugsnag.

There might be documentation from the bugsnag website that explains what's connected in more detail. Alternatively, we could reference the Flank bugsnag and use that to understand the types of data being collected in crash reports.

docs/analytics.md Outdated Show resolved Hide resolved
@Sloox Sloox changed the title Analytics addition to readme docs: Analytics addition to readme Aug 12, 2020
@bootstraponline
Copy link
Contributor

@Sloox I made a bunch of edits 😁 I think this looks good now!

@piotradamczyk5 piotradamczyk5 self-requested a review August 13, 2020 07:16
@Sloox Sloox requested a review from bootstraponline August 13, 2020 09:06
@Sloox Sloox merged commit 824eea3 into master Aug 13, 2020
@Sloox Sloox deleted the #973-analytics-addition-to-readme branch August 13, 2020 10:06
pgreze pushed a commit to mercari/flank that referenced this pull request Aug 17, 2020
* Added inital analytics template for team review

* Added analytics.md file

* Re-worked the wording as per discussion

* Release notes updated

* Fixes to wording, typos and recommendations as per pull request

* Update and rename analytics.md to error_monitoring.md

* Update README.md

* Update error_monitoring.md

* Update README.md

* Update error_monitoring.md

* Update error_monitoring.md

* Update release_notes.md

* Update README.md

Co-authored-by: Michael Wright <[email protected]>
Co-authored-by: bootstraponline <[email protected]>
pgreze added a commit to mercari/flank that referenced this pull request Aug 17, 2020
* docs: Analytics addition to readme (Flank#987)

* Added inital analytics template for team review

* Added analytics.md file

* Re-worked the wording as per discussion

* Release notes updated

* Fixes to wording, typos and recommendations as per pull request

* Update and rename analytics.md to error_monitoring.md

* Update README.md

* Update error_monitoring.md

* Update README.md

* Update error_monitoring.md

* Update error_monitoring.md

* Update release_notes.md

* Update README.md

Co-authored-by: Michael Wright <[email protected]>
Co-authored-by: bootstraponline <[email protected]>

* Add filter_qa support in test-targets

Co-authored-by: Michael Wright <[email protected]>
Co-authored-by: Michael Wright <[email protected]>
Co-authored-by: bootstraponline <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add analytics-uuid/Bugsnag to README
4 participants