Skip to content

Commit e58a69f

Browse files
committed
add ruby 2.7.8 setup instructions
because current setup requires a ruby < 3.0.0 Signed-off-by: Christoph Rueger <[email protected]>
1 parent ad4fbd8 commit e58a69f

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,36 @@ To run Jekyll locally:
1313

1414
$ ./run.sh
1515

16+
## Setup local docs development environment (MacOS)
17+
18+
If just running `./run.sh` doesn't work out of the box, then most likely you have the wrong ruby version.
19+
This installation requires something like ruby 2.7.8
20+
21+
Consider doing the following:
22+
23+
- Install rbenv Ruby Version manager https://github.com/rbenv/rbenv e.g. via brew
24+
- and then use it to install and use e.g. ruby 2.7.8
25+
26+
```
27+
brew install rbenv
28+
rbenv init
29+
rbenv install 2.7.8
30+
rbenv global 2.7.8
31+
# or rbenv local 2.7.8
32+
./run.sh
33+
```
34+
35+
After a successfull start of `./run.sh` you see this:
36+
37+
```
38+
Server address: http://127.0.0.1:4000
39+
Server running... press ctrl-c to stop.
40+
```
41+
42+
Open http://127.0.0.1:4000 in your browser to see the result while developing.
43+
The server does support hot-reload so you should see changes to `.md` files immediately without restart (there are a few exceptions). Checkout the [jekyll-docs](https://jekyllrb.com/docs/pages/) to get more into the details and features.
44+
45+
1646
## Workflow
1747

1848
We use [git triangular workflow](https://www.sociomantic.com/blog/2014/05/git-triangular-workflow/).

0 commit comments

Comments
 (0)