Autogenerate CRD docs

[matthchr]

We should look into using a tool like https://github.com/ahmetb/gen-crd-api-reference-docs to generate API documentation for the CRDs.

[matthchr]

There's also this: https://github.com/crdsdev/doc

[matthchr]

Also see: kubernetes-sigs/controller-tools#240

[matthchr]

I tried to use gen-crd-api-reference-docs and wasn't above to get it to actually generate anything. It does seem to work for some projects (see cert-manager and knative), but it doesn't understand go modules I don't think, so there's some hoops you have to jump through to get it to actually output anything.

After fighting with it some I was able to get it to run, it just didn't find any modules:

~/work/github/azure-service-operator/hack/generated (master) $ /home/matthchr/go/bin/gen-crd-api-reference-docs -config ../../example-config.json -api-dir "./apis/microsoft.batch/v1alpha1api20210101" -template-dir ~/go/pkg/mod/github.com/ahmetb/gen-crd-api-reference-docs@v0.3.0/template/ -out-file docs.html -v=4

[matthchr]

We could use the same tool that Golang itself uses and run it on bare types (generated from a custom pipeline stage) and then delete everything but the generated HTML...