Skip to content

fix(docs): verify APISIX-owned signals and Ingress release label - #2153

Merged
Yilialinn merged 1 commit into
apache:masterfrom
Yilialinn:codex/recover-high-value-owned-docs-20261116
Nov 18, 2026
Merged

Yilialinn merged 1 commit into
apache:masterfrom
Yilialinn:codex/recover-high-value-owned-docs-20261116

Conversation

@Yilialinn

@Yilialinn Yilialinn commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Context

The current Ingress Controller docs are synced from the v2.2.0 release ref, but that ref's docs/en/latest/config.json still declares 0.3.0. As a result, the current docs display an outdated v0.3.0 version label. The audited APISIX-owned pages are already indexable and self-canonical; this is a reader-facing version accuracy fix and regression protection, not a demonstrated fix for their traffic decline.

Changes

  • Derive the Ingress Controller version label from the ref actually used by the documentation sync; leave other subprojects unchanged.
  • Add Dashboard and Deployment Modes to the APISIX-owned documentation checks for canonical, robots and sitemap signals.
  • Require a valid synced Ingress release ref and verify that the built Ingress overview and API Reference display it.
  • Leave URLs, redirects and the established API7-owned documentation canonical strategy unchanged.

Validation

  • node --check passed for all three changed files.
  • git diff --check passed.
  • Independent review found no P0-P2 issues.
  • Local site build was not run as agreed. The PR CI build and test:doc-signals remain the rendered-output gate.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues are recorded for the Ingress version-label and documentation-check updates.

No open issues 🎉

What changed in this PR

Corrects the Ingress Controller documentation’s displayed version using the synced release ref and strengthens rendered documentation checks. URLs, redirects, and the API7-owned canonical strategy remain unchanged.

Changes:

  • Derives the Ingress version label from the synced release ref, leaving other subprojects unchanged.
  • Adds Dashboard and Deployment Modes to canonical, robots, and sitemap checks.
  • Requires a valid Ingress release ref and checks that the overview and API Reference display it.
File Description
next/​tests/​fixtures/​documentation-search-signals.mjs Adds Dashboard and Deployment Modes to APISIX-owned page checks.
next/​src/​lib/​content.ts Uses the synced Ingress release ref for its version label.
next/​scripts/​check-documentation-ownership-signals.mjs Validates the Ingress release ref and displayed version on two built pages.

Review effort: Balanced

@Yilialinn Yilialinn self-assigned this Nov 18, 2026
@Yilialinn
Yilialinn merged commit bdc5e74 into apache:master Nov 18, 2026
7 checks passed
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.

4 participants