#### Goal Restructure Analytics Instrumentation Documentation to make it simpler, easy to use, flexible for new additions and reduce redundancies between the handbook and docs #### **Users** 1. **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. 2. **Analytics Instrumentation Team Members** (PMs/EMs) who are looking to get an understanding of how things are built at the backend 3. **External Gitlab users** #### Handbook Vs [Docs]() - Handbook will house our vision, direction and development process. - Docs will contain - All guidance and reference information on instrumenting applications and tracking events/ metrics - Architecture and other technical details of the system #### Handbook - [Vision and directions page](https://about.gitlab.com/direction/analytics/analytics-instrumentation/) :white_check_mark: Keep - [Development process page](https://about.gitlab.com/handbook/engineering/development/analytics/analytics-instrumentation/) :white_check_mark: Keep - [Getting Started page](https://about.gitlab.com/handbook/product/analytics-instrumentation-guide/getting-started/) :x: Deprecate * [ ] Check if any content there needs to be moved to docs * [ ] Mark as no longer maintained and reference alternate Docs page * [ ] Remove page after a few milestones #### Docs.gitlab.com :new: :rocket: **Internal Event Tracking** Proposed Path: Docs\>Contribute to Gitlab\>Feature development\>Internal Analytics\>Internal Event Tracking - Index page with a high level overview and link to child pages ( similar to [this page](https://docs.gitlab.com/ee/topics/plan_and_track.html)) - Introduction -\> This should include explanations around the difference between Events and Metrics (similar to the [prototype docs](https://about.gitlab.com/handbook/engineering/development/analytics/analytics-instrumentation/event_system_draft.html#gitlab-internal-events-tracking)) as well as a basic overview of the architecture - Quick start -\> Instructions on how to create a new Event / Metric using a generator, should include a video - Event Definition Guide -\> Explanation of all parts of an event definition - Metric Definition Guide -\> Modify [current Metric Definition](https://docs.gitlab.com/ee/development/service_ping/metrics_dictionary.html) and link to existing page - Architecture -\> Detailed architecture and other technical details - FAQ's :no_entry: **Existing Tracking System** [Service Ping Content from Docs](https://docs.gitlab.com/ee/development/service_ping/) :x: Deprecate * [ ] Separate out pages that need to be deprecated * [ ] Pages that need to be retained will be left as is * [ ] Mark as no longer maintained and reference alternate Docs page for pages to be deprecated * [ ] Remove deprecated pages after a few milestones [Snowplow content from Docs](https://docs.gitlab.com/ee/development/snowplow/) :x: Deprecate * [ ] Separate out pages that need to be deprecated * [ ] Mark as no longer maintained and reference alternate Docs page for pages to be deprecated * [ ] Remove deprecated pages after a few milestones :new: :rocket: **Analytics Instrumentation Guide for external Gitlab Users (Docs)** <span dir="">Proposed Path: </span>Docs\> Use Gitlab \> Monitor application performance\> Tracking SDKs ([related issue](https://gitlab.com/gitlab-org/analytics-section/product-analytics/gl-application-sdk-browser/-/issues/27#note_1385696406 "Move Browser SDK documentation to a proper place")) * Overview page with index to each lang SDK * Each Lang SDK will have its own page cc @bastirehm @stkerr @lciutacu