Skip to content

Commit

Permalink
chore: prepare for docusaurus v3
Browse files Browse the repository at this point in the history
related to containers#4581
and https://docusaurus.io/docs/migration/v3#using-the-mdx-checker-cli
Signed-off-by: Florent Benoit <fbenoit@redhat.com>
  • Loading branch information
benoitf committed Nov 8, 2023
1 parent 54d3744 commit a53453a
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions website/blog/2022-11-17-develop-podman-using-codespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The challenges are to run a desktop tool (Podman Desktop) and running a containe

## Defining image of the container

The first thing is in the choice of the image for the container. It is possible to pick-up a default image and add some features but there is no existing feature for Podman at <https://github.com/devcontainers/features/tree/main/src> and most of the features are expecting to run on top of Debian/Ubuntu
The first thing is in the choice of the image for the container. It is possible to pick-up a default image and add some features but there is no existing feature for Podman at &lt;https://github.com/devcontainers/features/tree/main/src&gt; and most of the features are expecting to run on top of Debian/Ubuntu

If you are not interested in how to setup the image, jump to the [next section](#configure-the-devcontainer-using-devcontainerjson).

Expand Down Expand Up @@ -126,7 +126,7 @@ ENV XDG_RUNTIME_DIR=/run/user/1000

OK ! we have a custom Containerfile providing all the tools to build and run Podman Desktop (using VNC for the display), run Podman and run Electron.

The current file is available at <https://github.com/containers/podman-desktop/blob/main/.devcontainer/.parent/Containerfile>
The current file is available at &lt;https://github.com/containers/podman-desktop/blob/main/.devcontainer/.parent/Containerfile&gt;

Let's configure the DevContainer.

Expand Down Expand Up @@ -282,7 +282,7 @@ After all post-creation steps, the `Preview` browser inside the VS Code editor w

As a user, opening a workspace with all what we configured is done using a single click.

Go to <https://github.com/containers/podman-desktop> then click on the `< > Code` dropdown and click on `Create codespace on main` button.
Go to &lt;https://github.com/containers/podman-desktop&gt; then click on the `< > Code` dropdown and click on `Create codespace on main` button.

![Open Codespace](img/develop-podman-using-codespaces/codespaces-click-repository.png)

Expand Down
4 changes: 2 additions & 2 deletions website/docs/installation/macos-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can install Podman Desktop on Mac:
1. Using the .dmg file
2. Using Brew

:::infoPrerequisite
:::info[Prerequisite]
Podman Desktop requires [Podman Engine](https://docs.podman.io/en/latest/index.html). If you don't have Podman Engine installed, Podman Desktop will prompt you to do so at a later stage.
:::

Expand Down Expand Up @@ -48,7 +48,7 @@ Podman Desktop requires [Podman Engine](https://docs.podman.io/en/latest/index.h

## Installing Podman Desktop on MacOS using [brew](https://brew.sh/)

:::infoPrerequisite
:::info[Prerequisite]

- [Homebrew](https://brew.sh/)
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ With Podman Desktop, you can deploy a container to your Kubernetes cluster.
#### Prerequisites

- Your are using the Podman container engine.
- Your container, running or stopped, is available on the **Containers** page: _<your_container>_.
- You registered the Kubernetes cluster in your kubeconfig file: _<your_kubernetes_cluster>_. For example, [Creating a kind cluster](/docs/kind/creating-a-kind-cluster).
- Your container, running or stopped, is available on the **Containers** page: _&lt;your_container&gt;_.
- You registered the Kubernetes cluster in your kubeconfig file: _&lt;your_kubernetes_cluster&gt;_. For example, [Creating a kind cluster](/docs/kind/creating-a-kind-cluster).
- The Kubernetes namespace to deploy to already exists.

#### Procedure

1. Click **Podman Desktop tray > Kubernetes > Context > _<your_kubernetes_cluster>_** to set your Kubernetes context.
1. Open **Podman Desktop dashboard > <icon icon="fa-solid fa-cubes" size="lg" /> Containers > _<your_container>_** to see the **Container Details** page.
1. Click **Podman Desktop tray &gt; Kubernetes &gt; Context &gt; _&lt;your_kubernetes_cluster&gt;_** to set your Kubernetes context.
1. Open **Podman Desktop dashboard > <icon icon="fa-solid fa-cubes" size="lg" /> Containers > _&lt;your_container&gt;_** to see the **Container Details** page.
1. Click <icon icon="fa-solid fa-rocket" size="lg" /> to generate a Kubernetes pod.
1. On the **Deploy generated pod to Kubernetes** screen, choose your options:
1. **Pod Name**: edit the proposed name.
Expand Down
8 changes: 4 additions & 4 deletions website/docs/kubernetes/deploying-a-pod-to-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ With Podman Desktop, you can deploy a pod to your Kubernetes cluster.
#### Prerequisites

- Your are using the Podman container engine.
- Your pod, running or stopped, is available on the **Pods** page: _<your_pod>_.
- You registered the Kubernetes cluster in your kubeconfig file: _<your_kubernetes_cluster>_. For example, [Creating a kind cluster](/docs/kind/creating-a-kind-cluster).
- Your pod, running or stopped, is available on the **Pods** page: _&lt;your_pod&gt;_.
- You registered the Kubernetes cluster in your kubeconfig file: _&lt;your_kubernetes_cluster&gt;_. For example, [Creating a kind cluster](/docs/kind/creating-a-kind-cluster).
- The Kubernetes namespace to deploy to already exists.

#### Procedure

1. Click **Podman Desktop tray > Kubernetes > Context > _<your_kubernetes_cluster>_** to set your Kubernetes context.
1. Open **Podman Desktop dashboard > <icon icon="fa-solid fa-cubes" size="lg" /> Pods > _<your_pod>_** to see the **Pod Details** page.
1. Click **Podman Desktop tray > Kubernetes > Context > _&lt;your_kubernetes_cluster&gt;_** to set your Kubernetes context.
1. Open **Podman Desktop dashboard > <icon icon="fa-solid fa-cubes" size="lg" /> Pods > _&lt;your_pod&gt;_** to see the **Pod Details** page.
1. Click <icon icon="fa-solid fa-rocket" size="lg" /> to generate a Kubernetes pod.
1. On the **Deploy generated pod to Kubernetes** screen, choose your options:
1. **Pod Name**: edit the proposed name.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ With Podman Desktop, you can view and select your current Kubernetes context in

#### Prerequisites

- You have a Kubernetes context in your kubeconfig file: _<your_kubernetes_cluster>_.
- You have a Kubernetes context in your kubeconfig file: _&lt;your_kubernetes_cluster&gt;_.
For example, [Creating a kind cluster](/docs/kind/creating-a-kind-cluster).

#### Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ With Podman Desktop, you can view and select your current Kubernetes context.

#### Prerequisites

- You have a Kubernetes context in your kubeconfig file: _<your_kubernetes_cluster>_.
- You have a Kubernetes context in your kubeconfig file: _&lt;your_kubernetes_cluster&gt;_.
For example, [Creating a kind cluster](/docs/kind/creating-a-kind-cluster).

#### Procedure
Expand Down

0 comments on commit a53453a

Please sign in to comment.