🌱 Auto-generate API documentation from CRDs

[MahnoorAsghar]

Auto-generate API documentation from CRDs

Assisted-by: Claude
Fixes #2509

[metal3-io-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

Details

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

[tuminoid]

This is copy from IRSO's api doc generator right?

[MahnoorAsghar]

@tuminoid

This is copy from IRSO's api doc generator right?

Yes, it is

[MahnoorAsghar]

/retest-required

[MahnoorAsghar]

/retest-required

[tuminoid]

The difference between this BMO PR and IRSO here is that IRSO runs the "make manifests" as part of build Github workflow (in a VM), while BMO runs make generate as a Prow job (in a container).

The correct way for BMO would be to have it in a separate Prow job, which runs the crdoc container in Prow.

[tuminoid]

missing eol

[MahnoorAsghar]

I dont remember how docs/api-overview.md came from, it must be output from the script, but executing it right now does not create it.

[MahnoorAsghar]

For the check-links-pr job, https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#objectmeta-v1-meta is the correct url, but the crdoc container is generating v1.20 links which are indeed broken

This could be because the latest crdoc container version is 3 years old. There are 2 tagged releases on the repo after that, but no associated container images. See fybrik/crdoc#322

[MahnoorAsghar]

I could add the exclude-path option to https://github.com/metal3-io/baremetal-operator/blob/main/.github/workflows/pr-link-check.yml and https://github.com/metal3-io/project-infra/blob/1f19a2b8b926ab9bec62b1b8099cecf492d2125d/.github/workflows/pr-link-check.yml#L64
to ignore the path failures :D

[metal3-io-bot]

PR needs rebase.

Details

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.