Edit structure of the Snowplow documentation
Problem to solve
The Snowplow documentation currently uses several cross-reference techniques which go against the GitLab conventions:
- Manual table of contents on the Snowplow page
- "More useful links" section is at the top, but should be moved to the bottom, if it's to remain.
Further issues noted by Suzanne in a review of an MR:
You're sending them elsewhere before you get into the content of the doc. Not knowing what Snowplow was, I was a little confused. Maybe these telemetry links can go elsewhere? (Sadly I have no good suggestions. Maybe at the end of the "What is Snowplow" topic?)
(You could even get rid of the "What is Snowplow" title completely, even, since I'm assuming this doc is going to tell me what it is... That way you can delete the self-referential phrase "This guide provides an overview of how Snowplow works, and implementation details.")
The whole doc is written as "we" and "our" and sometime it would be good to make it more generic and customer-focused. Simple example:
Snowplow is an enterprise-grade marketing and product analytics platform which helps track the way users engage with our website and application.
Could be:
Snowplow is an enterprise-grade marketing and product analytics platform that tracks how you (or how users) engage with the GitLab website and application.
Further details
N/A
Proposal
Edit the document's content and structure to resolve the issues noted here in the issue's description.
Who can address the issue
Technical writer
Other links/references
N/A