Render API reference using a content adapter
sftim opened this issue · comments
This is a Feature Request
What would you like to be added
[If we like the idea], use a Hugo content adapter to render our API reference pages. This may need supporting code to generate the input data.
Why is this needed
Likely benefits:
- This approach cuts the effort to localize the API reference pages, compared to the existing more manual approach.
- Content adapters let us control the layout (as in URL paths) of the generated pages, and to define the rules in code.
- By moving more of the generation into the Hugo site build, we can automatically hyperlink reference pages to related content pages (such as tutorials and concept guides).
Comments
/area web-development
We'd also need to use Hugo v0.126 or later.
This issue is currently awaiting triage.
SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.
The triage/accepted label can be added by org members by writing /triage accepted in a comment.
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.
Since this feature request will also change dependency. I would like to add one more tag.
/area dependency