Automated documentation of RuntimeCR

[tobiscr]

Description

We want to improve our automated documentation for CRDs. Each CRD field should provide a descriptions to field.

The update of the docs on Kyma-website of a CRD has to happen for each change applied on the CRD file and be handled within the Makefile.

Also described in detail here.

Additionally, we have to ensure that each field contains the information how it should be managed:

• either via KEB
• or manually (e.g. by SRE)

At the moment this information is missing and it's not visible what the right approach, for updating a particular field, is.

AC:

• Ensure each field of our CRDs contain a description field which describes the purpose of the field.
• Any change applied to a CRD file has to trigger the update of the CRD documentation
• Ensure the Makefile includes a dedicated target to update the documentation file in our repository and commit this change
• Make sure the updated CRD documentation appears in the central Kyma documentation

Reasons

Keep CRD documentation up-to-date whenever a change occurs and provide also the information how a field should be adjusted (either be KEB or manually).

Attachments