WIP 🌱 Auto-generate API documentation from CRDs

[MahnoorAsghar]

Auto-generate API documentation from CRDs

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.

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

[metal3-io-bot]

@MahnoorAsghar: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
shellcheck	e87422f	link	true	/test shellcheck
generate	e87422f	link	true	/test generate
test	e87422f	link	true	/test test

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.