Added linkchecker and fixed broken links #12107

anshuman-agarwala · 2025-04-05T04:24:56Z

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change
/kind bug

/kind cleanup

/kind design
/kind documentation
/kind failing-test
/kind feature
/kind flake

What this PR does / why we need it:
Adds linter to check links. Fixes broken links. Removes some deprecated/unneeded files.
Which issue(s) this PR fixes:

Fixes #12104

Special notes for your reviewer:
I have removed equinix metal docs since equinix is shuttering it's metal service.
I've also removed weave works docs since the service has shut down.
Does this PR introduce a user-facing change?:

NONE

k8s-ci-robot · 2025-04-05T04:25:06Z

Hi @anshuman-agarwala. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

VannTen · 2025-04-05T08:29:50Z

.github/workflows/link-checker.yml

+  linkchecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3


Please use hash-pinned action in workflows (see the other workflows).

VannTen · 2025-04-05T08:31:10Z

contrib/terraform/equinix/README.md

This probably should be at the very least in another commit, or in another PR.

Moved file deletions to a different commit.

VannTen · 2025-04-05T08:32:32Z

CONTRIBUTING.md

@@ -44,4 +44,4 @@ Vagrant with VirtualBox or libvirt driver helps you to quickly spin test cluster
 6. Sign the CNCF CLA (<https://git.k8s.io/community/CLA.md#the-contributor-license-agreement>)
 7. Submit a pull request.
 8. Work with the reviewers on their suggestions.
-9. Ensure to rebase to the HEAD of your target branch and squash un-necessary commits (<https://blog.carbonfive.com/always-squash-and-rebase-your-git-commits/>) before final merger of your contribution.
+9. Ensure to rebase to the HEAD of your target branch and squash un-necessary commits (<https://gitscripts.com/git-rebase-i-squash>) before final merger of your contribution.


This line could actually go away completely, squash should not be an automatic reflex.

Removed the line.

VannTen · 2025-04-05T08:33:21Z

docs/CSI/vsphere-csi.md

-  containers:
+  s:


This was a mistake, sorry about that.

VannTen · 2025-04-05T08:35:27Z

docs/external_storage_provisioners/cephfs_provisioner.md

-Alternatively, deploy it in kubernetes, see [deployment](deploy/README.md).
+Alternatively, deploy it in kubernetes, see [deployment](https://github.com/kubernetes-retired/external-storage/blob/master/ceph/cephfs/deploy/README.md).


I'm not sure why we're switching to external link here ?

I looked for the file this is referring to but could not find it in the repo.

Well, I don't think linking to an archived repo (for 5 years) is a good solution.
In fact, we might just scrap this entire session, I don't think having deprecated stuff in our docs is a net gain.
Wdyt @yankay @tico88612 ?

I fully agree with deprecating external-storage CephFS.

However, since there’s a significant amount of CephFS/RBD-related code, it’s unlikely we can fully deprecate it in this PR.
It would be better to handle the removal in a separate, dedicated PR :-)

I have a few ideas here.

I think these outdated applications should be removed, and I have the same view as @yankay on this. They should also be phased out by other PRs.

I want to phase out the Kubespray's built-in application installations (e.g., ArgoCD, ingress-nginx, cephfs, rbd provisioned), whose templates we should not maintain. Avoid ingress-nginx CVE-liked scenarios. Instead, it should be up to the user to decide what to install (Design and use roles/helm-apps to handle this situation), and we only provide documentation examples to guide them.

Oh I hadn't realized we had code about this has well. Let's do that in another PR them. I thought it was only the documentation left.

#12113
#12114

VannTen · 2025-04-05T08:35:46Z

docs/external_storage_provisioners/rbd_provisioner.md

@@ -52,20 +52,20 @@ The following example uses `rbd-provisioner-1` as the identity for the instance
 docker run -ti -v /root/.kube:/kube -v /var/run/kubernetes:/var/run/kubernetes --privileged --net=host quay.io/external_storage/rbd-provisioner /usr/local/bin/rbd-provisioner -master=http://127.0.0.1:8080 -kubeconfig=/kube/config -id=rbd-provisioner-1
 ```

-Alternatively, deploy it in kubernetes, see [deployment](deploy/README.md).
+Alternatively, deploy it in kubernetes, see [deployment](https://github.com/kubernetes-retired/external-storage/blob/master/ceph/cephfs/deploy/README.md).


Same as above

Same as the other one, could not find this file in the repository.

yankay · 2025-04-07T01:54:50Z

/ok-to-test

hegerdes · 2025-04-28T01:29:43Z

Just a small insight from personal experience. This link check job could get very flaky on GH hosted runners.
GH runners are often used for scraping, specially in the age of AI. They all use a fixed, publicly known Azure IP range which is shared by all GH users.

I used a link checker for my personal blog but hat to turn of the check for external links because of the many false positives I got due to being blocked by WAFs.
So maybe this job should be optional, focus on internal links or use dedicated runners which have better IP reputation.

VannTen · 2025-05-17T09:55:21Z

Are you still working on this ? I'm not sure what the delete of terraform are for ?

anshuman-agarwala · 2025-05-17T12:12:10Z

Are you still working on this ? I'm not sure what the delete of terraform are for ?

The delete in the terraform is because the equinix metal service has been shuttered: https://deploy.equinix.com/blog/an-update-on-the-latest-changes-to-metal-functionality/
I have addressed all the review comments, I'm happy to make any other changes that are required.

VannTen · 2025-05-17T12:20:56Z

Ok, but that's not exactly related to a link checker, so that shouldn't go in this PR, (but welcome in another one)

anshuman-agarwala · 2025-05-17T12:52:00Z

Ok, but that's not exactly related to a link checker, so that shouldn't go in this PR, (but welcome in another one)

Removed the terraform changes and created #12229

VannTen · 2025-05-17T13:59:53Z

README.md

@@ -227,6 +222,6 @@ See also [Network checker](docs/advanced/netcheck.md).

 [![Build graphs](https://gitlab.com/kargo-ci/kubernetes-sigs-kubespray/badges/master/pipeline.svg)](https://gitlab.com/kargo-ci/kubernetes-sigs-kubespray/-/pipelines)

-CI/end-to-end tests sponsored by: [CNCF](https://cncf.io), [Equinix Metal](https://metal.equinix.com/), [OVHcloud](https://www.ovhcloud.com/), [ELASTX](https://elastx.se/).
+CI/end-to-end tests sponsored by: [CNCF](https://cncf.io), [Equinix Metal](https://deploy.equinix.com/), [OVHcloud](https://www.ovhcloud.com/), [ELASTX](https://elastx.se/).


Equinix can be removed, and OVHcloud as well I think @ant31 ? Elastx we have the terraform job (perma-failing, but still 😆 )

Removed Equinix and OVHcloud

VannTen · 2025-05-17T14:00:38Z

contrib/terraform/openstack/README.md

- [Auro](https://auro.io/)
+- [Auro](https://www.cacloud.com/)


Just remove it, since the domain changed, no idea if the cloud behave similarly enough

Removed Auro

VannTen · 2025-05-17T14:01:37Z

docs/CNI/cilium.md

-and then open [http://localhost:12000/](http://localhost:12000/).
+and then open <http://localhost:12000/>.


What's the difference here exactly ?

It was required because the link checker was flagging the localhost links as unreachable. With this format it's ignoring these links.

Isn't that handled by the ignore file you added ?

You're right, I've reverted this change.

VannTen · 2025-05-17T14:02:58Z

docs/cloud_controllers/openstack.md

- [Auro](https://auro.io/)
+- [Auro](https://www.cacloud.com/)


Same as above (and oh, we have duplicate docs 🤷‍♂️ )

Removed Auro

VannTen · 2025-05-17T14:08:08Z

Just a small insight from personal experience. This link check job could get very flaky on GH hosted runners. GH runners are often used for scraping, specially in the age of AI. They all use a fixed, publicly known Azure IP range which is shared by all GH users.

I used a link checker for my personal blog but hat to turn of the check for external links because of the many false positives I got due to being blocked by WAFs. So maybe this job should be optional, focus on internal links or use dedicated runners which have better IP reputation.

That's a good point. There is also the matter of approval because of kubernetes-sigs/prow#194
-> this is harder on the contrib ex front.

VannTen

You need to rebase on top of current master to clear the CI stuff.

VannTen · 2025-05-17T20:11:05Z

docs/CNI/cilium.md

-and then open [http://localhost:12000/](http://localhost:12000/).
+and then open <http://localhost:12000/>.


Isn't that handled by the ignore file you added ?

k8s-ci-robot · 2025-05-20T11:02:58Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: anshuman-agarwala
Once this PR has been reviewed and has the lgtm label, please assign yankay for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

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

k8s-ci-robot requested review from MrFreezeex and yankay April 5, 2025 04:25

VannTen reviewed Apr 5, 2025

View reviewed changes

anshuman-agarwala force-pushed the link-fix branch from 414992c to 1026e78 Compare April 5, 2025 12:44

anshuman-agarwala force-pushed the link-fix branch from 1026e78 to 6dbbf3f Compare April 9, 2025 04:41

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 9, 2025

anshuman-agarwala force-pushed the link-fix branch from 6dbbf3f to 598f5b8 Compare May 17, 2025 12:51

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels May 17, 2025

VannTen reviewed May 17, 2025

View reviewed changes

anshuman-agarwala force-pushed the link-fix branch from 598f5b8 to 45d0f14 Compare May 17, 2025 15:55

VannTen reviewed May 17, 2025

View reviewed changes

Added linkchecker and fixed broken links

c2c8704

anshuman-agarwala force-pushed the link-fix branch from 45d0f14 to c2c8704 Compare May 20, 2025 11:02

		Alternatively, deploy it in kubernetes, see [deployment](deploy/README.md).
		Alternatively, deploy it in kubernetes, see [deployment](https://github.com/kubernetes-retired/external-storage/blob/master/ceph/cephfs/deploy/README.md).

		- [Auro](https://auro.io/)
		- [Auro](https://www.cacloud.com/)

		and then open [http://localhost:12000/](http://localhost:12000/).
		and then open <http://localhost:12000/>.

Added linkchecker and fixed broken links #12107

Are you sure you want to change the base?

Added linkchecker and fixed broken links #12107

Uh oh!

Conversation

anshuman-agarwala commented Apr 5, 2025

Uh oh!

k8s-ci-robot commented Apr 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yankay Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anshuman-agarwala Apr 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yankay commented Apr 7, 2025

Uh oh!

hegerdes commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

VannTen commented May 17, 2025

Uh oh!

anshuman-agarwala commented May 17, 2025

Uh oh!

VannTen commented May 17, 2025 via email

Uh oh!

anshuman-agarwala commented May 17, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yankay Apr 7, 2025 •

edited

Loading

anshuman-agarwala Apr 5, 2025 •

edited

Loading

hegerdes commented Apr 28, 2025 •

edited

Loading