Structure Service Ping and Snowplow information into tutorial and guide format
Problem to solve
The Snowplow and Service Ping guides do a good job in explaining the tooling and how to test. These docs would be more informative if the content was more oriented toward providing tutorials and guides on how to use them in specific scenarios.
Proposal
In addition to explaining the tooling, we should include tutorial topics that describe:
- Specific scenarios
- Tool selection
- Implementation
Each tutorial topic should follow the tutorial template and include:
- Description
- Implementation and testing instructions
- A code sample that users can copy-paste and play around with
A great example of this can be seen in the Experiments page.
Who can address the issue
- Engineering:
- Define which tutorials to include.
- Write the tutorial content. To get up to speed on grammar, writing, and topic design, consider taking the GitLab Technical Writing Fundamentals course!
🎓
- Technical Writer: Review and edit content, provide guidance on structure.
Depends on
This issue should be scheduled after #349766 (closed).
Other links/references
Edited by Fiona Neill