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

feat: Add Minikube documentation #2694

Merged
merged 2 commits into from Jun 12, 2023
Merged

Conversation

afbjorklund
Copy link
Contributor

@afbjorklund afbjorklund commented May 30, 2023

What does this PR do?

This is the documentation for the minikube extension. It is rather similar to the "kind" extension.

Both Kubernetes extensions share a lot of concepts, even though the commands differ slightly.

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

Note for reviewer: this "minikube" documentation should be compared with the existing "kind" documentation:

@afbjorklund afbjorklund requested review from a team, slemeur, themr0c and benoitf as code owners May 30, 2023 21:00
@afbjorklund afbjorklund requested review from jeffmaury and cdrage and removed request for a team May 30, 2023 21:00
@benoitf
Copy link
Collaborator

benoitf commented May 31, 2023

cc @themr0c

@benoitf
Copy link
Collaborator

benoitf commented Jun 2, 2023

would be nice if we could merge some items to maybe avoid duplication but can be done as a next thing once it'll be merged.
Need to have the extension in its own repository before merging here

@afbjorklund
Copy link
Contributor Author

Now available:

ghcr.io/containers/podman-desktop-extension-minikube

Copy link
Contributor

@cdrage cdrage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the awesome documentation! I only have a few comments.

Also, minikube on all official documentation (github, https://minikube.sigs.k8s.io/docs/) is stylized as lowercase minikube not Minikube.

Unsure of the english on it, but I think minikube should be lowercase on all references? Just a small nitpick. I just remember docs teams sometimes being very specific on whether or not something is capitalized. Like how crc is not Crc and minishift is Minishift, and then microshift is MicroShift. Just a thought

@afbjorklund
Copy link
Contributor Author

afbjorklund commented Jun 10, 2023

I think it used to be a thing also in minikube, but I'm not sure it actually matters to anyone anymore...

Except for in the logo, perhaps ?

minikube logo with name

Trying to spell things like CRC or CRI-O seem to always end up failing anyway - so might as well use English.

@afbjorklund
Copy link
Contributor Author

Thanks for the awesome documentation! I only have a few comments.

Note that since most of this Kubernetes documentation has been duplicated from the Kind-specific section, most of the things being addressed applies also to that original documentation. Maybe they could be merged, in the future?

Example:

-# Configuring Podman for Kind on Windows Subsystem for Linux (WSL)
+# Configuring Podman for Minikube on Windows Subsystem for Linux (WSL)
 
 When you create a Podman machine, Podman creates the machine in rootless mode.
 
-With a Podman machine running on WSL, Kind:
+With a Podman machine running on WSL, Minikube:
 
 - Requires the rootful machine.

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
@benoitf benoitf merged commit d241686 into containers:main Jun 12, 2023
11 checks passed
@podman-desktop-bot podman-desktop-bot added this to the 1.2.0 milestone Jun 12, 2023
@afbjorklund
Copy link
Contributor Author

@benoitf : thanks, will you add some instructions on how to install the minikube extension ?

https://podman-desktop.io/docs/extensions/install

@afbjorklund afbjorklund deleted the minikube-docs branch June 12, 2023 09:17
@benoitf
Copy link
Collaborator

benoitf commented Jun 12, 2023

@afbjorklund we could replace the placeholder on https://podman-desktop.io/docs/extensions/install being quay.io/fbenoit/my-first-extension by the minikube extension
but we're still missing in extension page the list of ALL extensions, not only featured extensions

@afbjorklund
Copy link
Contributor Author

I was thinking there needs to be a link from the minikube docs, until the featured (or catalog) is in place

@benoitf
Copy link
Collaborator

benoitf commented Jun 12, 2023

@afbjorklund yes it does not prevent to have links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants