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

Update the project's README #214

Merged
merged 1 commit into from
Aug 1, 2023
Merged

Conversation

nwneisen
Copy link
Collaborator

@nwneisen nwneisen commented Jul 20, 2023

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

@nwneisen nwneisen added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 20, 2023
README.md Outdated Show resolved Hide resolved
@neersighted
Copy link
Collaborator

Thanks for working on this! I think this is a good step to closing #154 as well, with #215 as the second half. I'll try to find time to review next week.

@nwneisen nwneisen changed the title Add a dev setup section Update the project's README Jul 27, 2023
@afbjorklund
Copy link
Contributor

What was the problem with the minikube documentation ? It should lead to the same place, no ?

https://minikube.sigs.k8s.io/docs/
Latest Release: v1.31.1

https://github.com/kubernetes/minikube/releases
Version 1.31.1 - 2023-07-20

@nwneisen nwneisen merged commit 2968144 into Mirantis:master Aug 1, 2023
2 checks passed
@nwneisen
Copy link
Collaborator Author

nwneisen commented Aug 1, 2023

@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.

@nwneisen
Copy link
Collaborator Author

nwneisen commented Aug 1, 2023

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.

@afbjorklund
Copy link
Contributor

afbjorklund commented Aug 1, 2023

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"

@nwneisen
Copy link
Collaborator Author

nwneisen commented Aug 1, 2023

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

@afbjorklund
Copy link
Contributor

afbjorklund commented Aug 1, 2023

All minikube releases are supposed to support docker (as the default container runtime), but k8s versions before 1.24 use the built-in dockershim (/var/run/dockershim.sock) from kubelet

minikube kubernetes
v1.24.0 v1.22.3
v1.26.0 v1.24.1
v1.28.0 v1.25.3
v1.30.0 v1.26.3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants