-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Synchronize OpenTelemetry Python code examples between otel-python and otel.io #4890
Comments
Thanks for raising this issue! We (SIG Comms) are currently testing tooling for syncing code between language repos and docs, we are still reluctant to talk about this in a broader forum, because we still need to figure out some of the processes and logistics, see #1635 for some additional details. Currently Java & Go have some implementation of that, @zeitlinger for example created this PR the other day: If @open-telemetry/python-maintainers want to provide something similar, I recommend that we start with getting started I will try to find some time to write down some words about this tooling and more importantly the process we plan to implement. |
@svrnm Thank you for the detailed explanation. I've reviewed PR #4642 and the related discussions, and it's clear this has been a topic of interest for some time.👍🏻 I see we have a 'tools' folder with configuration files, and 'code-excerpts' scripts defined in package.json. Given this, am I correct in understanding that this code synchronization feature is still in an experimental phase? It doesn't appear to be integrated into the regular workflow of the opentelemetry.io repository yet. |
It's experimental, that's why it is not integrated more deeply yet, we have plans for full integration, but this is a massive undertaking and we have other big projects (especially localization) going on where we need to balance our resources. We are happy to take on help for that, but at the same time I have to call out, that this is not a trivial project and it requires a certain level of understanding how things are cobbled together for the website, so things are not likely to go smooth. |
@svrnm Thank you for the detailed explanation! I understand the complexity and resource constraints. I'm comfortable with Python and willing to help where I can. Maybe I could start from opening a PR similar to Java, and try to run and test the tool? Let me know how I can best assist. |
As discussed in the SIG meeting on July 25th(https://docs.google.com/document/d/1CIMGoIOZ-c3-igzbd6_Pnxx1SjAkjwqoYSUWxPY8XIs/edit), we need to implement a solution to ensure consistency between the OpenTelemetry Python code examples in our repository and the documentation on opentelemetry.io.
Current situation:
Proposed solution:
Implement a function or process that:
Next steps:
This enhancement will improve the reliability of our documentation and reduce the manual effort required to keep code examples consistent across our ecosystem.
Related issues:
#4078
What is the name + path of the page that needs changed? The relative path
and page title where you found a problem.
https://opentelemetry.io/docs/languages/python/
I would like to implement the fix, welcome discuss!
The text was updated successfully, but these errors were encountered: