You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Python code examples exist in the OpenTelemetry Python repository
opentelemetry.io manually copies these examples for documentation
This process is prone to inconsistencies, especially during version updates. if the python repo have change which will lead to problem in example code, we can’t find it on time
Documentation may not reflect the latest changes or bug fixes in the code
Proposed solution:
Implement a function or process that:
Find a way to automatically syncs code examples from the Python repo to the documentation
Ensures that examples in the documentation are always up-to-date
Add testing of the code examples to catch any issues
Next steps:
Research potential methods for automating this synchronization
Open a corresponding issue in the opentelemetry.io repository, discuss the proposal with the community for feedback and improvements
This enhancement will improve the reliability of our documentation and reduce the manual effort required to keep code examples consistent across our ecosystem.
Is your feature request related to a problem?
no
Describe the solution you'd like
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
#4001
/cc @emdneto @lzchen
Describe alternatives you've considered
No response
Additional Context
No response
Would you like to implement a fix?
Yes
The text was updated successfully, but these errors were encountered: