Added linkcheck to makefile #2403

anshuman-agarwala · 2025-06-26T06:35:44Z

What this PR does / why we need it:
Added linkcheck to makefile

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

/area provider/ibmcloud

Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.

Release note:

Added linkcheck to makefile

netlify · 2025-06-26T06:35:49Z

✅ Deploy Preview for kubernetes-sigs-cluster-api-ibmcloud ready!

Name	Link
🔨 Latest commit	`0a003bc`
🔍 Latest deploy log	https://app.netlify.com/projects/kubernetes-sigs-cluster-api-ibmcloud/deploys/68ad3ddb49b4a20008d52986
😎 Deploy Preview	https://deploy-preview-2403.cluster-api-ibmcloud.sigs.k8s.io
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

k8s-ci-robot · 2025-06-26T06:35:53Z

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.

mkumatag · 2025-06-26T07:07:01Z

@anshuman-agarwala can you mention more information about why we choose this linter and see if there are any other linters exists for the k8s docs and reuse that here!

btw: this image is in docker hub and we may hit with image pull rate limit issue while running it in the k8s cicd infra

Prajyot-Parab · 2025-06-30T13:41:41Z

can check (ref - https://github.com/kubernetes/website/blob/main/scripts/linkchecker.py), not sure if this would help us in having something similar

anshuman-agarwala · 2025-07-14T05:32:05Z

@mkumatag I've changed the linter since the earlier one was only hosted on dockerhub.
The current linter I have used is being consumed in other sigs projects as well: https://github.com/search?q=org%3Akubernetes-sigs%20markdown-link-check&type=code

Amulyam24 · 2025-07-16T06:30:21Z

/ok-to-test

Amulyam24

@anshuman-agarwala, what do you think about adding linkcheck and yamllint as a part of make verify checks ?

anshuman-agarwala · 2025-07-16T06:37:22Z

@anshuman-agarwala, what do you think about adding linkcheck and yamllint as a part of make verify checks ?

That makes sense, I'll add it.

Prajyot-Parab · 2025-08-21T19:21:38Z

@anshuman-agarwala any updates on this one?

anshuman-agarwala · 2025-08-21T23:30:47Z

Hi @Prajyot-Parab This PR is blocked till we approve the PR for enabling DIND in test-infra

mkumatag · 2025-08-22T05:11:47Z

/retest-required

Amulyam24 · 2025-08-22T05:49:43Z

/retest

mkumatag · 2025-08-22T07:55:26Z

I still see this error: docker: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running? but we need to check if docker daemon is really getting started in this prow job or any additional step required to take care of that!

Amulyam24 · 2025-08-22T08:55:33Z

/close

k8s-ci-robot · 2025-08-22T08:55:39Z

@Amulyam24: Closed this PR.

In response to this:

/close

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.

Amulyam24 · 2025-08-22T08:55:45Z

/open

Amulyam24 · 2025-08-22T09:36:29Z

/retest

Amulyam24 · 2025-08-22T10:20:18Z

@anshuman-agarwala, we need to run runner.sh in the job to enable docker. Thanks a lot @Rajalakshmi-Girish for helping with the issue. I shall create a PR for it and we can retrigger the verify job post its merge.

Rajalakshmi-Girish · 2025-08-22T13:22:24Z

/test pull-cluster-api-provider-ibmcloud-verify

Rajalakshmi-Girish · 2025-08-22T13:38:38Z

@Amulyam24 seems like https://prow.k8s.io/view/gs/kubernetes-ci-logs/pr-logs/pull/kubernetes-sigs_cluster-api-provider-ibmcloud/2403/pull-cluster-api-provider-ibmcloud-verify/1958882459022004224 failed for a different reason. DinD error is solved now.

mkumatag · 2025-08-22T13:47:39Z

Makefile

+CURR_DIR := $(shell pwd)
+.PHONY: verify-yamllint
+verify-yamllint:
+	@docker run --rm $$(tty -s && echo "-it" || echo) -v $(CURR_DIR):/data cytopia/yamllint:latest /data --config-file /data/.yamllint --no-warnings


the input device is not a TTY

may be this error is because of this tty statement here in this line

The tty error was because I had added -it for local testing, removing it fixed the error.

anshuman-agarwala · 2025-08-22T15:26:16Z

The job works as expected now, it's failing due to broken links in the docs.
Thanks a lot @Amulyam24 @Rajalakshmi-Girish

Prajyot-Parab · 2025-08-22T16:11:37Z

@mkumatag now that the linkcheck is working and reporting broken links, I think we can add the relevant fixes as part of this PR itself to pass the required check (and close the other PR).

Prajyot-Parab · 2025-08-22T16:12:23Z

Makefile

+MD_FILES := $(shell find . -iname "*.md")
+.PHONY: verify-linkcheck
+verify-linkcheck:
+	docker run --init -w /input -v $(CURR_DIR):/input ghcr.io/tcort/markdown-link-check:3.12 -q -p $(MD_FILES)


Suggested change

docker run --init -w /input -v $(CURR_DIR):/input ghcr.io/tcort/markdown-link-check:3.12 -q -p $(MD_FILES)

@docker run --init -w /input -v $(CURR_DIR):/input ghcr.io/tcort/markdown-link-check:3.12 -q -p $(MD_FILES)

mkumatag · 2025-08-22T18:27:08Z

@mkumatag now that the linkcheck is working and reporting broken links, I think we can add the relevant fixes as part of this PR itself to pass the required check (and close the other PR).

let us fix all of these issues :)

