opentelemetry-rust icon indicating copy to clipboard operation
opentelemetry-rust copied to clipboard

Enhance README consistency across OpenTelemetry components

Open Copilot opened this issue 5 months ago • 8 comments

This PR addresses inconsistencies in README files across OpenTelemetry Rust components to provide a uniform documentation experience for users.

Changes Made

Enhanced opentelemetry-http README

  • Added comprehensive "What does this crate contain?" section detailing:
    • Context propagation capabilities
    • HTTP client support (reqwest, hyper)
    • Exporter utilities
    • Sampling strategy support
  • Added "Related crates" section linking to core OpenTelemetry components
  • Improved description clarity with explicit OpenTelemetry integration mention

Improved opentelemetry-stdout README

  • Enhanced description to clearly explain educational/debugging purpose
  • Improved "What does this crate contain?" section with detailed descriptions of:
    • Trace exporter functionality
    • Metrics exporter capabilities
    • Logs exporter features
  • Clarified human-readable output format and use cases

Fixed opentelemetry-proto README

  • Added missing badges (crates.io, docs.rs, LICENSE, CI, Slack)
  • Improved description clarity and formatting
  • Added "Getting started" section for consistency

Enhanced opentelemetry-appender-log README

  • Added missing "Getting started" section
  • Added complete "Supported Rust Versions" section
  • Added missing reference links

Updated opentelemetry-semantic-conventions README

  • Added missing "Getting started" section for consistency

Structure Consistency

All README files now follow a consistent structure:

  1. Title with OpenTelemetry logo
  2. Clear description with purpose
  3. Complete badge set (crates.io, docs.rs, LICENSE, CI, Slack)
  4. Overview section
  5. "What does this crate contain?" section (where applicable)
  6. "Getting started" section linking to docs
  7. Release notes section
  8. Supported Rust versions section

This ensures users can easily navigate documentation and find relevant information across all OpenTelemetry Rust components.

Fixes #1306.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot avatar Jul 17 '25 02:07 Copilot

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: cijothomas / name: Cijo Thomas (c9e74d1c37625fc728b94b77a810d222caedc0e2, d9ea1e648f88fb32c5f308288bc6e4b46dee2053)
  • :white_check_mark: Unknown (7da8d447a43abf865c0609fe47a22f11bed89ba1, e5acfc562d105a501fb0d285876f0cd5c759e3af, 6f990f5ba320a4a12adef08ae773e7a10802ceb2)

@copilot make sure the following is checked for every crate in this repo (except examples)

All README files now follow a consistent structure:

Title with OpenTelemetry logo Clear description with purpose Complete badge set (crates.io, docs.rs, LICENSE, CI, Slack) Overview section "What does this crate contain?" section (where applicable) "Getting started" section linking to docs Release notes section Supported Rust versions section

cijothomas avatar Jul 17 '25 02:07 cijothomas

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 80.4%. Comparing base (e0dd566) to head (c9e74d1).

Additional details and impacted files
@@           Coverage Diff           @@
##            main   #3074     +/-   ##
=======================================
- Coverage   80.5%   80.4%   -0.1%     
=======================================
  Files        126     126             
  Lines      22218   22218             
=======================================
- Hits       17889   17885      -4     
- Misses      4329    4333      +4     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Jul 17 '25 02:07 codecov[bot]

@copilot make sure the following is checked for every crate in this repo (except examples)

...

Completed comprehensive README consistency check for all OpenTelemetry Rust crates. All 12 crates now follow the required structure:

✅ Title with OpenTelemetry logo ✅ Clear description with purpose
✅ Complete badge set (crates.io, docs.rs, LICENSE, CI, Slack) ✅ Overview section ✅ "What does this crate contain?" section (where applicable) ✅ "Getting started" section linking to docs ✅ Release notes section ✅ Supported Rust versions section

Changes in commit 6f990f5.

Copilot avatar Jul 17 '25 02:07 Copilot

/easycla

cijothomas avatar Aug 02 '25 06:08 cijothomas

/easycla

lukaszgryglicki avatar Aug 02 '25 07:08 lukaszgryglicki

@cijothomas EasyCLA now passes as requested on slack.

lukaszgryglicki avatar Aug 02 '25 07:08 lukaszgryglicki

/easycla

jarias-lfx avatar Aug 04 '25 17:08 jarias-lfx