PullPolicy link fix - #1007
Closed
kristin-kronstain-brown wants to merge 1 commit into
Closed
Conversation
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Deploying agentproxy with
|
| Latest commit: |
e14f41d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ce846581.agentproxy.pages.dev |
| Branch Preview URL: | https://kkb-links-9-1-26.agentproxy.pages.dev |
Collaborator
Author
|
Moved into: #1004 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes a broken anchor in the generated API reference.
crd-ref-docstemplates akubernetes.ioURL for every k8s type, so thepullPolicyfield links to#pullpolicy-v1-core. That anchor doesn't exist —PullPolicyis a type alias with no section of its own — so the link drops readers at the top of a very long API page. Repointed to the concepts page, which is where the field is actually documented.The rewrite is one
sedadded to the post-processing block that already runs in Generate agentgateway API docs, plus a guard that fails the run if the pattern stops matching, so a silently-stale regex can't quietly reintroduce the bad anchor.Why here and not elsewhere
knownTypes.LinkForTypechecksIsKubeTypebeforeIsKnownType, so any entry for a k8s type is silently ignored. An entry forPullPolicyused to live in the config and never took effect.api-*.md. The reference docs regenerate nightly, so a hand-edit is reverted within a day.Upstream
elastic/crd-ref-docs#143 flips that ordering so
knownTypeswins, which would make this workaround unnecessary. It's been open since March 2025 and needs a rebase. If it merges, we pick it up automatically (the workflow runs@latest) and can drop thesedin favor of aknownTypesentry.