open-telemetry/opentelemetry-specification

Improve histogram images in metrics data-model.md

Open

#3,745 opened on Oct 27, 2023

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Makefile (987 forks)auto 404
help wantedspec:metricstriage:accepted:ready

Repository metrics

Stars
 (4,267 stars)
PR merge metrics
 (PR metrics pending)

Description

There are a handful of helpful images in the histogram readme that do a fantastic job of demonstrating how histograms work. Unfortunately, there are a couple of problems with these:

  1. The text aliasing looks awful / low quality text.
  2. The background is transparent, which means that the images are hard/impossible to see all the detail in dark mode.

I think it would be great if we could put a background color in place (to help both light and dark mode readers) and to maybe recreate these images as line art (svg) so the text is readable.

@jsuereth did you create these originally? If not, do you know who? I was thinking that starting with the original might be simpler than trying to completely recreate these.

Images in question live here: https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/img

Contributor guide

Research direction
Recreate the histogram images as SVG files with a solid background color for better readability in both light and dark modes.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitBasic design skills
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70