Skip to content

Commit

Permalink
docs: use gifs, link to videos (podman-desktop#115)
Browse files Browse the repository at this point in the history
### What does this PR do?

Because we cannot directly link to raw files hosted on github, instead
use gifs and link to the video.

### Screenshot / video of UI

<!-- If this PR is changing UI, please include
screenshots or screencasts showing the difference -->

See README.md

### What issues does this PR fix or reference?

<!-- Include any related issues from Podman Desktop
repository (or from another issue tracker). -->

Closes podman-desktop#113

### How to test this PR?

See README.md, click on an image and it'll take you to the video.

<!-- Please explain steps to reproduce -->

Signed-off-by: Charlie Drage <[email protected]>
  • Loading branch information
cdrage authored Jan 30, 2024
1 parent 176b035 commit 1e0c290
Show file tree
Hide file tree
Showing 8 changed files with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,7 @@ To install go to *Settings > Extensions*. Copy and paste
`ghcr.io/containers/podman-desktop-extension-bootc` into the *Name of the image* field
and click *Install extension from the OCI image*.

<video src="https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/install_extension.mp4" controls="controls" style="max-width: 730px;"></video>

[![](/docs/img/install_extension.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/install_extension.mp4)

## Usage

Expand All @@ -116,25 +115,25 @@ FROM quay.io/centos-bootc/fedora-bootc:eln
RUN echo "root:root" | chpasswd
```

<video src="https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/build_container.mp4" controls="controls" style="max-width: 730px;"></video>
[![](/docs/img/build_container.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/build_container.mp4)

2. **Push the image:**

> IMPORTANT NOTE: This must be a **PUBLICALLY** accessible registry, this will be fixed in the future to use a local container storage
<video src="https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/push_container.mp4" controls="controls" style="max-width: 730px;"></video>
[![](/docs/img/push_container.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/push_container.mp4)

3. **Build the image:**

> Build the disk image, this takes approximatley 2-5 minutes depending on the performance of your machine.
<video src="https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/press_build.mp4" controls="controls" style="max-width: 730px;"></video>
[![](/docs/img/press_build.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/press_build.mp4)

4. **View the logs:**

> You can now view the conversion process within the Containers section
<video src="https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/watch_logs.mp4" controls="controls" style="max-width: 730px;"></video>
![](/docs/img/watch_logs.gif)

5. **Launching the VM:**

Expand All @@ -144,7 +143,7 @@ See our [Virtual Machine Guide](/docs/vm_guide.md) on how to launch the image!

> IMPORTANT NOTE: This does not represent a 1-1 conversion between container image to virtual machine image and is only meant for troubleshooting or developmental purposes.
<video src="https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/within_container.mp4" controls="controls" style="max-width: 730px;"></video>
[![](/docs/img/within_container.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/within_container.mp4)

You can also test your image within a container BEFORE converting by initiating the `init` boot sequence.

Expand Down
Binary file added docs/img/build_container.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/install_extension.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/launch_vm.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/press_build.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/push_container.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/watch_logs.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/within_container.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1e0c290

Please sign in to comment.