Create Get started guide tutorial for Tracking/Analytics
Problem to solve
We currently do a good job at documenting everything that exists in our docs for Snowplow and Service Ping. However, if someone would just start to track something within GitLab, their first idea might not be to go and look for "Snowplow" or "Service Ping".
Our guides explain about tooling but don't give how-to introductions with snippets to get started quickly - like many libraries do.
Proposal
A Get started guide with methods to implement analytics will help users get started with tracking.
The Get started guide will consist of:
- Event based metrics (SaaS only)
- Explain what event based metrics are. For example, what data looks like, example of what can be tracked.
- Example of implementing a new tracking method on
- Frontend
- Backend
- Transactional metrics (SaaS + Self Managed)
- Explain what transactional metrics are. For example, what the data looks like, example what can be tracked.
- Example of implementing a new database metric
- Example of implementing a new Redis metric
For guidance, the writer can use the tutorial template and should adhere to CTRT principles. An example of another how-to in our docs is the Auto-DevOps Get Started Guide.
Exact title of guide is still TBD.
Who can address the issue
- Engineering: Write the content and define which information to include. To get up to speed on grammar, writing, and topic design, consider taking the GitLab Technical Writing Fundamentals course!
🎓 - Technical Writer: Review and edit, provide guidance on info architecture.
Other links/references
Edited by Fiona Neill