CLOUDP-336726: Autogenerate API Docs

[roothorp]

Summary

Use CRDoc to generate CRD API docs.
This is using go tool to install crdoc.
GitHub Actions also checks that the API docs are updated when creating a PR, similar to the existing checks for CRDs themselves.

Proof of Work

Checklist

• Have you linked a jira ticket and/or is the ticket in the title?
• Have you checked whether your jira ticket required DOCSP changes?
• Have you checked for release_note changes?
• Have you signed our CLA?

Reminder (Please remove this when merging)

• Please try to Approve or Reject Changes the PR, keep PRs in review as short as possible
• Remember the following Communication Standards - use comment prefixes for clarity:
  • blocking: Must be addressed before approval.
  • follow-up: Can be addressed in a later PR or ticket.
  • q: Clarifying question.
  • nit: Non-blocking suggestions.
  • note: Side-note, non-actionable. Example: Praise
  • --> no prefix is considered a question

[s-urbaniak]

this is very cool but this should not be main go.mod

[s-urbaniak]

let's put this as a separate go.mod in tools/crdoc

[josvazg]

FYI: I know we decided this, but I am making some experiments and go-licenses does seem to correctly ignore tools with troublesome licenses, as they are not part of the project product. Here is an example in the experiment PR #2716 has golangci-lint (GPLv3) managed within the main go.mod.

My suggestion here, don't change this back leave it in tools/toolbox and will take care of this change as part of the mentioned PR if we decided using main is safe and has a better DX (Developer eXperience).

[s-urbaniak]

we cannot merge until the TD is LGTM'ed

[josvazg]

Code LGTM as of now, but also waiting on the TD

[josvazg]

LGTM, but needs rebase. I will approve once conflicts are solved