Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add explanations for all minikube error codes #11555

Closed
sharifelgamal opened this issue Jun 1, 2021 · 6 comments · Fixed by #11773
Closed

Add explanations for all minikube error codes #11555

sharifelgamal opened this issue Jun 1, 2021 · 6 comments · Fixed by #11773
Assignees
Labels
area/error-management Management of known errors help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Milestone

Comments

@sharifelgamal
Copy link
Collaborator

We now populate documentation for all error/exit codes at https://minikube.sigs.k8s.io/docs/contrib/errorcodes/, but most of them don't have a comment explaining what they are. We should add those.

@sharifelgamal sharifelgamal added kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. area/error-management Management of known errors labels Jun 1, 2021
@sharifelgamal sharifelgamal added this to the 1.22.0-candidate milestone Jun 1, 2021
@sharifelgamal sharifelgamal self-assigned this Jun 1, 2021
@sharifelgamal sharifelgamal added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Jun 7, 2021
@sharmarajdaksh
Copy link
Contributor

Hey @sharifelgamal, I can work on this if you could let me know some way to understand the meaning of the error codes. TIA!

@sharifelgamal
Copy link
Collaborator Author

sharifelgamal commented Jun 15, 2021

@sharmarajdaksh, my plan was to go through the code and for each error string and figure out where in the code it was called, then describe to type of error.

So for example, MK_INTERRUPTED is only used with reason.Interrupted (as seen in https://github.com/kubernetes/minikube/blob/master/pkg/minikube/reason/reason.go#L67), which is only used in https://github.com/kubernetes/minikube/blob/master/cmd/minikube/cmd/mount.go#L188. This tells us the MK_INTERRUPTED is only used when minikube was interrupted by Ctrl+C or some other signal. So we would add a comment above https://github.com/kubernetes/minikube/blob/master/pkg/minikube/reason/reason.go#L67 saying something like // minikube was interrupted by a signal.

If you're still interested in doing some work on this (it doesn't have to cover everything), please let me know and I can assign this to you.

@sharmarajdaksh
Copy link
Contributor

sharmarajdaksh commented Jun 17, 2021

I see. It might take a bit for me to get a general idea of the codebase, but I think I can slowly make way through these exit codes and work on this issue.

@sharifelgamal
Copy link
Collaborator Author

Sounds great! Don't hesitate to reach out if you have questions.

@sharmarajdaksh
Copy link
Contributor

sharmarajdaksh commented Jun 22, 2021

@sharifelgamal one thing that I'm not sure about:
Should I just be adding these comments to https://github.com/kubernetes/minikube/blob/master/pkg/minikube/reason/reason.go
Or should I be also adding these error descriptions to https://github.com/kubernetes/minikube/blob/master/site/content/en/docs/contrib/errorcodes.en.md?

@sharifelgamal
Copy link
Collaborator Author

Add them as comments in https://github.com/kubernetes/minikube/blob/master/pkg/minikube/reason/reason.go, we have machinery to automatically add it to the documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/error-management Management of known errors help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants