Add logos and overview section to crate readmes (open-telemetry#311)

Co-authored-by: Jan Kühle <[email protected]>

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.
 
 [![Crates.io: opentelemetry](https://img.shields.io/crates/v/opentelemetry.svg)](https://crates.io/crates/opentelemetry)
 [![Documentation](https://docs.rs/opentelemetry/badge.svg)](https://docs.rs/opentelemetry)
-[![Crates.io](https://img.shields.io/crates/l/opentelemetry)](./LICENSE)
+[![LICENSE](https://img.shields.io/crates/l/opentelemetry)](./LICENSE)
 [![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
 [![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](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]*
 

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`].
+
+[![Crates.io: opentelemetry-contrib](https://img.shields.io/crates/v/opentelemetry-contrib.svg)](https://crates.io/crates/opentelemetry-contrib)
+[![Documentation](https://docs.rs/opentelemetry-contrib/badge.svg)](https://docs.rs/opentelemetry-contrib)
+[![LICENSE](https://img.shields.io/crates/l/opentelemetry-contrib)](./LICENSE)
+[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](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

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")]

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`].
+
+[![Crates.io: opentelemetry-jaeger](https://img.shields.io/crates/v/opentelemetry-jaeger.svg)](https://crates.io/crates/opentelemetry-jaeger)
+[![Documentation](https://docs.rs/opentelemetry-jaeger/badge.svg)](https://docs.rs/opentelemetry-jaeger)
+[![LICENSE](https://img.shields.io/crates/l/opentelemetry-jaeger)](./LICENSE)
+[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](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<dyn std::error::Error + Send + Sync + 'static>> {
 }
 ```
 
-![Jaeger UI](trace.png)
+![Jaeger UI](https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/opentelemetry-jaeger/trace.png)
 
 ## Performance
 

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;

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`].
+
+[![Crates.io: opentelemetry-otlp](https://img.shields.io/crates/v/opentelemetry-otlp.svg)](https://crates.io/crates/opentelemetry-otlp)
+[![Documentation](https://docs.rs/opentelemetry-otlp/badge.svg)](https://docs.rs/opentelemetry-otlp)
+[![LICENSE](https://img.shields.io/crates/l/opentelemetry-otlp)](./LICENSE)
+[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](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

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`].
+
+[![Crates.io: opentelemetry-prometheus](https://img.shields.io/crates/v/opentelemetry-prometheus.svg)](https://crates.io/crates/opentelemetry-prometheus)
+[![Documentation](https://docs.rs/opentelemetry-prometheus/badge.svg)](https://docs.rs/opentelemetry-prometheus)
+[![LICENSE](https://img.shields.io/crates/l/opentelemetry-prometheus)](./LICENSE)
+[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](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

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;

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`].
+
+[![Crates.io: opentelemetry-semantic-conventions](https://img.shields.io/crates/v/opentelemetry-semantic-conventions.svg)](https://crates.io/crates/opentelemetry-semantic-conventions)
+[![Documentation](https://docs.rs/opentelemetry-semantic-conventions/badge.svg)](https://docs.rs/opentelemetry-semantic-conventions)
+[![LICENSE](https://img.shields.io/crates/l/opentelemetry-semantic-conventions)](./LICENSE)
+[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](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

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;

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`].
+
+[![Crates.io: opentelemetry-zipkin](https://img.shields.io/crates/v/opentelemetry-zipkin.svg)](https://crates.io/crates/opentelemetry-zipkin)
+[![Documentation](https://docs.rs/opentelemetry-zipkin/badge.svg)](https://docs.rs/opentelemetry-zipkin)
+[![LICENSE](https://img.shields.io/crates/l/opentelemetry-zipkin)](./LICENSE)
+[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
+[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](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

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]

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;