diff --git a/README.md b/README.md
index 0167760573..0cad8e8cd5 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,28 @@
-# OpenTelemetry-Rust
+![OpenTelemetry — An observability framework for cloud-native software.][splash]
+
+[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
+
+# OpenTelemetry Rust
+
+The Rust [OpenTelemetry](https://opentelemetry.io/) implementation.
[](https://crates.io/crates/opentelemetry)
[](https://docs.rs/opentelemetry)
-[](./LICENSE)
+[](./LICENSE)
[](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
[](https://gitter.im/open-telemetry/opentelemetry-rust)
-The Rust [OpenTelemetry](https://opentelemetry.io/) implementation.
+[Website](https://opentelemetry.io/) |
+[Chat](https://gitter.im/open-telemetry/opentelemetry-rust) |
+[Documentation](https://docs.rs/opentelemetry)
+
+## Overview
-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.
+OpenTelemetry is a collection of tools, APIs, and SDKs used to instrument,
+generate, collect, and export telemetry data (metrics, logs, and traces) for
+analysis in order to understand your software's performance and behavior. You
+can export and analyze them using [Prometheus], [Jaeger], and other
+observability tools.
*Compiler support: [requires `rustc` 1.42+][msrv]*
diff --git a/assets/logo-text.png b/assets/logo-text.png
new file mode 100644
index 0000000000..c2cab34686
Binary files /dev/null and b/assets/logo-text.png differ
diff --git a/assets/logo.svg b/assets/logo.svg
new file mode 100644
index 0000000000..e9c931aea3
--- /dev/null
+++ b/assets/logo.svg
@@ -0,0 +1 @@
+
diff --git a/opentelemetry-contrib/README.md b/opentelemetry-contrib/README.md
index 6799f79aed..d28e57bd12 100644
--- a/opentelemetry-contrib/README.md
+++ b/opentelemetry-contrib/README.md
@@ -1,3 +1,27 @@
+![OpenTelemetry — An observability framework for cloud-native software.][splash]
+
+[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
+
# OpenTelemetry Contrib
-Contrib repo for OpenTelemetry Rust implementation.
+Community supported vendor integrations for applications instrumented with [`OpenTelemetry`].
+
+[](https://crates.io/crates/opentelemetry-contrib)
+[](https://docs.rs/opentelemetry-contrib)
+[](./LICENSE)
+[](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+[Documentation](https://docs.rs/opentelemetry-contrib) |
+[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+## Overview
+
+[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
+generate, collect, and export telemetry data (metrics, logs, and traces) for
+analysis in order to understand your software's performance and behavior. This
+crate provides additional propagators and exporters for sending telemetry data
+to vendors like [`Datadog`].
+
+[`Datadog`]: https://www.datadoghq.com/
+[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
diff --git a/opentelemetry-contrib/src/lib.rs b/opentelemetry-contrib/src/lib.rs
index 0cc9471268..505630d15f 100644
--- a/opentelemetry-contrib/src/lib.rs
+++ b/opentelemetry-contrib/src/lib.rs
@@ -14,6 +14,9 @@
unused
)]
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))]
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
+)]
#![cfg_attr(test, deny(warnings))]
#[cfg(feature = "datadog")]
diff --git a/opentelemetry-jaeger/README.md b/opentelemetry-jaeger/README.md
index 4872b2bf62..f570d0c320 100644
--- a/opentelemetry-jaeger/README.md
+++ b/opentelemetry-jaeger/README.md
@@ -1,12 +1,32 @@
+![OpenTelemetry — An observability framework for cloud-native software.][splash]
+
+[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
+
# OpenTelemetry Jaeger
-Collects OpenTelemetry spans and reports them to a given Jaeger `agent` or
-`collector` endpoint. See the [Jaeger Docs] for details about Jaeger and
-deployment information.
+[`Jaeger`] integration for applications instrumented with [`OpenTelemetry`].
+
+[](https://crates.io/crates/opentelemetry-jaeger)
+[](https://docs.rs/opentelemetry-jaeger)
+[](./LICENSE)
+[](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+[Documentation](https://docs.rs/opentelemetry-jaeger) |
+[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+## Overview
+
+[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
+generate, collect, and export telemetry data (metrics, logs, and traces) for
+analysis in order to understand your software's performance and behavior. This
+crate provides a trace pipeline and exporter for sending span information to a
+Jaeger `agent` or `collector` endpoint for processing and visualization.
*Compiler support: [requires `rustc` 1.42+][msrv]*
-[Jaeger Docs]: https://www.jaegertracing.io/docs/
+[`Jaeger`]: https://www.jaegertracing.io/
+[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
[msrv]: #supported-rust-versions
### Quickstart
@@ -35,7 +55,7 @@ fn main() -> Result<(), Box> {
}
```
-
+
## Performance
diff --git a/opentelemetry-jaeger/src/lib.rs b/opentelemetry-jaeger/src/lib.rs
index a57747e138..40374eab23 100644
--- a/opentelemetry-jaeger/src/lib.rs
+++ b/opentelemetry-jaeger/src/lib.rs
@@ -167,6 +167,9 @@
unused
)]
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))]
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
+)]
#![cfg_attr(test, deny(warnings))]
mod agent;
diff --git a/opentelemetry-otlp/README.md b/opentelemetry-otlp/README.md
index 24f419b370..bd78d65287 100644
--- a/opentelemetry-otlp/README.md
+++ b/opentelemetry-otlp/README.md
@@ -1,13 +1,37 @@
+![OpenTelemetry — An observability framework for cloud-native software.][splash]
+
+[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
+
# OpenTelemetry Collector Rust Exporter
-The OTLP Exporter supports exporting trace and metric data in the OTLP format to
-the OpenTelemetry collector. The OpenTelemetry Collector offers a
+[`OTLP`] integration for applications instrumented with [`OpenTelemetry`].
+
+[](https://crates.io/crates/opentelemetry-otlp)
+[](https://docs.rs/opentelemetry-otlp)
+[](./LICENSE)
+[](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+[Documentation](https://docs.rs/opentelemetry-otlp) |
+[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+## Overview
+
+[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
+generate, collect, and export telemetry data (metrics, logs, and traces) for
+analysis in order to understand your software's performance and behavior.
+
+This crate provides an exporter for sending trace and metric data in the OTLP
+format to the OpenTelemetry collector. The OpenTelemetry Collector offers a
vendor-agnostic implementation on how to receive, process, and export telemetry
data. In addition, it removes the need to run, operate, and maintain multiple
agents/collectors in order to support open-source telemetry data formats (e.g.
Jaeger, Prometheus, etc.) sending to multiple open-source or commercial
back-ends.
+[`OTLP`]: https://github.com/open-telemetry/opentelemetry-collector
+[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
+
## Quickstart
First make sure you have a running version of the opentelemetry collector you
diff --git a/opentelemetry-prometheus/README.md b/opentelemetry-prometheus/README.md
index 028821a4bd..5f958c2f1b 100644
--- a/opentelemetry-prometheus/README.md
+++ b/opentelemetry-prometheus/README.md
@@ -1,3 +1,27 @@
+![OpenTelemetry — An observability framework for cloud-native software.][splash]
+
+[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
+
# OpenTelemetry Prometheus
-A Prometheus exporter implementation for OpenTelemetry Rust.
+[`Prometheus`] integration for applications instrumented with [`OpenTelemetry`].
+
+[](https://crates.io/crates/opentelemetry-prometheus)
+[](https://docs.rs/opentelemetry-prometheus)
+[](./LICENSE)
+[](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+[Documentation](https://docs.rs/opentelemetry-prometheus) |
+[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+## Overview
+
+[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
+generate, collect, and export telemetry data (metrics, logs, and traces) for
+analysis in order to understand your software's performance and behavior. This
+crate provides a pipeline and exporter for exposing metrics information to
+Prometheus for processing and visualization.
+
+[`Prometheus`]: https://prometheus.io
+[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
diff --git a/opentelemetry-prometheus/src/lib.rs b/opentelemetry-prometheus/src/lib.rs
index fa3f99b7e6..902a03c3ae 100644
--- a/opentelemetry-prometheus/src/lib.rs
+++ b/opentelemetry-prometheus/src/lib.rs
@@ -59,6 +59,9 @@
unused
)]
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))]
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
+)]
#![cfg_attr(test, deny(warnings))]
use opentelemetry::global;
diff --git a/opentelemetry-semantic-conventions/README.md b/opentelemetry-semantic-conventions/README.md
index ca0d8e7772..caa4b6c1ad 100644
--- a/opentelemetry-semantic-conventions/README.md
+++ b/opentelemetry-semantic-conventions/README.md
@@ -1,3 +1,27 @@
+![OpenTelemetry — An observability framework for cloud-native software.][splash]
+
+[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
+
# OpenTelemetry Semantic Conventions
-OpenTelemetry semantic conventions are agreed standardized naming patterns for OpenTelemetry things. This crate aims to be the centralized place to interact with these conventions.
+Semantic conventions for applications instrumented with [`OpenTelemetry`].
+
+[](https://crates.io/crates/opentelemetry-semantic-conventions)
+[](https://docs.rs/opentelemetry-semantic-conventions)
+[](./LICENSE)
+[](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+[Documentation](https://docs.rs/opentelemetry-semantic-conventions) |
+[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+## Overview
+
+[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
+generate, collect, and export telemetry data (metrics, logs, and traces) for
+analysis in order to understand your software's performance and behavior. This
+crate provides standardized naming patterns for attributes, labels, and
+resources to help facilitate interoperability and compatibility with processing
+and visualization tools.
+
+[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
diff --git a/opentelemetry-semantic-conventions/src/lib.rs b/opentelemetry-semantic-conventions/src/lib.rs
index fe4a45b96a..192aabd17d 100644
--- a/opentelemetry-semantic-conventions/src/lib.rs
+++ b/opentelemetry-semantic-conventions/src/lib.rs
@@ -13,6 +13,9 @@
unused
)]
#![cfg_attr(test, deny(warnings))]
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
+)]
pub mod resource;
pub mod trace;
diff --git a/opentelemetry-zipkin/README.md b/opentelemetry-zipkin/README.md
index 26475e7458..dda267c021 100644
--- a/opentelemetry-zipkin/README.md
+++ b/opentelemetry-zipkin/README.md
@@ -1,11 +1,32 @@
+![OpenTelemetry — An observability framework for cloud-native software.][splash]
+
+[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
+
# OpenTelemetry Zipkin
-Collects OpenTelemetry spans and reports them to a given Zipkin collector
-endpoint. See the [Zipkin Docs] for details and deployment information.
+[`Zipkin`] integration for applications instrumented with [`OpenTelemetry`].
+
+[](https://crates.io/crates/opentelemetry-zipkin)
+[](https://docs.rs/opentelemetry-zipkin)
+[](./LICENSE)
+[](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+[Documentation](https://docs.rs/opentelemetry-zipkin) |
+[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
+
+## Overview
+
+[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
+generate, collect, and export telemetry data (metrics, logs, and traces) for
+analysis in order to understand your software's performance and behavior. This
+crate provides a trace pipeline and exporter for sending span information to a
+Zipkin collector for processing and visualization.
*Compiler support: [requires `rustc` 1.42+][msrv]*
-[Zipkin Docs]: https://zipkin.io/
+[`Zipkin`]: https://zipkin.io/
+[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
[msrv]: #supported-rust-versions
## Quickstart
diff --git a/opentelemetry-zipkin/src/lib.rs b/opentelemetry-zipkin/src/lib.rs
index c8c3e85b65..5c11384b8f 100644
--- a/opentelemetry-zipkin/src/lib.rs
+++ b/opentelemetry-zipkin/src/lib.rs
@@ -148,6 +148,9 @@
unused
)]
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))]
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
+)]
#![cfg_attr(test, deny(warnings))]
#[macro_use]
diff --git a/src/lib.rs b/src/lib.rs
index c829b3b7b1..ec9aed8e9c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -54,6 +54,9 @@
)]
#![allow(clippy::needless_doctest_main)]
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))]
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
+)]
#![cfg_attr(test, deny(warnings))]
mod api;