API Documentation for Testkube CRDs

[AndrewUnderwoodAtFanatics]

Is your feature request related to a problem? Please describe.
In order to facilitate easier adoption of the GitOps deployment methodologies supported by Testkube it would be great to have solid documentation around what options are available for configuration in the Testkube CRDs.

I have a Git repo setup to deploy Test objects to my cluster via Flux, but now to write the Test definitions that I want to deploy, I need to manually create the test in the Testkube UI, go to settings, and export the test definition and tweak it to suit.

Describe the solution you'd like
More robust documentation of the CRDs would be helpful for those who want to approch the creation of tests from a GitOps perspective instead of via the UI or CLI. A subset of the existing test types do have CRD examples but not all and some are out of date, still showing git-file and git-directories as distinct options.

I would hold the thoroughness of the FluxCD CRD documentation as goals to aim for:

https://fluxcd.io/flux/components/kustomize/kustomization/
https://fluxcd.io/flux/components/helm/helmreleases/

[vsukhin]

Hey @AndrewUnderwoodAtFanatics Right now we do a lot of efforts to improve our docs. This is really cool suggestion, guess @aabedraba and @tkonieczny will work on it

[TheBrunoLopes]

Hello @AndrewUnderwoodAtFanatics really good point and thanks for opening the issue.
We will working on it asap

[aabedraba]

Related to #3537 (comment)

Will be implemented by End of next week.

[aabedraba]

This is blocked.
Issue described here: #3537 (comment)