From 6cf5185aba48aabe0e92fcc3fae77ccc18356e0f Mon Sep 17 00:00:00 2001 From: Kareem Farid Date: Wed, 26 Jun 2024 11:19:32 +0300 Subject: [PATCH] Add docker upgrade instructions to docs Signed-off-by: Kareem Farid --- .../getting_started/installation/installation_linux.md | 4 ++++ .../getting_started/installation/installation_macos.md | 8 ++++++++ .../getting_started/installation/installation_ubuntu.md | 5 +++++ .../getting_started/installation/installation_win.md | 5 +++++ 4 files changed, 22 insertions(+) diff --git a/docs/source/getting_started/installation/installation_linux.md b/docs/source/getting_started/installation/installation_linux.md index 47349db4a..e4b46aed6 100644 --- a/docs/source/getting_started/installation/installation_linux.md +++ b/docs/source/getting_started/installation/installation_linux.md @@ -23,6 +23,10 @@ supported. First, install Docker following the steps provided [in this link](https://docs.docker.com/engine/install/). +:::{note} +Make sure Docker is up to date with the latest release provided by your distribution. +::: + Test if installation was successful: ``` diff --git a/docs/source/getting_started/installation/installation_macos.md b/docs/source/getting_started/installation/installation_macos.md index af54aaa76..1bbb95204 100644 --- a/docs/source/getting_started/installation/installation_macos.md +++ b/docs/source/getting_started/installation/installation_macos.md @@ -12,5 +12,13 @@ brew install python make brew install --cask docker ``` +If brew and the dependencies are already installed, make sure they are up to date: + +```sh +brew update +brew upgrade python make +brew upgrade --cask docker +``` + ```{include} installation_common_section.md ``` diff --git a/docs/source/getting_started/installation/installation_ubuntu.md b/docs/source/getting_started/installation/installation_ubuntu.md index 0f97a7d24..6748e2575 100644 --- a/docs/source/getting_started/installation/installation_ubuntu.md +++ b/docs/source/getting_started/installation/installation_ubuntu.md @@ -13,6 +13,11 @@ Only Ubuntu 20.04 and above are supported. Next, install Docker. Follow [the instructions provided in the Docker documentation here](https://docs.docker.com/engine/install/ubuntu/) as the steps provided below might be outdated. +:::{note} +If Docker is already installed, make sure that it is up to date by +[following these instructions in the Docker documentation](https://docs.docker.com/engine/install/ubuntu/#upgrade-docker-engine-1) +::: + :::{warning} The steps below might become outdated, it is encouraged to follow the link to the official Docker documentation. ::: diff --git a/docs/source/getting_started/installation/installation_win.md b/docs/source/getting_started/installation/installation_win.md index 20d0ded3c..bbb978eba 100644 --- a/docs/source/getting_started/installation/installation_win.md +++ b/docs/source/getting_started/installation/installation_win.md @@ -10,6 +10,11 @@ The following is the recommended installation method under Windows. Other virtua 1. Follow [official Microsoft documentation for WSL located here](https://docs.microsoft.com/en-us/windows/wsl/install) to install the WSL 2. Make sure your OS version supports WSL 2. 2. Follow [official steps to Install Docker Desktop on Windows located here](https://docs.docker.com/desktop/install/windows-install/). + + :::{note} + Make sure to update Docker if it is already installed. + ::: + 3. Make sure that `WSL 2 Docker engine` is enabled and `Settings` -> `Resource` -> `WSL Integration` is enabled 4. Make sure that option `Start Docker Desktop when you login` is enabled in `Docker Desktop` -> `Settings`