Fix ContainerStatus section in Pod API reference#56463
Conversation
|
|
|
Welcome @tamilselvanp57! |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
1e63ffc to
5b5736f
Compare
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Netlify preview is passing (build, header rules, and redirect rules all green). Verified the fix directly on the deploy preview — the ContainerStatus section now correctly shows its own fields (name, image, imageID, containerID, state, lastState, ready, restartCount, started) instead of PodList's fields, and renders as a proper table matching the rest of the page. |
There was a problem hiding this comment.
This reference page for "Pod" is automatically generated from upstream source. We should fix this either in the generator or in the upstream API definition rather than updating the generated page directly.
Please see the upstream contribution guide:https://kubernetes.io/docs/contribute/generate-ref-docs/contribute-upstream
There was a problem hiding this comment.
Thanks for the review and for the link — that makes sense. I'll trace this back to confirm whether this is a stale-regeneration issue or an actual bug in the reference-docs generator/upstream source, and follow the correct process rather than editing the generated page directly. Will update here once I've confirmed the root cause.
There was a problem hiding this comment.
Thanks again for the pointer. I traced this through api-ref-generator (the reference-docs submodule pinned in this repo) to understand the actual generation path. I found that the pinned gen-resourcesdocs config for v1.31 doesn't list ContainerStatus in Pod's otherDefinitions, which per that tool's own docs would mean it's inlined into PodStatus — not rendered as its own section. That, plus the output format mismatch (that tool produces markdown bullets, not the HTML tables the live page uses), suggests the live site is actually built by a different/newer generator path than what's vendored here.
Could you point me to the actual source/tool that currently generates this page format, so I can regenerate it correctly rather than editing it by hand? Happy to open the upstream fix once I know where it lives.
|
/hold PR is modifying the auto generated page directly. |
What this PR does
This PR fixes the
ContainerStatussection in the Pod API reference.The previous content incorrectly displayed fields from
PodList. This change replaces it with the correctContainerStatusdocumentation generated from the API reference source.Issue
Fixes the incorrect
ContainerStatusdocumentation in:content/en/docs/reference/kubernetes-api/core/pod-v1.md#56427