Broken links in the Kubebuilder Book
Hi Kubebuilder maintainers,
While going through the Kubebuilder Book, I ran a link check and found 18 URLs that currently return 404/403 responses.
The scan result was:
100% scanned - 431/431 URLs checked
413 OK, 18 failedMost of the broken links appear to be references to source files, documentation pages, or directories that have moved or are no longer available at their old locations.
Broken links
| # | Status | Anchor text | Broken URL |
|---|---|---|---|
| 1 | 404 | CronJob code | https://book.kubebuilder.io/multiversion-tutorial/multiversion-tutorial/testdata/project/api/v2/cronjob_types.go |
| 2 | 404 | Designing an API | https://book.kubebuilder.io/multiversion-tutorial/api-design.html |
| 3 | 404 | Design proposal documentation | https://book.kubebuilder.io/designs/helper_to_upgrade_projects_by_rescaffolding.html |
| 4 | 404 | Design proposal for update automation | https://book.kubebuilder.io/designs/update_action.html |
| 5 | 404 | alpha generate | https://book.kubebuilder.io/reference/rescaffold.html |
| 6 | 404 | your own plugins | https://book.kubebuilder.io/plugins/creating-plugins.html |
| 7 | 403 | kubebuilder-tools | https://storage.googleapis.com/kubebuilder-tools |
| 8 | 404 | docker buildx | https://docs.docker.com/build/buildx/ |
| 9 | 404 | Enable RBAC rules for Prometheus pods | https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md |
| 10 | 404 | Bundle Plugin | https://book.kubebuilder.io/pkg/plugin/bundle.go |
| 11 | 404 | main.go | https://book.kubebuilder.io/cmd/main.go |
| 12 | 404 | base Golang plugin | https://book.kubebuilder.io/pkg/plugins/golang/v4 |
| 13 | 404 | config/prometheus | https://book.kubebuilder.io/testdata/project-v4-with-plugins/config/prometheus/monitor.yaml |
| 14 | 404 | plugin implementation | https://book.kubebuilder.io/pkg/plugins/optional/grafana |
| 15 | 404 | testdata | https://book.kubebuilder.io/testdata |
| 16 | 404 | here | https://book.kubebuilder.io/pkg/plugins/common/kustomize/v2/scaffolds/api.go |
| 17 | 404 | plugin implementation | https://book.kubebuilder.io/pkg/plugins/optional/grafana/ |
| 18 | 404 | testdata | https://book.kubebuilder.io/testdata/ |
A few possible replacements
I checked some of the links against the current Kubebuilder documentation/repository and found some clear candidates:
multiversion-tutorial/api-design.html→cronjob-tutorial/api-design.htmlreference/rescaffold.html→ the currentalpha generatecommand documentation- The old
kubebuilder-toolsbucket appears to be deprecated. The current Artifacts documentation explains the newer approach. - Source-code references such as
pkg/plugin/bundle.go,pkg/plugins/golang/v4, and the Grafana plugin appear to have corresponding locations in the current GitHub repository.
However, I have not assumed that every old URL should simply be redirected to a similarly named page. Some links may have been intentionally removed or their context may have changed.
Expected outcome
It would be great to either:
- Update these links to their current locations where an equivalent page/file exists, or
- Remove links where the referenced content is no longer maintained/relevant.
I'm happy to submit a PR for the fixes if this issue is accepted.
Thanks for maintaining the Kubebuilder documentation!
Source: kubernetes-sigs/kubebuilder