Skip to content
This repository has been archived by the owner on Aug 2, 2023. It is now read-only.

Consider a doc generate for the Kabanero and Stack CR instances #681

Open
kaczyns opened this issue May 4, 2020 · 1 comment
Open

Consider a doc generate for the Kabanero and Stack CR instances #681

kaczyns opened this issue May 4, 2020 · 1 comment
Assignees
Labels

Comments

@kaczyns
Copy link
Member

kaczyns commented May 4, 2020

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.
@kaczyns kaczyns added the design label May 4, 2020
@kaczyns
Copy link
Member Author

kaczyns commented May 20, 2020

Issues in controller-runtime and operator-sdk seem to encourage use of this tool:
https://github.com/ahmetb/gen-crd-api-reference-docs

I am going to try it out. I suspect it's not going to format things in a way that we can incorporate into our documentation but we'll give it a try.

@kaczyns kaczyns self-assigned this May 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

1 participant