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

Synchronize OpenTelemetry Python code examples between otel-python and otel.io #4081

Open
zhihali opened this issue Jul 25, 2024 · 0 comments
Labels
doc Documentation-related

Comments

@zhihali
Copy link
Contributor

zhihali commented Jul 25, 2024

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:

  • 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:

  1. Find a way to automatically syncs code examples from the Python repo to the documentation
  2. Ensures that examples in the documentation are always up-to-date
  3. Add testing of the code examples to catch any issues

Next steps:

  1. Research potential methods for automating this synchronization
  2. 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.

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

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

No branches or pull requests

2 participants