Open
Description
The website docs refer to open-telemetry/opentelemetry-operator/docs/api.md, but that page has been refactored via the following PR and to the links are invalid:
Invalid links that need to be fixed:
- docs/api.md#instrumentation
- docs/api.md#opampbridge
- docs/api.md#opentelemetrycollector
- docs/api.md#opentelemetrycollector-1
- docs/api.md#opentelemetrycollectorspectargetallocator
- docs/api.md#opentelemetrycollectorspectargetallocatorprometheuscr
- docs/api.md#opentelemetrycollectorspectargetallocatorprometheuscr-1
Here are the pages affected:
$ grep -rl 'https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md' content
content/en/docs/platforms/kubernetes/operator/troubleshooting/target-allocator.md
content/en/docs/platforms/kubernetes/operator/automatic.md
content/en/blog/2024/otel-operator-q-and-a/index.md
content/en/blog/2023/end-user-q-and-a-04.md
Tasks
- The old, invalid links should be removed from the refcache.json file - Fix invalid links to Prometheus, API pages, and more #6235
- After you've updated the links, run the link checker and it will refresh the refcache.json file
Related
- This was identified through work on [chore] Ensure that external link fragments are valid #6196
- [docs] API reference copyedits opentelemetry-operator#3700
/assign @open-telemetry/operator-approvers