Open cornfeedhobo opened 2 years ago
I'm not sure what you mean by this exactly. Are you proposing this information gets pulled from the page you've linked? Sounds hard
@norwoodj yeah, that's essentially what I'm suggesting - a way to say "copy the text from the official spec", which I would hope is available somewhere as markdown that is structured and can be parsed.
I think a way to better handle this would be creating a way to add code in the process. Maybe a plugin interface or similar. We need to discuss this feature more to make it more straightforward.
In case this ever gets done, I propose a simple interface:
statefulset:
# -- ``statefulset.spec.podManagementPolicy``
podManagementPolicy: ""
Then the documentation generator could pull the description from somewhere like the k8s documentation website, and link to it.
Edit: there is probably a git repo with these descriptions in a structured format, which might make it so this entire thing could be done offline.
I'm finding myself doing stuff like
This is a direct copy from the StatefulSet API docs, and I have a number of other fields that are the same.
I think it would be neat to have references that get resolved at generation time.