search

kubernetes-sigs / reference-docs

Tools to build reference documentation for Kubernetes APIs and CLIs.
Apache License 2.0
89 stars 105 forks source link

[gen-apidocs] fix missing definitions #336

Closed xrstf closed 1 year ago

xrstf commented 1 year ago

I misunderstood how the TOC is used to assemble all individual concept and definition files, which lead to the bug that currently, none of the standalone definitions are included in the index.html. This PR fixes this by removing the "comment stuff out"-hack and instead adding a dedicated Sparse property, which will not put a TOC item into the nav tree.

Sorry for the PR spam :/

tengqm commented 1 year ago

/lgtm /approve

k8s-ci-robot commented 1 year ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm, xrstf

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

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubernetes-sigs/reference-docs/blob/master/OWNERS)~~ [tengqm] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment