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 Go lint issues, improve error handling, replace navdata generator with regular JSON encoder #333

Closed xrstf closed 1 year ago

xrstf commented 1 year ago

This PR fixes a whole lot of general linting issues, adds extra error handling, fixes some typos and replaces the navdata generator with a more generic, recursive implementation.

tengqm commented 1 year ago

/lgtm /approve Kicking this in. We can iterate later if things not working as expected.

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
xrstf commented 1 year ago

I'm looking through the scroll-apiref.js to learn more about how the navdata is used.