Skip to content

Fix ContainerStatus section in Pod API reference#56463

Open
tamilselvanp57 wants to merge 2 commits into
kubernetes:mainfrom
tamilselvanp57:fix-containerstatus-doc
Open

Fix ContainerStatus section in Pod API reference#56463
tamilselvanp57 wants to merge 2 commits into
kubernetes:mainfrom
tamilselvanp57:fix-containerstatus-doc

Conversation

@tamilselvanp57

Copy link
Copy Markdown

What this PR does

This PR fixes the ContainerStatus section in the Pod API reference.

The previous content incorrectly displayed fields from PodList. This change replaces it with the correct ContainerStatus documentation generated from the API reference source.

Issue

Fixes the incorrect ContainerStatus documentation in:
content/en/docs/reference/kubernetes-api/core/pod-v1.md

#56427

@linux-foundation-easycla

linux-foundation-easycla Bot commented Jul 10, 2026

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: tamilselvanp57 / name: Tamilselvan padmanaban (89b0c09)

@kubernetes-prow kubernetes-prow Bot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jul 10, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

Welcome @tamilselvanp57!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kernel-kun for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow kubernetes-prow Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 10, 2026
@kubernetes-prow kubernetes-prow Bot requested review from salaxander and tengqm July 10, 2026 16:46
@kubernetes-prow kubernetes-prow Bot added language/en Issues or PRs related to English language cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 10, 2026
@kubernetes-prow kubernetes-prow Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 11, 2026
@tamilselvanp57 tamilselvanp57 force-pushed the fix-containerstatus-doc branch from 1e63ffc to 5b5736f Compare July 11, 2026 09:51
@netlify

netlify Bot commented Jul 11, 2026

Copy link
Copy Markdown

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 1e63ffc
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6a5211f256dab500084a2263
😎 Deploy Preview https://deploy-preview-56463--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Jul 11, 2026

Copy link
Copy Markdown

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 5b5736f
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6a521217a939f400083bae68
😎 Deploy Preview https://deploy-preview-56463--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@tamilselvanp57

Copy link
Copy Markdown
Author

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.
Preview link: https://deploy-preview-56463--kubernetes-io-main-staging.netlify.app/docs/reference/kubernetes-api/core/pod-v1/

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@dipesh-rawat

Copy link
Copy Markdown
Member

/hold

PR is modifying the auto generated page directly.
Refer #56463 (comment)
(Okay to unhold when the updates to auto-generated page(s) are removed.)

@kubernetes-prow kubernetes-prow Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. language/en Issues or PRs related to English language size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants