gen-crd-api-reference-docs

gen-crd-api-reference-docs copied to clipboard

Option and code to generate AsciiDoc friendly output

4

See https://github.com/ahmetb/gen-crd-api-reference-docs/issues/44 This does not currently include the two sets of AsciiDoc templates, as I'm not sure where they should go. As noted in the issue, there is likely a...

djencks

Fix the gencrdrefdocs:force comment

1

The DocComments slice is provided without the comment prefix by gengo, so adding it to the package won't work. Here we fix it.

fedepaol

Support additional unversioned types

1

github.com/tektoncd/pipeline has an additional type in https://github.com/tektoncd/pipeline/tree/main/pkg/apis/pipeline/pod which isn't versioned, and shouldn't be its own package section in the generated doc, but is referenced in versioned packages under `pkg/apis/pipeline`. This...

abayer

For Apache Camel-K I've modified this project, adding an option to generate AsciiDoc output rather than html. The current results can be seen here: https://camel.apache.org/camel-k/next/apis/camel-k.html https://camel.apache.org/camel-k/next/apis/kamelets.html The code modifications are:...

djencks

I think we can include the template/ directory in the binary easily now with Go 1.17, and use the custom one if specified via `-template-dir` or there's a `template/` directory...

ahmetb

HTML packages produces urlencoded %2f

3

Hi there. We noticed that the output generated is producing a `%2f` encoded value instead of a `/`. That's not a problem for a browser but it can be a...

squakez

automatically link type names found in the doc comments

2

It would be a great enhancement to automatically link any API type names that are found in the doc comments. Adding a markdown link works, but it doesn't render properly...

jpeach

Add option to preserve trailing whitespace

1

I am using my own set of templates to produce Asciidoc documents. Removing all trailing whitespace from the rendered document causes problems with Asciidoc rendering so this PR adds an...

charith-elastic

Emit documentation for typed constants

2

I posted https://github.com/kubernetes-sigs/service-apis/pull/173 to generate documentation for service-apis, and I noticed that no documentation is generated for constants of an aliased type. For example, in the CRD definition, we have:...

jpeach

add support for kubebuilder v2 `kubebuilder:object:root` comment

5

The kubebuilder V2 adds `+kubebuilder:object:root` comment instead of `+genclient` comment to public types. BTW, the `+kubebuilder:object:root` is in ListTypes, while `+genclient` don't appear in ListTypes, this PR will filter out...

M00nF1sh