Skip to content

Conversation

@njg7194
Copy link
Contributor

@njg7194 njg7194 commented Feb 1, 2026

What

Adds a Quick Start section to the README with a Docker one-liner command.

Why

The current README directs users to external documentation for getting started. Adding a Quick Start section directly in the README allows new users to:

  1. Try Jaeger immediately without leaving GitHub
  2. Understand the basic setup at a glance
  3. Know which ports to use for sending traces

This follows the pattern used by many popular CNCF projects (like Prometheus, Grafana) that include quick start commands in their READMEs.

Changes

  • Added "Quick Start" section after the Jaeger v2 announcement
  • Included Docker command for running Jaeger all-in-one
  • Documented common ports (16686 for UI, 4317/4318 for OTLP)
  • Added "Architecture" header before the existing mermaid diagram for better structure
  • Linked to the full Getting Started guide for production deployments

Testing

Verified the Docker command works:

docker run --rm jaegertracing/jaeger:latest

- Add Quick Start section at the top of README for immediate visibility
- Include Docker one-liner for running Jaeger all-in-one
- Document commonly used ports (UI, OTLP gRPC/HTTP)
- Link to full Getting Started guide for production deployments

Signed-off-by: njg7194 <njg7194@users.noreply.github.com>
@njg7194 njg7194 requested a review from a team as a code owner February 1, 2026 04:22
@dosubot dosubot bot added the documentation label Feb 1, 2026
@yurishkuro yurishkuro merged commit 2441861 into jaegertracing:main Feb 1, 2026
56 of 58 checks passed
@dosubot
Copy link

dosubot bot commented Feb 1, 2026

Related Documentation

No published documentation to review for changes on this repository.

Write your first living document

How did I do? Any feedback?  Join Discord

@codecov
Copy link

codecov bot commented Feb 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.56%. Comparing base (39b645c) to head (454e27b).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7945      +/-   ##
==========================================
- Coverage   95.57%   95.56%   -0.02%     
==========================================
  Files         316      316              
  Lines       16726    16726              
==========================================
- Hits        15986    15984       -2     
- Misses        577      579       +2     
  Partials      163      163              
Flag Coverage Δ
badger_v1 9.11% <ø> (ø)
badger_v2 1.90% <ø> (ø)
cassandra-4.x-v1-manual 13.41% <ø> (ø)
cassandra-4.x-v2-auto 1.89% <ø> (ø)
cassandra-4.x-v2-manual 1.89% <ø> (ø)
cassandra-5.x-v1-manual 13.41% <ø> (ø)
cassandra-5.x-v2-auto 1.89% <ø> (ø)
cassandra-5.x-v2-manual 1.89% <ø> (ø)
clickhouse 1.98% <ø> (ø)
elasticsearch-6.x-v1 17.27% <ø> (ø)
elasticsearch-7.x-v1 17.30% <ø> (ø)
elasticsearch-8.x-v1 17.45% <ø> (ø)
elasticsearch-8.x-v2 1.90% <ø> (ø)
elasticsearch-9.x-v2 1.90% <ø> (ø)
grpc_v1 8.44% <ø> (ø)
grpc_v2 1.90% <ø> (ø)
kafka-3.x-v2 1.90% <ø> (ø)
memory_v2 1.90% <ø> (ø)
opensearch-1.x-v1 17.34% <ø> (ø)
opensearch-2.x-v1 17.34% <ø> (ø)
opensearch-2.x-v2 1.90% <ø> (ø)
opensearch-3.x-v2 1.90% <ø> (ø)
query 1.90% <ø> (ø)
tailsampling-processor 0.54% <ø> (ø)
unittests 94.24% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link

github-actions bot commented Feb 1, 2026

Metrics Comparison Summary

Total changes across all snapshots: 0

Detailed changes per snapshot

summary_metrics_snapshot_cassandra

📊 Metrics Diff Summary

Total Changes: 0

  • 🆕 Added: 0 metrics
  • ❌ Removed: 0 metrics
  • 🔄 Modified: 0 metrics
  • 🚫 Excluded: 106 metrics

summary_metrics_snapshot_cassandra

📊 Metrics Diff Summary

Total Changes: 0

  • 🆕 Added: 0 metrics
  • ❌ Removed: 0 metrics
  • 🔄 Modified: 0 metrics
  • 🚫 Excluded: 106 metrics

summary_metrics_snapshot_cassandra

📊 Metrics Diff Summary

Total Changes: 0

  • 🆕 Added: 0 metrics
  • ❌ Removed: 0 metrics
  • 🔄 Modified: 0 metrics
  • 🚫 Excluded: 53 metrics

summary_metrics_snapshot_cassandra

📊 Metrics Diff Summary

Total Changes: 0

  • 🆕 Added: 0 metrics
  • ❌ Removed: 0 metrics
  • 🔄 Modified: 0 metrics
  • 🚫 Excluded: 106 metrics

➡️ View full metrics file

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants