Generate documentation from k8s CRDs

[mowies]

Goal

Since our CRDs already have documentation attached to them, it would be great to generate a proper API documentation out of them and put it into our docs page.
Some auto-generators like the ones listed at the bottom could be used for that.

Technical Details

• generate markdown docs from CRDs that are located under operator/config/crd (keep in mind that a kustomize command needs to be run to get the resulting yaml)
• automatically put the docs files into a folder under docs
• generate CRD docs with their corresponding API versions and have those show up in a structured way on the docs page

Other tools that could be used

https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs
https://github.com/ahmetb/gen-crd-api-reference-docs
https://github.com/elastic/crd-ref-docs
https://github.com/fybrik/crdoc

[shardulsrivastava]

@mowies I can take this up, pls assign it to me.

[mowies]

@shardulsrivastava any updates on this? :)

[shardulsrivastava]

@mowies I am onto this now, was working on this one until now #677. Will raise the PR by tmrw

[mowies]

@shardulsrivastava need any help? are still working on this?