Skip to content

Commit cfbedbd

Browse files
committed
Simplify docker documentation
1 parent 11286ea commit cfbedbd

4 files changed

Lines changed: 14 additions & 35 deletions

File tree

pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,7 @@ The following are needed to run the bot:
2121
1. uv: See the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/).
2222
2. [Python 3.14](https://www.python.org/downloads/): This can be installed [using uv](https://docs.astral.sh/uv/guides/install-python/#installing-python).
2323
3. Project Dependencies: Install by running `uv sync` in the command line from the root directory of the cloned repository.
24-
4. Docker.
25-
26-
<div class="card">
27-
<button type="button" class="card-header collapsible">
28-
<span class="card-header-title subtitle is-6 my-2 ml-2">Getting started with Docker</span>
29-
<span class="card-header-icon">
30-
<i class="fas fa-fw fa-angle-down title is-5" aria-hidden="true"></i>
31-
</span>
32-
</button>
33-
<div class="collapsible-content collapsed">
34-
<div class="card-content">
35-
The requirements for Docker are:
36-
<ul>
37-
<li><a href="https://docs.docker.com/install">Docker CE</a></li>
38-
<li>Docker Compose. If you're using macOS and Windows, this already comes bundled with the previous installation. Otherwise, you can download it either from the <a href="https://docs.docker.com/compose/install">website</a>, or by running <code>pip install docker-compose</code>.</li>
39-
</ul>
40-
<p class="notification is-warning">If you get any Docker related errors, reference the <a href="../docker#possible-issues">Possible Issue</a> section of the Docker page.</p>
41-
</div>
42-
</div>
43-
</div>
44-
<br>
24+
4. Docker. See [our docker guide](../docker).
4525

4626
### Set Up a Test Server
4727
The Python bot is tightly coupled with the Python Discord server, so the bot expects the existence of certain
@@ -105,7 +85,7 @@ If you want to setup the bot from an existing guild read our [manual configurati
10585
#### With Docker
10686
You are now ready to run the Python bot. The simplest way to do so is with Docker.
10787

108-
With all of the above setup, you can run the project with `docker compose up`. This will start the bot and all required services! Enter your server and type `!help` (or whatever prefix you chose instead of `!`) to see the bot in action!
88+
With all of the above setup, you can run the project with `docker compose up`. This will start the bot and all required services! Enter your server and type `!help` to see the bot in action!
10989

11090
Some other useful docker commands are as follows:
11191

pydis_site/apps/content/resources/guides/pydis-guides/contributing/docker.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: fab fa-docker
55
toc: 2
66
---
77

8-
Both our [Site](../site/) and [Bot](../bot/) projects use Docker and Docker-Compose during development in order to provide an easy to setup and consistent development environment.
8+
Both our [Site](../site/) and [Bot](../bot/) projects use Docker and Docker Compose during development in order to provide an easy to setup and consistent development environment.
99

1010
Consider reading some of the following topics if you're interested in learning more about Docker itself:
1111

@@ -15,12 +15,12 @@ Consider reading some of the following topics if you're interested in learning m
1515

1616
# Docker Installation
1717
You can find installation guides available for your respective OS from the official Docker documentation:
18-
[https://docs.docker.com/install/](https://docs.docker.com/install/)
18+
[https://docs.docker.com/get-started/get-docker/](https://docs.docker.com/get-started/get-docker/)
1919

2020
## After Installing on Linux
2121
If you're on Linux, there's a few extra things you should do:
2222

23-
1. [**Add your user to the `docker` user group so you don't have to use `sudo` when running docker or docker-compose.**](#add-user-group)
23+
1. [**Add your user to the `docker` user group so you don't have to use `sudo` when running docker**](#add-user-group)
2424
2. [**Start up the Docker service.**](#run-the-service)
2525
3. [**Set the Docker service to start on boot.**](#start-on-boot) **(optional)**
2626

@@ -67,7 +67,7 @@ Remove the existing `~/.docker/` directory. It will be automatically re-created
6767
6868
### Drive has not been shared (Windows users)
6969
70-
When attempting to run the `docker-compose up` command on a Windows machine, you receive the following or similar error message:
70+
When attempting to run the `docker compose up` command on a Windows machine, you receive the following or similar error message:
7171
```text
7272
ERROR: for bot_bot_1 Cannot create container for service bot: b'Drive has not been shared'
7373
```
@@ -85,7 +85,7 @@ Windows has not been configured to share drives with Docker.
8585
8686
3. Click "Apply" and enter appropriate Windows credentials (likely just your own account, if you have administrative privileges).
8787
88-
4. Re-run the `docker-compose up` command.
88+
4. Re-run the `docker compose up` command.
8989
9090
### Issues running on Apple Silicon
9191
@@ -104,8 +104,8 @@ DOCKER_DEFAULT_PLATFORM=linux/amd64
104104
```
105105
106106
# Compose Project Names
107-
When you launch services from a docker-compose, you'll notice the name of the containers aren't just the service name.
108-
You'll see this when launching your compose, as well as being able to be seen in the command `docker-compose ps` which will list the containers.
107+
When you launch services using Docker Compose, you'll notice the name of the containers aren't just the service name.
108+
You'll see this when launching your compose, as well as being able to be seen in the command `docker compose ps` which will list the containers.
109109
It should match something like this:
110110
```
111111
site_site_1

pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@ You should have already forked the [`site`](https://github.com/python-discord/si
1818

1919
Using Docker (recommended):
2020

21-
- [Docker CE](https://docs.docker.com/install/)
22-
- [Docker Compose](https://docs.docker.com/compose/install/)
23-
- `pip install docker-compose`
21+
- [Docker](https://docs.docker.com/get-started/get-docker/)
22+
2423

2524
Without Docker:
2625

@@ -86,7 +85,7 @@ The project can be started with Docker or by running it directly on your system.
8685
Start the containers using Docker Compose:
8786

8887
```shell
89-
docker-compose up
88+
docker compose up
9089
```
9190

9291
The `-d` option can be appended to the command to run in detached mode. This runs the containers in the background so the current terminal session is available for use with other things.
@@ -106,7 +105,7 @@ Note that this can still be done with Docker even if the webserver will be runni
106105
If you chose to use Docker for just the database, use Docker Compose to start the container:
107106

108107
```shell
109-
docker-compose up postgres
108+
docker compose up postgres
110109
```
111110

112111
If you're not using Docker, then use [pg_ctl](https://www.postgresql.org/docs/current/app-pg-ctl.html) or your system's service manager if PostgreSQL isn't already running.

pydis_site/apps/content/resources/guides/python-guides/docker-hosting-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ docker compose up -d --build
164164

165165
Now the docker will automatically build the image for you and run the container.
166166

167-
### Why docker-compose
167+
### Why Docker Compose
168168

169169
The main purpose of Compose is to run several services at once. Mostly we
170170
don't need this in discord bots, however.

0 commit comments

Comments
 (0)