Improve Product Analytics guide / documentation
Background
As Product Analytics features got improved corresponding documentation and guide pages got loaded with a lot of information, that refers to multiple aspect of ~"product analytics" owned features. This situation makes it hard for user to locate and understand important parts that will help them navigate onto how instrument their features, and how perform analysis of collected metrics
- https://about.gitlab.com/handbook/product/product-analytics-guide/
- https://docs.gitlab.com/ee/development/product_analytics/usage_ping.html
- https://docs.gitlab.com/ee/development/product_analytics/snowplow.html
Opportunities to improve
Extract more specialized pages:
-
Quick start (high abstraction level) instrumentation guide - we lack a page that will seamlessly guide developers and PM onto which product analytics tool use and how, having flowchart diagram that will help them decide if they want to use usage ping or snowplow, weekly or monthly time frames etc, will be nice addition -
Usage Ping instrumentation guide - high level overview that will guide onto how instrument metric using Usage Ping eg: should one use Redis counter, should one use batch counter etc. Again having flowchart may be a good idea -
Usage Ping implementation guides for each type of instrumentation inc: Database batch counter, Redis counters etc. -
Usage Ping maintenance - information about versioning, and handling existing metrics (moving, deleting etc) -
And more please add your ideas 🙏🏻
Related MRs
- Move Metric life cycle docs in a separate page !67968 (merged)
Edited by Alina Mihaila