Skip to content

Commit

Permalink
fix(docs): Nested alerts don't work on GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
RemiBardon committed Aug 7, 2024
1 parent 72f9336 commit 3010099
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ To launch both the XMPP server (`prose-pod-server`) and the Admin API (`prose-po
touch database.sqlite
```

> [!TIP]
> You can change the database location by setting `DATABASE_PATH` before running `docker compose up`.
Tip: You can change the database location by setting `DATABASE_PATH` before running `docker compose up`.

3. ### Copy the filesystem

Expand All @@ -47,12 +46,11 @@ To launch both the XMPP server (`prose-pod-server`) and the Admin API (`prose-po
SERVER_ROOT=./pod-fs-root docker compose up
```

> [!TIP]
> If you just want to check that the Prose Pod starts correctly, you can run:
>
> ```bash
> PROSE_CONFIG_FILE="$(pwd)/Prose-example.toml" docker compose up
> ```
Tip: If you just want to check that the Prose Pod starts correctly, you can run:

```bash
PROSE_CONFIG_FILE="$(pwd)/Prose-example.toml" docker compose up
```

### Use case: Running an ephemeral Prose Pod locally (e.g. for quick integration tests)

Expand All @@ -63,8 +61,7 @@ SERVER_ROOT=PATH_TO_SERVER_FS_ROOT \
docker compose up
```

> [!TIP]
> See [`prose-pod-api/scripts/integration-test`] for a real-life example.
See [`prose-pod-api/scripts/integration-test`] for a real-life example.

### Use case: Running an ephemeral Prose Pod on a Raspberry Pi (e.g. for complete integration tests)

Expand Down

0 comments on commit 3010099

Please sign in to comment.