Skip to content

Commit 4c3e8f4

Browse files
committed
Use "container" instead of Docker when possible in start.md
1 parent d70bc21 commit 4c3e8f4

File tree

1 file changed

+38
-19
lines changed

1 file changed

+38
-19
lines changed

docs/source/start.md

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,62 @@
22

33
This tutorial guides you through installing `repo2docker` and building your first environment image.
44

5-
(install)=
5+
## Prerequisite
66

7-
## Install `repo2docker`
7+
### Python
8+
9+
`repo2docker` requires Python 3.6 or above.
810

9-
repo2docker requires Python 3.6 or above on Linux and macOS.
11+
### Container Engine
1012

11-
:::{admonition} Windows support is experimental
13+
`repo2docker` requires a container engine compatible with the specification published by the [Open Container Initiative](https://opencontainers.org/).
1214

13-
This [article about using Windows and the WSL](https://nickjanetakis.com/blog/setting-up-docker-for-windows-and-wsl-to-work-flawlessly) (Windows Subsystem for Linux or
14-
Bash on Windows) provides additional information about Windows and Docker.
15-
:::
15+
#### Docker
16+
17+
```{important}
18+
Only the [Docker Engine](https://docs.docker.com/engine/) is an open source. [Docker Desktop](https://docs.docker.com/get-started/get-docker/) requires a license.
19+
```
1620

17-
### Prerequisite: Install Docker
21+
Follow [Docker's official installation steps](https://docs.docker.com/get-started/get-docker/).
1822

19-
Install [Docker](https://www.docker.com), as it is required to build Docker images.
20-
The [Community Edition](https://docs.docker.com/install/) is available for free.
23+
#### Podman
2124

22-
Recent versions of Docker are recommended.
25+
Follow [Podman's official installation steps](https://podman.io/docs/installation).
26+
27+
(install)=
28+
29+
## Install `repo2docker`
2330

2431
### Install `repo2docker` with `pip`
2532

26-
We recommend installing `repo2docker` with the `pip` tool:
33+
It is recommend to install `repo2docker` with the `pip` tool:
2734

28-
```
35+
```bash
2936
python3 -m pip install jupyter-repo2docker
3037
```
3138

3239
(usage)=
3340

3441
## Build a repository with `repo2docker`
3542

36-
Now that you've installed Docker and `repo2docker`, we can build a repository.
37-
To do so, follow these steps.
43+
Now that you've installed a container engine and `repo2docker`, you can build a repository.
44+
To do so, continue following this guide.
45+
46+
### Start the container engine
47+
48+
Ensure that the container engine is running.
49+
50+
#### Docker
3851

39-
### Start Docker
52+
Follow the [offcial instructions for starting Docker](https://docs.docker.com/engine/daemon/start/).
4053

41-
Follow the [instructions for starting Docker](https://docs.docker.com/engine/daemon/start/) to start a Docker process.
54+
#### Podman
55+
56+
Run
57+
58+
```bash
59+
podman info
60+
```
4261

4362
### Build an image from a URL
4463

@@ -51,12 +70,12 @@ jupyter-repo2docker https://github.com/binder-examples/requirements
5170
You'll see `repo2docker` take the following actions:
5271

5372
1. Inspect the repository for [configuration files](#config-files). It will detect the `requirements.txt` file in the repository.
54-
2. Build a Docker image using the configuration files. In this case, the `requirements.txt` file will correspond to a Python environment.
73+
2. Build a container image using the configuration files. In this case, the `requirements.txt` file will correspond to a Python environment.
5574
3. Run the image to let you explore the repository interactively.
5675

5776
Click the link provided and you'll be taken to an interactive Jupyter Notebook interface where you can run commands interactively inside the environment.
5877

5978
## Learn more
6079

6180
This is a simple example building an environment image for your repository.
62-
To learn more about the kinds of source repositories, environments, and use-cases that repo2docker supports, see [the `repo2docker` user guide](./use/index.md).
81+
To learn more about the kinds of source repositories, environments, and use-cases that `repo2docker` supports, see [the `repo2docker` user guide](./use/index.md).

0 commit comments

Comments
 (0)