From a2c9b9723923892e0be07a6171a4cb5db1ff6752 Mon Sep 17 00:00:00 2001 From: Florent Benoit Date: Wed, 8 Nov 2023 18:20:25 +0100 Subject: [PATCH] chore: prepare for docusaurus v3 related to https://github.com/containers/podman-desktop/issues/4581 and https://docusaurus.io/docs/migration/v3#using-the-mdx-checker-cli Signed-off-by: Florent Benoit --- .../blog/2022-11-17-develop-podman-using-codespaces.md | 6 +++--- .../kubernetes/deploying-a-container-to-kubernetes.md | 8 ++++---- website/docs/kubernetes/deploying-a-pod-to-kubernetes.md | 8 ++++---- ...lecting-current-kubernete-context-in-the-status-bar.md | 2 +- .../viewing-and-selecting-current-kubernete-context.md | 2 +- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/website/blog/2022-11-17-develop-podman-using-codespaces.md b/website/blog/2022-11-17-develop-podman-using-codespaces.md index d6f11440c6d..c924e5b47b2 100644 --- a/website/blog/2022-11-17-develop-podman-using-codespaces.md +++ b/website/blog/2022-11-17-develop-podman-using-codespaces.md @@ -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 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 https://github.com/devcontainers/features/tree/main/src 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). @@ -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 +The current file is available at https://github.com/containers/podman-desktop/blob/main/.devcontainer/.parent/Containerfile Let's configure the DevContainer. @@ -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 then click on the `< > Code` dropdown and click on `Create codespace on main` button. +Go to https://github.com/containers/podman-desktop 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) diff --git a/website/docs/kubernetes/deploying-a-container-to-kubernetes.md b/website/docs/kubernetes/deploying-a-container-to-kubernetes.md index 1ac164d57df..0742c882d75 100644 --- a/website/docs/kubernetes/deploying-a-container-to-kubernetes.md +++ b/website/docs/kubernetes/deploying-a-container-to-kubernetes.md @@ -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: __. -- You registered the Kubernetes cluster in your kubeconfig file: __. For example, [Creating a kind cluster](/docs/kind/creating-a-kind-cluster). +- 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). - The Kubernetes namespace to deploy to already exists. #### Procedure -1. Click **Podman Desktop tray > Kubernetes > Context > __** to set your Kubernetes context. -1. Open **Podman Desktop dashboard > Containers > __** to see the **Container Details** page. +1. Click **Podman Desktop tray > Kubernetes > Context > _<your_kubernetes_cluster>_** to set your Kubernetes context. +1. Open **Podman Desktop dashboard > Containers > _<your_container>_** to see the **Container Details** page. 1. Click to generate a Kubernetes pod. 1. On the **Deploy generated pod to Kubernetes** screen, choose your options: 1. **Pod Name**: edit the proposed name. diff --git a/website/docs/kubernetes/deploying-a-pod-to-kubernetes.md b/website/docs/kubernetes/deploying-a-pod-to-kubernetes.md index 12b08dc8f8a..9f0b5cbaa04 100644 --- a/website/docs/kubernetes/deploying-a-pod-to-kubernetes.md +++ b/website/docs/kubernetes/deploying-a-pod-to-kubernetes.md @@ -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: __. -- You registered the Kubernetes cluster in your kubeconfig file: __. For example, [Creating a kind cluster](/docs/kind/creating-a-kind-cluster). +- 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). - The Kubernetes namespace to deploy to already exists. #### Procedure -1. Click **Podman Desktop tray > Kubernetes > Context > __** to set your Kubernetes context. -1. Open **Podman Desktop dashboard > Pods > __** to see the **Pod Details** page. +1. Click **Podman Desktop tray > Kubernetes > Context > _<your_kubernetes_cluster>_** to set your Kubernetes context. +1. Open **Podman Desktop dashboard > Pods > _<your_pod>_** to see the **Pod Details** page. 1. Click to generate a Kubernetes pod. 1. On the **Deploy generated pod to Kubernetes** screen, choose your options: 1. **Pod Name**: edit the proposed name. diff --git a/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.md b/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.md index 7bd6ffee85f..7fd91162021 100644 --- a/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.md +++ b/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.md @@ -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: __. +- You have a Kubernetes context in your kubeconfig file: _<your_kubernetes_cluster>_. For example, [Creating a kind cluster](/docs/kind/creating-a-kind-cluster). #### Procedure diff --git a/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md b/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md index 29a59c302e6..57967251cfe 100644 --- a/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md +++ b/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md @@ -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: __. +- You have a Kubernetes context in your kubeconfig file: _<your_kubernetes_cluster>_. For example, [Creating a kind cluster](/docs/kind/creating-a-kind-cluster). #### Procedure