Skip to content

Go "Enums" are not generated with godoc into cluster_spec.md #1908

Open
@nicmorales9

Description

@nicmorales9

What happened?

In cluster_spec.md lots of helpful information is generated from struct information, however, the docgen is not setup to generate helpful information for Go "enums" such as processGroupConditionType, which does not have the values geneated for it, e.g. https://github.com/FoundationDB/fdb-kubernetes-operator/blob/main/docs/cluster_spec.md#processgroupconditiontype
It would be fantastic if the docgen code in cmd/po-docgen/api.go was extended to allow this information to get documented too, as currently users have to grep the codebase for the variables.

What did you expect to happen?

I expect all the values in cluster_spec.md to have helpful information about the possible options in a tabular form like for the structs that are autogenerated.

How can we reproduce it (as minimally and precisely as possible)?

N/A

Anything else we need to know?

No response

FDB Kubernetes operator

N/A

Kubernetes version

N/A

Cloud provider

N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions