Skip to content

docs: fix links in multi-versioned api reference - #2096

Merged
nacx merged 1 commit into
envoyproxy:mainfrom
nacx:docs-api
May 4, 2026
Merged

docs: fix links in multi-versioned api reference#2096
nacx merged 1 commit into
envoyproxy:mainfrom
nacx:docs-api

Conversation

@nacx

@nacx nacx commented May 1, 2026

Copy link
Copy Markdown
Member

Description

The tool used to generate the API reference docs has a bug where links for multi-versioned CRDs are not properly generated, linking to the wrong versions of the resources. This PR updates the version of the tool being used to use a patched version of the tool.

Related Issues/PRs (if applicable)

Issue: elastic/crd-ref-docs#60
PR used in this change: elastic/crd-ref-docs#118

Special notes for reviewers (if applicable)

N/A

Signed-off-by: Ignasi Barrera <nacx@apache.org>
@nacx
nacx requested a review from a team as a code owner May 1, 2026 09:07
@dosubot dosubot Bot added the size:S This PR changes 10-29 lines, ignoring generated files. label May 1, 2026
@nacx
nacx requested a review from missBerg May 1, 2026 09:07
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.50%. Comparing base (d63a020) to head (6473209).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2096   +/-   ##
=======================================
  Coverage   84.50%   84.50%           
=======================================
  Files         133      133           
  Lines       18471    18471           
=======================================
  Hits        15608    15608           
  Misses       1904     1904           
  Partials      959      959           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nacx
nacx merged commit c3d6a06 into envoyproxy:main May 4, 2026
34 checks passed
@nacx
nacx deleted the docs-api branch May 4, 2026 14:07
anurags25 pushed a commit to anurags25/ai-gateway that referenced this pull request May 12, 2026
**Description**

The tool used to generate the API reference docs has a bug where links
for multi-versioned CRDs are not properly generated, linking to the
wrong versions of the resources. This PR updates the version of the tool
being used to use a patched version of the tool.

**Related Issues/PRs (if applicable)**

Issue: elastic/crd-ref-docs#60
PR used in this change: elastic/crd-ref-docs#118

**Special notes for reviewers (if applicable)**

N/A

Signed-off-by: Ignasi Barrera <nacx@apache.org>
Signed-off-by: Anurag Saykar <anuragsaikar100@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants