Skip to content

Commit

Permalink
Add docker upgrade instructions to docs
Browse files Browse the repository at this point in the history
Signed-off-by: Kareem Farid <kareefardi@users.noreply.github.com>
  • Loading branch information
kareefardi committed Jun 26, 2024
1 parent e0d2e61 commit 6cf5185
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
Expand Down
5 changes: 5 additions & 0 deletions docs/source/getting_started/installation/installation_win.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down

0 comments on commit 6cf5185

Please sign in to comment.