1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-12-01 23:12:29 +02:00

Update README and documentation to better communicate pre-GA state (#1281)

* Update README

Move project status to top of project documentation and add explicit
warnings that this project may introduce breaking changes.

* Add disclaimer to public packages docs

* Use explicit warning in README
This commit is contained in:
Tyler Yahn
2020-10-29 09:23:13 -07:00
committed by GitHub
parent 23e32b19ec
commit 034195692a
19 changed files with 103 additions and 24 deletions

4
doc.go
View File

@@ -15,6 +15,10 @@
/*
Package otel provides an implementation of the OpenTelemetry API.
This package is currently in a pre-GA phase. Backwards incompatible changes
may be introduced in subsequent minor version releases as we work to track the
evolving OpenTelemetry specification and user feedback.
The provided API is used to instrument code and measure data about that code's
performance and operation. The measured data, by default, is not processed or
transmitted anywhere. An implementation of the OpenTelemetry SDK, like the