opentelemetry-python icon indicating copy to clipboard operation
opentelemetry-python copied to clipboard

Non-API docs should be hosted on the website only

Open chalin opened this issue 2 years ago • 6 comments

  • This issue is a slight generalization of https://github.com/open-telemetry/opentelemetry.io/issues/730. We don't want doc pages in more than one place. It's bad for SEO and it confuses users.
    • For example, currently the Getting started page can be found at: https://opentelemetry.io/docs/python/getting-started/ and https://opentelemetry-python.readthedocs.io/en/stable/getting-started.html
    • The canonical source for non-API Python docs should be opentelemetry.io/docs/python, any other pages should link to there.
    • If you (@open-telemetry/python-maintainers) agree, I can progressively move relevant of the pages, starting with Getting started.
  • Contributes to https://github.com/open-telemetry/opentelemetry.io/issues/833
  • Related #2319

Details:

  • [x] API docs landing page, Getting Started and more:
    • [x] https://github.com/open-telemetry/opentelemetry.io/pull/1116
    • [x] #2453
  • [x] Auto-instrumentation and distro pages:
    • [x] https://github.com/open-telemetry/opentelemetry.io/pull/1118
    • [x] #2498

/cc @austinlparker @cartermp

chalin avatar Oct 02 '21 19:10 chalin

/cc @cartermp

chalin avatar Feb 03 '22 10:02 chalin

Thanks, @chalin adding this to today's SIG meeting topics :+1:

ocelotl avatar Feb 03 '22 16:02 ocelotl

Just for information, this issue will not be fixed with a PR in this repo :+1:

ocelotl avatar Feb 03 '22 17:02 ocelotl

Part of this effort: https://github.com/open-telemetry/opentelemetry-python/issues/2319

lzchen avatar Feb 03 '22 17:02 lzchen

Recording here for posterity - this was approved, so I'll work on this until it's ready for a review, and then loop folks in to make sure things look good.

cartermp avatar Feb 03 '22 19:02 cartermp

FYI, we'll be tracking the move via https://github.com/open-telemetry/opentelemetry.io/issues/1109.

chalin avatar Feb 08 '22 16:02 chalin