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:05Z

[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 oomichi 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 · 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.

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 5, 2025

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Apr 5, 2025

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 added 2 commits April 9, 2025 10:10

Added linkchecker and fixed broken links

598f5b8

Removed equinix and weave providers.

6dbbf3f

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added linkchecker and fixed broken links #12107

Added linkchecker and fixed broken links #12107

anshuman-agarwala commented Apr 5, 2025

k8s-ci-robot commented Apr 5, 2025

k8s-ci-robot commented Apr 5, 2025

VannTen Apr 5, 2025

anshuman-agarwala Apr 5, 2025

VannTen Apr 5, 2025

anshuman-agarwala Apr 5, 2025

VannTen Apr 5, 2025

anshuman-agarwala Apr 5, 2025

VannTen Apr 5, 2025

anshuman-agarwala Apr 5, 2025

VannTen Apr 5, 2025

anshuman-agarwala Apr 5, 2025

VannTen Apr 7, 2025

yankay Apr 7, 2025 •

edited

Loading

tico88612 Apr 7, 2025

VannTen Apr 7, 2025

tico88612 Apr 7, 2025

VannTen Apr 5, 2025

anshuman-agarwala Apr 5, 2025 •

edited

Loading

yankay commented Apr 7, 2025

hegerdes commented Apr 28, 2025 •

edited

Loading

		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).

Added linkchecker and fixed broken links #12107

Are you sure you want to change the base?

Added linkchecker and fixed broken links #12107

Conversation

anshuman-agarwala commented Apr 5, 2025

k8s-ci-robot commented Apr 5, 2025

k8s-ci-robot commented Apr 5, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yankay Apr 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anshuman-agarwala Apr 5, 2025 • edited Loading

Choose a reason for hiding this comment

yankay commented Apr 7, 2025

hegerdes commented Apr 28, 2025 • edited Loading

yankay Apr 7, 2025 •

edited

Loading

anshuman-agarwala Apr 5, 2025 •

edited

Loading

hegerdes commented Apr 28, 2025 •

edited

Loading