[cmd/mdatagen] Allow to show more information related to component warnings

open-telemetry / opentelemetry-collector

OpenTelemetry Collector

https://opentelemetry.io

Apache License 2.0

4.46k stars 1.47k forks source link

[cmd/mdatagen] Allow to show more information related to component warnings #9894

Open atoulme opened 7 months ago

atoulme commented 7 months ago

As exposed in https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/32130, component authors now document explicitly that an empty warnings entry is to be considered as having reviewed warnings associated with the component.

Right now, this doesn't translate to a README change. It would be good to have a way to explicitly call the state of warning maturation for a component:

Not reviewed
Reviewed, warnings identified
Reviewed, no warnings

SpencerTorres commented 7 months ago

My suggestion based on your points:

default/undefined value can be "Not reviewed"
warnings: [...] can be "Reviewed, warnings identified"
warnings: [] can be "Reviewed, no warnings"

The README should generate with placeholder text for cases 1 and 2.

atoulme commented 6 months ago

The problem is that the default value is [].