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

A single documentation website for OpenTelemetry Python #2166

Open
owais opened this issue Sep 30, 2021 · 0 comments
Open

A single documentation website for OpenTelemetry Python #2166

owais opened this issue Sep 30, 2021 · 0 comments
Labels

Comments

@owais
Copy link
Contributor

owais commented Sep 30, 2021

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.
@owais owais added feature-request doc Documentation-related help wanted labels Sep 30, 2021
@owais owais changed the title A single document website for OpenTelemetry Python A single documentation website for OpenTelemetry Python Sep 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant