News for hackers. Stuff that matters.
Re:OpenTelemetry by m12k on Thursday September 24, 2020 @03:32AM (#24576231)
With so many people finding things via GitHub, I'd highly recommend also including a single paragraph at the top of the repo readme to explain what it is, rather than expect people to be curious enough to go digging for more info. E.g. you could use the explanation from the website: "OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools."
Re:OpenTelemetry by faichai on Thursday September 24, 2020 @06:09AM (#24577064)
Yeah, particularly for a developer oriented product. GitHub readme is essentially a landing page and should be treated the same way, not assuming any foreknowledge for the reader.