Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
atoulme opened this issue Apr 4, 2024 · 2 comments
Open

Comments

@atoulme
Copy link
Contributor

atoulme commented Apr 4, 2024

As exposed in open-telemetry/opentelemetry-collector-contrib#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
Copy link
Member

My suggestion based on your points:

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

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

@atoulme
Copy link
Contributor Author

atoulme commented Apr 24, 2024

The problem is that the default value is [].

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

No branches or pull requests

3 participants