Generate Docs from Integration Test

[csviri]

Java Operator SDK implements an integration test(s) for every feature. To make them more visible / discoverable to the users we could generate a sample index page into the documentation.

The idea would be to provide an annotation, like:

@Sample(tldr="Usage of PrimaryToSecondaryMapper", descrption="Showcases the usage of PrimaryToSecondaryMapper, in what situation it needs to be used and how to optimize typical uses with Informer indexes." )
class PrimaryToSecondaryIT {
  // details omitted
}

We would collect those test which are annotated, and generate a mardown page for the website:

[Usage of PrimaryToSecondaryMapper"](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/primarytosecondary/PrimaryToSecondaryIT.java)

Showcases the usage of PrimaryToSecondaryMapper, in what situation it needs to be used and how to optimize typical uses with Informer indexes.

[Choconaut]

Hi, could I be assigned to this?

[metacosm]

Hi, could I be assigned to this?

Done, thanks for giving it a try. Let us know if you have questions. Don't hesitate to open a PR early in draft mode so that we can follow your progress!