Skip to content

Commit aa1ea74

Browse files
authored
Merge pull request #2366 from holly-cummins/allow-local-container-serving
Do not build guides in containers so container build works
2 parents a3d6e92 + e810e4a commit aa1ea74

File tree

3 files changed

+24
-5
lines changed

3 files changed

+24
-5
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ These instructions will get you a copy of the Quarkus.io website up and running
66

77
### Installation
88

9-
#### Using Docker
9+
#### Using Docker or Podman
1010

11-
1. Install [Docker Desktop](https://docs.docker.com/install/).
11+
1. Install [Docker Desktop](https://docs.docker.com/install/) or [Podman Desktop](https://podman-desktop.io/)
1212
2. Fork the [project repository](https://github.com/quarkusio/quarkusio.github.io), then clone your fork:
1313

1414
git clone [email protected]:YOUR_USER_NAME/quarkusio.github.io.git
@@ -17,11 +17,17 @@ These instructions will get you a copy of the Quarkus.io website up and running
1717

1818
cd quarkusio.github.io
1919

20-
4. Run Docker Compose:
20+
4. Run Docker Compose or Podman Compose:
2121

2222
docker compose up
2323

24-
> **Note:** The startup process may take several minutes, depending on your system. During this time, you might see logs with warnings or configuration messages (e.g., AutoPages and asciidoctor warnings). This is normal behavior as Jekyll builds the site. Once the server is running, you will see output like this:
24+
or
25+
26+
podman compose up
27+
28+
By default, this does not include guides. To include guides, use `podman compose --file docker-compose_with_guides.yml up`, but be aware that serving guides via container is not currently working.
29+
30+
> **Note:** The startup process may take several minutes, depending on your system. During this time, you might see logs with warnings or configuration messages (e.g., AutoPages and asciidoctor warnings). This is normal behavior as Jekyll builds the site. Once the server is running, you will see output like this:
2531
2632
```
2733
jekyll-1 | Server address: http://0.0.0.0:4000/

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ services:
66
# Add --incremental to the commandline
77
# https://github.com/BretFisher/jekyll-serve/blob/2119a31476e1c6004a4bea4739b9160fc73e7bda/Dockerfile#L27C5-L27C94
88
# Also, enable dev config
9-
command: [ "bundle", "exec", "jekyll", "serve", "--force_polling", "-H", "0.0.0.0", "-P", "4000", "--incremental", "--config", "_config.yml,_config_dev.yml" ]
9+
command: [ "bundle", "exec", "jekyll", "serve", "--force_polling", "-H", "0.0.0.0", "-P", "4000", "--incremental", "--config", "_config.yml,_config_dev.yml,_noguides_config.yml" ]
1010
volumes:
1111
- .:/site:Z
1212
ports:

docker-compose_with_guides.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# no version needed since 2020
2+
3+
services:
4+
jekyll:
5+
image: docker.io/bretfisher/jekyll-serve
6+
# Add --incremental to the commandline
7+
# https://github.com/BretFisher/jekyll-serve/blob/2119a31476e1c6004a4bea4739b9160fc73e7bda/Dockerfile#L27C5-L27C94
8+
# Also, enable dev config
9+
command: [ "bundle", "exec", "jekyll", "serve", "--force_polling", "-H", "0.0.0.0", "-P", "4000", "--incremental", "--config", "_config.yml,_config_dev.yml" ]
10+
volumes:
11+
- .:/site:Z
12+
ports:
13+
- '4000:4000'

0 commit comments

Comments
 (0)