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.

Sign up for GitHub

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

Jump to bottom

chore: update README #40

Merged
merged 2 commits into from
May 2, 2024
Merged

chore: update README #40

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad9e34b
chore: update README
lstocchi Apr 29, 2024
28fb197
Update README.md
lstocchi May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,36 @@
# podman-desktop-extension-minikube
# Minikube Extension

The Minikube extension adds support for https://minikube.sigs.k8s.io/docs/. It allows users to create Kubernetes clusters running on top of the container engine.

## Topics
- [Installation](#installation)
- [Contributing](#contributing)
- [Feedback](#feedback)

## Installation

You can install the Minikube extension directly inside Podman Desktop.

Go to Extensions > Catalog > Install minikube.

![](https://github.com/containers/podman-desktop-media/raw/minikube/gifs/install_minikube_extension.gif)

## Contributing

Want to help develop and contribute to the Minikube extension?

You can use `yarn watch --extension-folder` from the Podman Desktop directory to automatically rebuild and test the Minikube extension:

```sh
git clone https://github.com/containers/podman-desktop
git clone https://github.com/containers/podman-desktop-extension-minikube
cd podman-desktop-extension-minikube
yarn install
yarn build
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm wondering if we should not have yarn watch on this first terminal

as we're developing this extension, probably it should be in watch mode ?

Copy link
Contributor

Choose a reason for hiding this comment

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

I did review but forgot the submit button....

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Something like ?

If you are live editing the extension, from podman-desktop-extension-minikube folder, just use:

yarn watch

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Or you prefer having yarn watch above?

Copy link
Contributor

Choose a reason for hiding this comment

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

for contributing I would expect to have watch mode for the extension b/c else I may think it won't work, that my changes are not being used, etc.

lstocchi marked this conversation as resolved.
Show resolved Hide resolved
cd ../podman-desktop
yarn watch --extension-folder ../podman-desktop-extension-minikube
```

## Feedback

You can provide your feedback on the extension by creating [an issue on this repository](https://github.com/containers/podman-desktop-extension-minikube/issues).
Loading