search

knative / client-contrib

Community contributed `kn` plugins.
Apache License 2.0
10 stars 23 forks source link

Support plugin docs auto generation #22

Open daisy-ycguo opened 4 years ago

daisy-ycguo commented 4 years ago

Support plugin docs auto generation. My idea is to generate a README.md for plugin based on two inputs:

daisy-ycguo commented 4 years ago

/assign

daisy-ycguo commented 4 years ago

@maximilien FYI

daisy-ycguo commented 4 years ago

I create a golang util to generate README.md for a plugin which includes a generated Usage part in the middle of a header and a footer. The content of header and footer are reading from docs/header.md and docs/footer.md. @maximilien and I will use this util to generate README.md for eventing source plugins.

Since the repo client-contrib is not a go module. I'm not able to find a place to put this golang util which could be shared by all plugins. I have to put it to maximilien/kn-source-pkg/pkg/util, which is a private repo. I'm seeking advice to contribute this util to some place of Knative, maybe to knative/client/lib.