open-telemetry / open-telemetry/opentelemetry-python

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

Open
#4,081 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc
Dominant language
Python
Stars
2.6k
Forks
1k
Avg merge
4d 15h
Merged PRs (30d)
19

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Python examples in the opentelemetry-python repository, their counterparts on opentelemetry.io, the SIG meeting discussion, and related issues #4078 and #4001. Research synchronization methods and coordinate a corresponding opentelemetry.io issue; done means examples stay consistent automatically and are tested for breakage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.