Skip to content

Commit

Permalink
Use a definition list for terms
Browse files Browse the repository at this point in the history
Remove bold from headings since they are already bold
Troubleshooting is not a prerequisite, increase its and its children's heading level
  • Loading branch information
stevepiercy committed Nov 27, 2024
1 parent 8a8e10e commit 04cf05c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/plone-deployment/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ The principles outlined are adaptable to GitLab, Jenkins, and similar platforms.

#### Kubernetes

While the current training edition doesn’t cover Kubernetes, we anticipate its inclusion in upcoming updates.
While the current training edition doesn’t cover Kubernetes, we anticipate its inclusion in future updates.
31 changes: 17 additions & 14 deletions docs/plone-deployment/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,21 @@ myst:

Ensure a seamless learning experience by preparing your computer with the necessary software before the training commences.

## Pre-requisites
## Prerequisites

### 1. **Operating System**
### 1. Operating System

- **Linux/macOS:** A recent version is preferred. macOS users should have [Homebrew](https://brew.sh/) installed.
- **Windows:** Consider using [WSL2 with Ubuntu](https://documentation.ubuntu.com/wsl/en/latest/), though it’s not officially tested for this training.
Linux/macOS
: A recent version is preferred. macOS users should have [Homebrew](https://brew.sh/) installed.

### 2. **Code Editor**
Windows
: Consider using [WSL2 with Ubuntu](https://documentation.ubuntu.com/wsl/en/latest/), though it’s not officially tested for this training.

### 2. Code Editor

Choose a code editor you’re comfortable with, such as VSCode, PyCharm, Sublime, VI, or Emacs.

### 3. **Python**
### 3. Python

Install Python version 3.11.x or 3.12.x, ensuring that `pip` is included and updated.

Expand All @@ -40,7 +43,7 @@ python -m pip install --upgrade pipx uv
Use [Pyenv](https://github.com/pyenv/pyenv) if your system doesn’t provide the required Python version.
```

### 4. **Docker**
### 4. Docker

Ensure Docker version 27.2.0 or above is installed. Verify with:

Expand All @@ -54,7 +57,7 @@ Ensure Docker is running. Verify with:
docker ps
```

### 5. **Node and Node Tools**
### 5. Node and Node Tools

Install the latest Node LTS version using [NVM](https://github.com/nvm-sh/nvm/blob/master/README.md).

Expand All @@ -79,7 +82,7 @@ nvm use
```
````

### 6. **External Services**
### 6. External Services

#### GitHub Account

Expand All @@ -97,17 +100,17 @@ We'll use the GitHub Container Registry during the training. The concepts are al
docker login
```

### 7. **Cookieplone**
### 7. Cookieplone

The latest version of {term}`Cookieplone` will be used, and it doesn’t require a separate installation as we’ll use `pipx`.

### 8. **Make**
### 8. Make

{term}`Make` is pre-installed on most Linux distributions. For macOS, install Xcode and its command-line tools. Windows users are advised to use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) that includes `make`.

### 9. **Troubleshooting**
## Troubleshooting

#### Insufficient Docker virtual disk space
### Insufficient Docker virtual disk space

Docker requires sufficient virtual disk space to install and build images. A typical error message may be: `Could not create directory.` or anything else that mentions writing to the image.
To resolve this, use an appropriate docker system prune option, such as:
Expand All @@ -129,6 +132,6 @@ Under {guilabel}`Prefences > Resources > Advanced`, you can configure appropriat
- [Change Docker Desktop settings on Linux](https://docs.docker.com/desktop/settings/#advanced)
```

#### Insufficient Docker virtual memory
### Insufficient Docker virtual memory

Docker requires sufficient memory to install and build images. See the previous item for details.

0 comments on commit 04cf05c

Please sign in to comment.