Skip to content

fix(gen-apidocs): render ContainerStatus in Pod Markdown reference - #468

Open
qiujiaro wants to merge 1 commit into
kubernetes-sigs:masterfrom
qiujiaro:fix-container-status-markdown
Open

fix(gen-apidocs): render ContainerStatus in Pod Markdown reference#468
qiujiaro wants to merge 1 commit into
kubernetes-sigs:masterfrom
qiujiaro:fix-container-status-markdown

Conversation

@qiujiaro

@qiujiaro qiujiaro commented Aug 6, 2026

Copy link
Copy Markdown

Fixes #467

Related:

Check closestTopLevelHome before skipping pattern-inlined definitions. This
allows ContainerStatus to be inlined into the Pod page while preserving the
existing behavior for definitions without a unique top-level owner.

A regression test covering the ContainerStatus -> PodStatus -> Pod reference
chain is included.

@linux-foundation-easycla

linux-foundation-easycla Bot commented Aug 6, 2026

Copy link
Copy Markdown

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

  • ✅ login: qiujiaro / name: Jiarong Qiu (732a751)

@kubernetes-prow

Copy link
Copy Markdown
Contributor

Welcome @qiujiaro!

It looks like this is your first PR to kubernetes-sigs/reference-docs 🎉. 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-sigs/reference-docs 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 kubernetes-prow Bot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Aug 6, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: qiujiaro
Once this PR has been reviewed and has the lgtm label, please assign reylejano 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/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 6, 2026
@qiujiaro

qiujiaro commented Aug 6, 2026

Copy link
Copy Markdown
Author

/easycla

@kubernetes-prow kubernetes-prow Bot added 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 Aug 6, 2026
@Caesarsage

Copy link
Copy Markdown
Contributor

Thanks for the PR.

changing inline-definition classification can affect other generated API pages. Did you confirm this @qiujiaro ?

@qiujiaro

Copy link
Copy Markdown
Author

Thanks for the PR.

changing inline-definition classification can affect other generated API pages. Did you confirm this @qiujiaro ?

The generated changes are limited to these expected definition restorations #467 (comment) and did not find unrelated changes to other API pages.

m.inlinedByParent[home.Key()] = append(m.inlinedByParent[home.Key()], d)
continue
}
if d.IsInlined {

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.

can closestTopLevelHome(d) return a valid parent for all d.IsInlined definitions? if not, what cases are expected to have IsInlined == true but no top-level home?

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. 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.

gen-apidocs Markdown backend omits ContainerStatus from the Pod API reference

3 participants