Restructure Analytics Instrumentation Documentation
Goal
Restructure Analytics Instrumentation Documentation to make it simpler, easy to use and flexible for new additions
Users
- Internal Gitlab Team members (PMs/EMs) who are looking to instrument their apps, track metrics, look in the documentation if there are already existing event they could track.
- Analytics Instrumentation Team Members (PMs/EMs) who are looking to get an understanding of how things are built at the backend
- External Gitlab users
Ideas
Seems like the most likely landing page for product managers/ engineers looking to instrument their applications is https://about.gitlab.com/handbook/business-technology/data-team/programs/data-for-product-managers/#how-to-consume-data-at-gitlab
Handbook design
Product > product handbook > analytics instrumentation
The main analytics instrumentation page will house our vision, direction and development process( combine content from our current directions page and development process page). The page will also have links to Docs for
- Analytics Instrumentation Guide ( Are you looking to instrument your Gitlab feature and track metrics related to health of your new feature? Refer our Analytics Instrumentation Guide) Target user group: Gitlab internal team members
- Analytics Instrumentation System Overview ( Are you looking to understand the architecture and technical details of the existing system? Take a look at the Analytics Instrumentation System Overview) Target user group: The Analytics Instrumentation group
- Analytics Instrumentation Guide for External Gitlab Users ( Are you looking to instrument your application to track metrics? Take a look at the Analytics Instrumentation Guide for external Gitlab Users ) Target user group: External Users. Linked issue
Analytics Instrumentation Guide and Analytics Instrumentation System Overview (Docs)
New System
Proposed Path: Docs>Contribute to Gitlab>Feature development>Internal Analytics>Internal Event Tracking API
- Overview of the new unified tracking API
- Video and documentation: using the generator to instrument feature and track metrics
- Current limitations
- Architecture
- Legacy system ( will link to old documentation related service ping and snowplow method of tracking)
Old System
Proposed Path: Docs>Contribute to Gitlab>Feature development>Internal Analytics>Legacy Internal Event Tracking System
Analytics Instrumentation Guide for external Gitlab Users (Docs)
Proposed Path: Docs> Use Gitlab > Monitor application performance> Tracking SDKs (related issue)
Lang SDK's - Javascript Browser SDK - Node.js SDK - Ruby SDK - Python SDK - .net SDK - More SDK's coming soon