anshuman-agarwala · 2025-08-23T09:04:43Z

I've fixed the reported issues, all links should be reachable now.

docs/book/src/developer/conversion.md

docs/book/src/developer/dependencies.md

docs/book/src/developer/index.md

docs/book/src/developer/tilt.md

docs/book/src/topics/vpc/creating-a-cluster.md

docs/book/src/introduction.md

mkumatag · 2025-08-25T05:13:58Z

Looking at the above errors/fixes - we may need to limit the scope of this validation,!

…erify

mkumatag

I'm merging this PR for now, lets tackle the comments which are not addressed in a separate one

/lgtm

k8s-ci-robot · 2025-08-28T07:10:06Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: anshuman-agarwala, mkumatag

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [mkumatag]

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 added the area/provider/ibmcloud Issues or PRs related to ibmcloud provider label Jun 26, 2025

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 26, 2025

k8s-ci-robot requested review from Amulyam24 and mkumatag June 26, 2025 06:35

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 26, 2025

anshuman-agarwala mentioned this pull request Jun 26, 2025

Added link check and fixed broken links in doc #2399

Closed

anshuman-agarwala force-pushed the linkcheck-make branch from 22848bc to a4f2f81 Compare July 14, 2025 05:27

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 16, 2025

Amulyam24 reviewed Jul 16, 2025

View reviewed changes

anshuman-agarwala force-pushed the linkcheck-make branch from a4f2f81 to 834913f Compare July 16, 2025 06:45

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 16, 2025

anshuman-agarwala force-pushed the linkcheck-make branch 2 times, most recently from 7f22515 to b5c07a0 Compare July 18, 2025 04:19

anshuman-agarwala mentioned this pull request Aug 22, 2025

Enabled dind in capi ibm verify job kubernetes/test-infra#35039

Merged

mkumatag closed this Aug 22, 2025

k8s-ci-robot closed this Aug 22, 2025

Prajyot-Parab reopened this Aug 22, 2025

mkumatag requested changes Aug 22, 2025

View reviewed changes

anshuman-agarwala force-pushed the linkcheck-make branch from b5c07a0 to c64bce1 Compare August 22, 2025 15:15

Prajyot-Parab reviewed Aug 22, 2025

View reviewed changes

anshuman-agarwala force-pushed the linkcheck-make branch from c64bce1 to 9848bb8 Compare August 23, 2025 08:44

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 23, 2025

mkumatag requested changes Aug 25, 2025

View reviewed changes

Added linkcheck action to makefile, Added yamllint and linkcheck to v…

0a003bc

…erify

anshuman-agarwala force-pushed the linkcheck-make branch from 9848bb8 to 0a003bc Compare August 26, 2025 04:53

mkumatag approved these changes Aug 28, 2025

View reviewed changes

k8s-ci-robot assigned mkumatag Aug 28, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 28, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 28, 2025

k8s-ci-robot merged commit 87be6f7 into kubernetes-sigs:main Aug 28, 2025
13 checks passed

anshuman-agarwala mentioned this pull request Sep 10, 2025

REQUEST: New membership for anshuman-agarwala kubernetes/org#5827

Open

11 tasks

	docker run --init -w /input -v $(CURR_DIR):/input ghcr.io/tcort/markdown-link-check:3.12 -q -p $(MD_FILES)
	@docker run --init -w /input -v $(CURR_DIR):/input ghcr.io/tcort/markdown-link-check:3.12 -q -p $(MD_FILES)

Added linkcheck to makefile #2403

Added linkcheck to makefile #2403

Uh oh!

Conversation

anshuman-agarwala commented Jun 26, 2025

Uh oh!

netlify bot commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for kubernetes-sigs-cluster-api-ibmcloud ready!

Uh oh!

k8s-ci-robot commented Jun 26, 2025

Uh oh!

mkumatag commented Jun 26, 2025

Uh oh!

Prajyot-Parab commented Jun 30, 2025

Uh oh!

anshuman-agarwala commented Jul 14, 2025

Uh oh!

Amulyam24 commented Jul 16, 2025

Uh oh!

Amulyam24 left a comment • 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!

anshuman-agarwala commented Jul 16, 2025

Uh oh!

Prajyot-Parab commented Aug 21, 2025

Uh oh!

anshuman-agarwala commented Aug 21, 2025

Uh oh!

mkumatag commented Aug 22, 2025

Uh oh!

Amulyam24 commented Aug 22, 2025

Uh oh!

mkumatag commented Aug 22, 2025

Uh oh!

Amulyam24 commented Aug 22, 2025

Uh oh!

k8s-ci-robot commented Aug 22, 2025

Uh oh!

Amulyam24 commented Aug 22, 2025

Uh oh!

Amulyam24 commented Aug 22, 2025

Uh oh!

Amulyam24 commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Rajalakshmi-Girish commented Aug 22, 2025

Uh oh!

Rajalakshmi-Girish commented Aug 22, 2025

Uh oh!

mkumatag Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

anshuman-agarwala Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

anshuman-agarwala commented Aug 22, 2025

Uh oh!

Prajyot-Parab commented Aug 22, 2025

Uh oh!

Prajyot-Parab Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

anshuman-agarwala Aug 23, 2025

Choose a reason for hiding this comment

Uh oh!

mkumatag commented Aug 22, 2025

Uh oh!

anshuman-agarwala commented Aug 23, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

netlify bot commented Jun 26, 2025 •

edited

Loading

Amulyam24 left a comment •

edited

Loading

Amulyam24 commented Aug 22, 2025 •

edited

Loading