Auto-generate docs for NGF CRDs #1754
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
refined
Requirements are refined and the issue is ready to be implemented.
size/medium
Estimated to be completed within a week
Milestone
Currently, NGF has only one CRD.
The doc for it is here https://github.com/nginxinc/nginx-gateway-fabric/blob/8612c42d8badb8e13b1baf675821350e27395c23/site/content/how-to/configuration/control-plane-configuration.md , visualized https://docs.nginx.com/nginx-gateway-fabric/how-to/configuration/control-plane-configuration/
Note how that doc describes each field of the resource.
As we add more CRDs, it will become tedious to write and maintain docs for fields. Especially considering that the source of truth (the fields + documentation for them) for documentation is go code https://github.com/nginxinc/nginx-gateway-fabric/blob/8612c42d8badb8e13b1baf675821350e27395c23/apis/v1alpha1/nginxgateway_types.go , so we will need to keep the docs in sync with the go files.
Find a way to generate docs for CRDs based on the source code.
Notes:
Example of auto-generated docs in the Gateway API -- https://gateway-api.sigs.k8s.io/reference/spec/
The text was updated successfully, but these errors were encountered: