fix: update links to OpenTelemetry Operator API documentation #6447
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
The committers listed above are authorized under a signed CLA. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The OpenTelemetry Operator repository recently refactored its API documentation structure, moving content from the single
docs/api.mdfile to a directory-based structure with separate files for each component (docs/api/opentelemetrycollectors.md,docs/api/instrumentations.md,docs/api/targetallocators.md, etc.).This PR updates all references to the old API documentation structure across our documentation files to point to the new locations:
content/en/docs/platforms/kubernetes/operator/automatic.mdcontent/en/docs/platforms/kubernetes/operator/troubleshooting/target-allocator.mdcontent/en/blog/2023/end-user-q-and-a-04.mdcontent/en/blog/2024/otel-operator-q-and-a/index.md.htmltest.ymlsince the links are now fixedThese changes ensure that users are directed to the correct, up-to-date API documentation when following links in our documentation.
Helps Fix #6237
I'm a relatively new contributor, so please let me know if I've missed anything or if there are any improvements I should make to this PR.