kubespray icon indicating copy to clipboard operation
kubespray copied to clipboard

Added linkchecker and fixed broken links

Open anshuman-agarwala opened this issue 1 year ago • 9 comments

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

anshuman-agarwala avatar Apr 05 '25 04:04 anshuman-agarwala

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.

k8s-ci-robot avatar Apr 05 '25 04:04 k8s-ci-robot

/ok-to-test

yankay avatar Apr 07 '25 01:04 yankay

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.

hegerdes avatar Apr 28 '25 01:04 hegerdes

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

VannTen avatar May 17 '25 09:05 VannTen

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.

anshuman-agarwala avatar May 17 '25 12:05 anshuman-agarwala

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

VannTen avatar May 17 '25 12:05 VannTen

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

anshuman-agarwala avatar May 17 '25 12:05 anshuman-agarwala

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 https://github.com/kubernetes-sigs/prow/issues/194 -> this is harder on the contrib ex front.

VannTen avatar May 17 '25 14:05 VannTen

[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:

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 avatar May 20 '25 11:05 k8s-ci-robot