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

fix: update links to OpenTelemetry Operator API documentation #6448

Closed
wants to merge 1 commit into from

Conversation

NilzeyX
Copy link

@NilzeyX NilzeyX commented Mar 1, 2025

The OpenTelemetry Operator repository recently refactored its API documentation structure, moving content from the single docs/api.md file 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:

  • Updated links in content/en/docs/platforms/kubernetes/operator/automatic.md
  • Updated links in content/en/docs/platforms/kubernetes/operator/troubleshooting/target-allocator.md
  • Updated links in content/en/blog/2023/end-user-q-and-a-04.md
  • Updated links in content/en/blog/2024/otel-operator-q-and-a/index.md
  • Removed the temporary exclusion in .htmltest.yml since the links are now fixed

These 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, I'm pretty sure I have no idea what I am doing lol, so please let me know how I can better understand issues and work on them!

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 NilzeyX requested a review from a team as a code owner March 1, 2025 07:39
@opentelemetrybot opentelemetrybot requested a review from a team March 1, 2025 07:39
@github-actions github-actions bot added the blog label Mar 1, 2025
@chalin
Copy link
Contributor

chalin commented Mar 1, 2025

/fix:all

@opentelemetrybot
Copy link
Collaborator

You triggered fix:all action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/13605172979

@opentelemetrybot
Copy link
Collaborator

fix:all failed or was cancelled. For details, see https://github.com/open-telemetry/opentelemetry.io/actions/runs/13605172979.

@chalin
Copy link
Contributor

chalin commented Mar 1, 2025

/fix:refcache

@opentelemetrybot
Copy link
Collaborator

You triggered fix:refcache action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/13605322132

@opentelemetrybot
Copy link
Collaborator

fix:refcache failed or was cancelled. For details, see https://github.com/open-telemetry/opentelemetry.io/actions/runs/13605322132.

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this @NilzeyX.

Could you submit a version of this PR that contais only the link corrections?

The other edits, while potentially useful, are breaking the built: see, https://github.com/open-telemetry/opentelemetry.io/actions/runs/13605322132/job/38036110496. Link checking is failing because the tool you're using found an escape sequence in a heading, changed it to a space, and now that's breaking intra-page links (to that now modified heading ID) from other locales.

So, long story short, my suggestion is to separate concerns and address formatting changes (if at all), via a separate PR.

For the record, there's the heading with the offending escape sequence:

$ grep -e '# Do you know' content/en/docs/platforms/kubernetes/operator/troubleshooting/target-allocator.md | od -ch
0000000    #   #   #       D   o       y   o   u       k   n   o   w    
             2323    2023    6f44    7920    756f    6b20    6f6e    2077
0000020    i   f       m   e   t   r   i   c   s       a   r   e       a
             6669    6d20    7465    6972    7363    6120    6572    6120
0000040    c   t   u   a   l   l   y       b   e   i   n   g      **   s
             7463    6175    6c6c    2079    6562    6e69    c267    73a0
0000060    c   r   a   p   e   d   ?  \n                                
             7263    7061    6465    0a3f                                
0000070

The change in this PR, on the surface, looks like there's some sort of whitespace change:

image

Btw, which tool are you using to remove special characters like that?

@chalin
Copy link
Contributor

chalin commented Mar 1, 2025

To fix the refcache, run the following commands locally:

npm run fix:refcache && ./scripts/double-check-refcache-400s.mjs

and commit the refcache updates (in the new PR :).

@NilzeyX
Copy link
Author

NilzeyX commented Mar 1, 2025

Interesting, I noticed it changed a lot of whitespace but I wasn unsure if it mattered. I've been experimenting with cursor and claude 3.7 sonnet - trying to utilize it for large project changes to see how well it performs and do some good at the same time! I'll fix this by focusing purely on the part that matters like you said and submitting that with a new PR.

I'm still new to all this type of thing so apologies for the mistakes!

@NilzeyX NilzeyX closed this Mar 1, 2025
@chalin
Copy link
Contributor

chalin commented Mar 1, 2025

... I'll fix this by focusing purely on the part that matters like you said and submitting that with a new PR.

Great thanks!

I'm still new to all this type of thing so apologies for the mistakes!

No worries, we're all learning :). Had it not been for the broken heading ID, I might have accepted the other formatting changes.

@chalin
Copy link
Contributor

chalin commented Mar 1, 2025

I'm actually glad that your PR pointed out the issue with non-breaking spaces in one of the headings. I've fixed that manually for now via the following PR (FYI):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

K8s operator API links are invalid
3 participants