Update the project's README #214
Conversation
nwneisen
added
documentation
|
What was the problem with the minikube documentation ? It should lead to the same place, no ? https://minikube.sigs.k8s.io/docs/ https://github.com/kubernetes/minikube/releases |
|
@afbjorklund I merged before refreshing and seeing your comment I installed minikube using the getting started page. When I tried swapping cri-dockerd it gave me a number of errors. I checked the minikube version and it was older than the latest on the releases page. 1.28 if I remember correctly. I uninstalled and installed it using the 1.31 version and everything worked. Thus, I pointed people to the latest release. I can install from the getting started page again to try and get the errors but as far as I can tell the issue is it doesn't point to your latest release. |
|
I'm merging this in so I can use the dev setup for other work without having to chain branches off of this one. Since this is mostly docs I don't see a risk and will address any changes we find as the updates are used. |
|
No worries, but it seems that reason was that you installed an older release If you have the URL you used, it could be a bug somewhere with "latest" |
|
I agree. I just used the link on your getting started page and got the correct version this time. I think it might've been bad timing since I was working on this right when your latest release came out (2 weeks ago). I will be making other changes that will touch the README and I will change it to point to your docs with those changes |
|
All minikube releases are supposed to support docker (as the default container runtime), but k8s versions before 1.24 use the built-in dockershim (
|
This change is a part of #211. I rearranged the project's root README.md to prioritize someone who is coming to the project to get the latest version and install it. Not develop on the project.
I then added a section to show how to setup a machine to use minikube for developing the project. I wrote a script that gets called by a make command to make this convenient. I could probably setup this command to do hot reloading on the project but I held off for now since it creates another dependency and not everyone may want it.
Related issue:
#211
#154