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

K8s operator API links are invalid #6237

Open
1 of 9 tasks
Tracked by #6196
chalin opened this issue Feb 6, 2025 · 1 comment
Open
1 of 9 tasks
Tracked by #6196

K8s operator API links are invalid #6237

chalin opened this issue Feb 6, 2025 · 1 comment
Labels
bug Something isn't working sig:operator

Comments

@chalin
Copy link
Contributor

chalin commented Feb 6, 2025

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:

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

Related

/assign @open-telemetry/operator-approvers

@meswapnilk
Copy link
Contributor

Started working on it.

NilzeyX added a commit to NilzeyX/opentelemetry.io-6237fix that referenced this issue Mar 1, 2025
The OpenTelemetry Operator repository refactored its API documentation structure,
making the previous links to docs/api.md invalid. This commit updates all references
to point to the new API documentation locations.

Fixes open-telemetry#6237
NilzeyX added a commit to NilzeyX/opentelemetry.io-6237fix that referenced this issue Mar 2, 2025
…r API docs - Needs test and htmltest.yml also needs to be changed to not ignore links anymore
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working sig:operator
Projects
None yet
2 participants