Add linter for the samples scaffolded under docs

[camilamacedo86]

What do you want to happen?

Currently, the samples scaffolded under the docs directory do not have any linting process to ensure consistency and adherence to best practices. This issue proposes adding a linter to verify the quality of the following samples:

• docs/book/src/cronjob-tutorial/testdata/project
• docs/book/src/getting-started/testdata/project
• docs/book/src/multiversion-tutorial/testdata/project

We should create an action to lint them as we have for the samples under testdata
See: https://github.com/kubernetes-sigs/kubebuilder/blob/master/.github/workflows/lint-sample.yml

in this task, we need to create the action and fix any linter issue found to ensure that it pass in the CI

Extra Labels

No response

[jongwooo]

/assign

[jongwooo]

Hi @camilamacedo86

I have a question regarding the task of adding a linter for the samples under the docs directory. I noticed in the reference workflow (lint-sample.yml) that the matrix includes paths for different samples. Would it be possible to simply add the new paths to the existing matrix in the configuration, rather than creating a completely new action?

kubebuilder/.github/workflows/lint-sample.yml

Lines 15 to 20 in 980fb71

	matrix:
	folder: [
	"testdata/project-v4",
	"testdata/project-v4-with-plugins",
	"testdata/project-v4-multigroup"
	]

I just want to confirm if this approach is acceptable before proceeding.

Thank you for your help!

[camilamacedo86]

Hi @jongwooo

Yes, we can just add the path for the docs samples on this one
The most important is to fix the issues found (if any) in the same PR/commit

We should not have more than 1 commit for this PR

[jongwooo]

I'm going to unassign myself as i clearly don't have the bandwidth to tackle the feature.

/unassign

[wazery]

/assign

[wazery]

@camilamacedo86 I am so happy and excited to submit my first PR .. looking forward for your reviews :)

[camilamacedo86]

Done !