Skip to content

documentation: fix broken relative links to the release handbook and component documentation - #3662

Merged
google-oss-prow[bot] merged 3 commits into
kubeflow:masterfrom
fjvbn2003:documentation/fix-broken-relative-links
Oct 31, 2026
Merged

google-oss-prow[bot] merged 3 commits into
kubeflow:masterfrom
fjvbn2003:documentation/fix-broken-relative-links

Conversation

@fjvbn2003

Copy link
Copy Markdown
Contributor

Pull Request Template for Kubeflow Manifests

✏️ Summary of Changes

Several relative Markdown links outside the upstream subtrees point to files that no longer exist. This pull request points each of them at the current file and removes one list entry for a component that was deleted.

File Broken target New target Reason
releases/README.md ./kubeflow-ai-reference-platform-release-handbook.md ./kubeflow-community-distribution-release-handbook.md The handbook was renamed in #3522.
releases/release-26.03/release-team.md ../kubeflow-ai-reference-platform-release-handbook.md ../kubeflow-community-distribution-release-handbook.md Same rename. releases/release-26.10/release-team.md already uses the new name.
releases/release-1.10/release-team.md ../kubeflow-ai-reference-platform-release-handbook.md ../kubeflow-community-distribution-release-handbook.md Same rename.
common/oauth2-proxy/components/README.md ./allow-unauthenticated-issuer-discovery.md, ./istio-external-auth.md, ./istio-m2m.md ./<component>/README.md Each component is a directory with its own README.md.
common/oauth2-proxy/components/README.md ./central-dashboard.md entry removed The central-dashboard component was deleted in #3432 together with applications/centraldashboard/overlays/oauth2-proxy.
common/kubeflow-roles/README.md ../istio/istio/base/cluster-roles.yaml ../istio/kubeflow-istio-resources/base/cluster-roles.yaml This is where the quoted kubeflow-istio-admin ClusterRole is defined now.
applications/kserve/README.md .github/workflows/kserve_test.yaml ../../.github/workflows/kserve_test.yaml The link was resolved relative to applications/kserve/.

Local checks

All checks were run against master 9a012d8 (2026-10-28).

  • A small Python script resolves every relative Markdown link outside the upstream subtrees (code blocks excluded) against the file system. On master it reports 84 broken links; the nine links above are among them. With this change it reports 75, and none of them are in the touched files. The remaining 75 are the ../handbook.md and release-team.md links in the older releases/release-1.x pages, which are left unchanged because those pages are historical records. They can be updated in this pull request or in a follow-up if that is preferred.
  • On GitHub, each old target (https://github.com/kubeflow/community-distribution/blob/master/<resolved path>) returns 404 and each new target returns 200.
  • pre-commit run --files <the six changed files> in a python:3.12-slim container: detect-private-key passes and the YAML, shell and Python hooks skip. end-of-file-fixer and trailing-whitespace report the extra blank line at the end of both release-team.md files and a trailing space in the table of releases/release-26.03/release-team.md; all of them already exist on master, and this change does not touch those lines.
  • This is a Markdown-only change, so nothing was rendered with kustomize.

📦 Dependencies

None.

🐛 Related Issues

None found. No open pull request touches these files.

✅ Contributor Checklist

  • I have tested these changes with kustomize. See Installation Prerequisites. (Not applicable: Markdown only.)
  • All commits are signed-off to satisfy the DCO check.
  • I have considered adding my company to the adopters page to support Kubeflow and help the community, since I expect help from the community for my issue (see 1. and 2.).

Prepared with help from Claude (AI), including the local checks described above.

Several relative Markdown links outside the upstream subtrees point to
files that no longer exist:

- The release handbook was renamed to
  kubeflow-community-distribution-release-handbook.md in kubeflow#3522, but
  releases/README.md and the release-team pages for 1.10 and 26.03
  still link to the old name.
- The OAuth2-Proxy component list links to <component>.md files, but
  each component is a directory with its own README.md. The
  central-dashboard component was deleted in kubeflow#3432, so its entry is
  removed.
- The kubeflow-roles README links to the Istio cluster roles under
  common/istio/istio, which moved to
  common/istio/kubeflow-istio-resources.
- The KServe README resolves .github/workflows relative to
  applications/kserve.

Assisted-by: Claude <[email protected]>
Signed-off-by: YoungjuKim <[email protected]>
@github-actions

Copy link
Copy Markdown

Welcome to the Kubeflow Community Distribution Repository

Thanks for opening your first PR. Your contribution means a lot to the Kubeflow community.

Before making more PRs:
Please ensure your PR follows our Contributing Guide.
Please also be aware that many components are synchronized from upstream via the scripts in /scripts.
So in some cases you have to fix the problem in the upstream repositories first, but you can use a PR against kubeflow/community-distribution to test the platform integration.

Community Resources:

Thanks again for helping to improve Kubeflow.

Creates a ClusterRoleBinding for anonymous access to Kubernetes OIDC
discovery.

* **[central-dashboard](./central-dashboard.md)** - Configures the central

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

there is now just dashboard. please adjust the link

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.

🟡 Changes recommended

The documentation links to an empty component README, leaving the promised details unavailable.

1 open issue
What changed in this PR

This documentation-only change repairs relative links in Kubeflow Community Distribution following the release handbook rename and component reorganization. It does not change runtime behavior.

Changes:

  • Updates three release handbook links to the filename introduced in #3522.
  • Corrects OAuth2-Proxy component links and removes the deleted dashboard component entry.
  • Repairs links to the Istio role manifest and KServe test workflow.
File Description
releases/​release-26.03/​release-team.md Links to the renamed release handbook.
releases/​release-1.10/​release-team.md Links to the renamed release handbook.
releases/​README.md Updates the main release handbook link.
common/​oauth2-proxy/​components/​README.md Corrects component links and removes an obsolete entry.
common/​kubeflow-roles/​README.md Corrects the Istio ClusterRole manifest link.
applications/​kserve/​README.md Corrects the relative path to the test workflow.

Review effort: Balanced

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.

🟡 Changes recommended

The linked explanation misrepresents authentication: requests with an Authorization header bypass OAuth2-Proxy and have their JWTs validated by Istio.

1 open issue
1 resolved since last review

Review effort: Balanced

@juliusvonkohout

Copy link
Copy Markdown
Member

/lgtm
/approve

@google-oss-prow

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: juliusvonkohout

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow
google-oss-prow Bot merged commit 84c0be5 into kubeflow:master Oct 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants