Skip to content

docs: fix generated CRD reference self-links - #2904

Open
kayx23 wants to merge 1 commit into
apache:masterfrom
kayx23:docs/fix-generated-crd-self-links-apache
Open

kayx23 wants to merge 1 commit into
apache:masterfrom
kayx23:docs/fix-generated-crd-self-links-apache

Conversation

@kayx23

@kayx23 kayx23 commented Oct 15, 2026

Copy link
Copy Markdown
Member

Summary

  • map external Gateway API aliases and time.Duration to their authoritative references
  • omit Appears in links for types excluded from the generated document
  • add a generated CRD self-link checker to the Makefile and CI
  • regenerate the CRD API reference

Why

crd-ref-docs treated four Gateway API aliases and time.Duration as locally rendered types, producing links to headings that do not exist. The template also linked to ConsumerStatus even though that type is excluded from the output. These six broken fragments were copied into downstream documentation whenever the reference was regenerated.

Validation

  • confirmed the checker fails on the previous output with exactly six missing fragments
  • regenerated the reference twice and confirmed byte-identical output
  • checked 229 generated self-links against 102 Docusaurus heading IDs; all resolve
  • confirmed all five external pkg.go.dev anchors return HTTP 200
  • make check-crd-doc-links
  • git diff --check
  • Python syntax check for scripts/check-crd-doc-links.py

This is the Apache APISIX Ingress Controller counterpart to api7/api7-ingress-controller#494.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants