Update templates used to generate API docs#45
Conversation
| type ResourceRef struct { | ||
| // ID is the string representation of the Kubernetes resource object's metadata, | ||
| // in the format '<namespace>_<name>_<group>_<kind>'. | ||
| // in the format 'namespace_name_group_kind'. |
There was a problem hiding this comment.
I'm not sure this is a desirable change?
I'd like to keep the same as the upstream for this https://github.com/fluxcd/kustomize-controller/blob/main/api/v1beta2/inventory_types.go#L28
There was a problem hiding this comment.
When I use the generated documents in docusaurus it thinks those are html tags so it doesn't build 😅 . We can replace it after generation like in the example you had earlier?
|
Looking great! Adding some comments just before the GitOpsSet type in //+genclient
//+genclient:Namespacedas they did in the source-controller PR https://github.com/fluxcd/source-controller/pull/63/files#diff-b1b8367d38c32920880bbf7147e892f5f8d6bc59d0f64a2c0ffeed559f9a4888R150-R151 highlights the resource types you can create and brings the GitOpSet Definition up to the top which is neat. |
3 participants
No description provided.