You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Aug 2, 2023. It is now read-only.
We currently maintain doc in kabanero-io/docs that shows what can be configured in the Kabanero CR instance. It is becoming difficult to manage. We should consider alternatives.
We should investigate whether there is a canned solution here that does not link the customer to godoc, which does not help someone configure their YAML. If operator-sdk or controller-runtime has a solution here, we should probably use that.
A soup-to-nuts solution would involve (this is just an idea I had, I am sure there are other equally valid ideas that I'm not opposed to):
Add comments to the api structs which will get converted into description in the CRDs
Write some go code that can parse the CRDs and description fields
Write a template of an asciidoc file which contains the header and footer information (static intro header, and examples footer) and then insert what was parsed from the CRDs in the middle, which would essentially be a blurb about each field.
We could then run this go code offline to update the documentation, and then submit a PR to kabanero-io/docs when it needs to be updated. We'd need to keep the header/footer information synced between the two repositories, probably manually.
The text was updated successfully, but these errors were encountered:
We currently maintain doc in kabanero-io/docs that shows what can be configured in the Kabanero CR instance. It is becoming difficult to manage. We should consider alternatives.
A soup-to-nuts solution would involve (this is just an idea I had, I am sure there are other equally valid ideas that I'm not opposed to):
description
in the CRDsThe text was updated successfully, but these errors were encountered: