open-telemetry / open-telemetry/opentelemetry-python
A single documentation website for OpenTelemetry Python
Open
@venugopal83k is already working on this.
Since Sep 10, 2024.
doc
feature-request
help wanted
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 19
Description
Today we have two docs website opentelemetry-python.readthedocs.io and opentelemetry-python-contrib.readthedocs.io for the core and contrib repos each. This can be confusing for users and even impossible to discover in some cases.
Describe the solution you'd like
- Ideally we should have a single website that hosts documentation for both core and contrib packages.
- Alternatively, we could have a common sidebar/menu that contains links to both core and contrib packages on both sites so users can navigate to any package's documentation without having discover whole another site first.
Describe alternatives you've considered
- Linking from core to contrib site and vice-versa but I think this is more like band-aid than a solution.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.