search

kubernetes-sigs / reference-docs

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

Cleanup lint issues in Go code, improve error handling #328

Closed xrstf closed 10 months ago

xrstf commented 10 months 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. genref also received a new kube_deps.go to prevent a go mod tidy from removing all the k8s dependencies.

If desired, I can break this down into individual PRs per app.

k8s-ci-robot commented 10 months ago

Welcome @xrstf!

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

k8s-ci-robot commented 10 months ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

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

@xrstf Thank you for this huge effort. Please consider split the PR on a per-tool basis so we can quickly review them and get them in.

xrstf commented 10 months ago

Split this PR into