open-telemetry / opentelemetry.io

The OpenTelemetry website and documentation
https://opentelemetry.io
Creative Commons Attribution 4.0 International
488 stars 1.01k forks source link

Update go code excerpts #4678

Closed svrnm closed 1 week ago

svrnm commented 2 weeks ago

I ran npm run codeexcerpts to apply latest changes to the go examples, I think this is one of the first times we do the update, so please take a close look

dmathieu commented 2 weeks ago

This seems wrong, as it removes the log example.

svrnm commented 2 weeks ago

This seems wrong, as it removes the log example.

I was surprised about that myself... wait I might have something wrong locally.

svrnm commented 2 weeks ago

turning this into a draft for now, this needs more thought than I initially anticipated

chalin commented 2 weeks ago

FYI:

zeitlinger commented 2 weeks ago

Thanks @svrnm. Btw, this sort of experience goes to show that we can automate the code-snippet refresh (which is super great for minor changes), but when major structural changes are involved, we still need to carefully address the changes in the prose.

/cc @zeitlinger

for java, I have created a dedicated doc-snippets project to make this less likely

svrnm commented 2 weeks ago

Thanks @svrnm. Btw, this sort of experience goes to show that we can automate the code-snippet refresh (which is super great for minor changes), but when major structural changes are involved, we still need to carefully address the changes in the prose. /cc @zeitlinger

for java, I have created a dedicated doc-snippets project to make this less likely

Can you share that project?

zeitlinger commented 2 weeks ago

Thanks @svrnm. Btw, this sort of experience goes to show that we can automate the code-snippet refresh (which is super great for minor changes), but when major structural changes are involved, we still need to carefully address the changes in the prose. /cc @zeitlinger

for java, I have created a dedicated doc-snippets project to make this less likely

Can you share that project?

https://github.com/open-telemetry/opentelemetry-java-examples/pull/422

svrnm commented 1 week ago

Will raise a new PR because of https://github.com/open-telemetry/opentelemetry.io/pull/4679