search

open-telemetry / build-tools

Building tools provided by OpenTelemetry
https://opentelemetry.io
Apache License 2.0
37 stars 53 forks source link

Improve documentation of code generator #198

Open joaopgrassi opened 1 year ago

joaopgrassi commented 1 year ago

There are a couple of issues about our current code generator documentation. In general, I feel the process to get the things working is not clear. There are several arguments that are not documented at all, and folks need either to ask here, or dig into the code themselves to find things out.

I can tell from my own experience as a "first timer". It was particularly painful for me when I was trying to get it to work for the .NET SDK https://github.com/open-telemetry/opentelemetry-dotnet/pull/2069.

I feel we need to cover in the docs:

ezinneanne commented 1 year ago

Hello, can I work on this?

joaopgrassi commented 1 year ago

Hi @ezinneanne sure! Feel free to work on it and reach out if something is unclear.

joaopgrassi commented 1 year ago

@ezinneanne are you working on this? Let me know so I can assign it to you then. Thank you!

ezinneanne commented 1 year ago

Hello, I would love to work on this but am preoccupied at the moment. You can assign it to someone else. Thank you @joaopgrassi

lmolkova commented 6 months ago

I think this was covered in #243 and will be fully merged in #295

lmolkova commented 6 months ago

There were a lot of docs improvements in the 0.24.0 release - https://github.com/open-telemetry/build-tools/blob/v0.24.0/semantic-conventions/README.md#code-generator

I think we can still improve it further documenting a few remaining filters and tests, so I'm keeping it open.