Skip to content

Commit 029dec1

Browse files
ebrahimebrahimjcfr
authored andcommitted
doc: Update local dev instructions to use ruby Docker image
The previous instructions used the gh-pages Docker image which includes Jekyll 3.x, but slicer.org now uses Jekyll 4.3 with bulma-clean-theme which requires Jekyll >= 4.3. Updated instructions to use the standard ruby:3.1 Docker image instead, which properly supports the project's dependencies.
1 parent 931cc7d commit 029dec1

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

README.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -114,29 +114,22 @@ _The following instructions assumes you have docker installed. On Windows, you m
114114
115115
3. Update files in the directory `slicer.org` with you proposed changes.
116116
117-
4. Prepare the build environment creating the `gh-pages` docker image
118-
119-
```
120-
git clone git@github.com:github/pages-gem.git
121-
cd pages-gem
122-
make image
123-
```
124-
125-
_For more details, see https://github.com/github/pages-gem#docker_
126-
127-
5. "Run" the build environment by shelling into the the `gh-pages` docker image.
117+
4. "Run" the build environment by shelling into a Ruby docker container.
128118
129119
```
130120
cd /path/to/slicer.org
131121
docker run -ti --rm \
132122
-p 4000:4000 \
133123
-v `realpath .`:/src/site \
134-
gh-pages bash
124+
-w /src/site \
125+
ruby:3.1 bash
135126
```
136127
137128
5. Generate and serve the website
138129
139130
```
131+
apt-get update && apt-get install -y build-essential
132+
140133
bundle install
141134
142135
git config --global --add safe.directory /src/site

0 commit comments

Comments
 (0)