From 0ae39d5c92b18ac3bbc5a8dd80d7d658b7fef534 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 4 Jan 2023 13:49:16 +0100 Subject: [PATCH] docs: Consistently naming Podman and Podman Desktop (#1108) --- website/docs/intro.md | 4 ++-- website/docs/podman-compose.md | 2 +- website/docs/troubleshooting.md | 13 +++++++------ 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/website/docs/intro.md b/website/docs/intro.md index fdabeffa5cd..39d6d88f1ef 100644 --- a/website/docs/intro.md +++ b/website/docs/intro.md @@ -13,9 +13,9 @@ Get started by **[Downloading](/downloads) the product** for your Operating Syst ### What you'll need - Podman 4.x - - Check there is a podman machine running + - Check there is a Podman machine running -### Check podman CLI is working +### Check Podman CLI is working Run the development server: diff --git a/website/docs/podman-compose.md b/website/docs/podman-compose.md index 211ba086597..04c554f27c1 100644 --- a/website/docs/podman-compose.md +++ b/website/docs/podman-compose.md @@ -71,5 +71,5 @@ You can do much more such as checking logs, opening the terminal or inspecting t ## Conclusion -That is it. This is how you can use Podman Desktop for your containers generated through podman-compose. It will be really exciting to see you all developers leverage these compatibilities to build exciting applications using Podman Desktop! +That is it. This is how you can use Podman Desktop for your containers generated through `podman-compose`. It will be really exciting to see you all developers leverage these compatibilities to build exciting applications using Podman Desktop! diff --git a/website/docs/troubleshooting.md b/website/docs/troubleshooting.md index 17256bfdd56..859b9d0ae42 100644 --- a/website/docs/troubleshooting.md +++ b/website/docs/troubleshooting.md @@ -12,14 +12,15 @@ If you cannot find your issue here or in the documentation, please fill an issue #### System Requirements -The tool connects to Podman using the socket on the host on macOS and on a named pipe on Windows. This is available only on podman 4.0.2+ +The tool connects to Podman using the socket on the host on macOS and on a named pipe on Windows. +This is available only on Podman 4.0.2+ So, please check your version and update. On Windows, the named pipe is `//./pipe/docker_engine` when Docker Desktop is not installed. It will be solved by https://github.com/containers/podman/issues/13502 / https://github.com/containers/podman/pull/13655. During that time, you may start Docker Desktop so the named pipe is the one expected. #### Check connection -Check at least a podman machine is running on Windows & macOS: +Check at least a Podman machine is running on Windows & macOS: ```bash podman machine list @@ -186,7 +187,7 @@ sudo podman-mac-helper install ## Code Ready Containers -- Check that podman preset is defined. (`crc config get preset`) +- Check that Podman preset is defined. (`crc config get preset`) - Check that `crc` binary is available in the user PATH (`/usr/local/bin/crc`) - Check that `crc setup --check-only` is running without errors. @@ -220,7 +221,7 @@ This will stop the Podman Machine for you. #### Issue -If you are using an Apple Silicon and brew, you might encounter the following error when starting podman from podman desktop +If you are using an Apple Silicon and brew, you might encounter the following error when starting Podman from Podman Desktop ``` Error: qemu exited unexpectedly with exit code 1, stderr: qemu-system-x86_64: invalid accelerator hvf @@ -235,10 +236,10 @@ Podman machine is running as a x86_64 process and it could be due to a dual inst #### Solution You can -1. Uninstall podman machine on your x86_64 brew install (e.g. from a terminal running under rosetta) `brew uninstall podman-machine` +1. Uninstall Podman machine on your x86_64 brew install (e.g. from a terminal running under rosetta) `brew uninstall podman-machine` 2. or uninstall brew x86_64 as most brew receipe have now arm64 support: follow [these instructions](https://github.com/homebrew/install#uninstall-homebrew) from a terminal running under rosetta -Then run a terminal in native mode (default) and install podman machine `brew install podman-machine` +Then run a terminal in native mode (default) and install Podman machine `brew install podman-machine` Finally clean the poddman machine VMs that had been previously created, a create new ones.