Skip to content

Commit ef902be

Browse files
bghillBrandon Hill
andauthored
Updates instructions on how to contribute to the documentation. (#291)
* Updates instructions on how to contribute to the documentation. * Fixes typos in update to contribution documentation * Eliminates whitespace --------- Co-authored-by: Brandon Hill <[email protected]>
1 parent 95c5612 commit ef902be

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/_docs/contributing/docs.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,22 @@ cd {{ site.reponame }}/
4141
### Install a local Jekyll server
4242
This step is required if you want to render your work locally before committing the changes. This is highly recommended to ensure that your changes will render properly and will be accepted.
4343

44+
Jekyll requires Ruby. This project uses an older version of Jekyll, and thus requires an older version of Ruby (v2.7.8 seems to work). <a href="https://github.com/rbenv/rbenv">rbenv</a> is suggested to manage Ruby versions. On OS X, this looks like:
45+
46+
```bash
47+
brew install rbenv
48+
rbenv init
49+
rbenv install 2.7.8
50+
cd docs
51+
rbenv local 2.7.8
52+
```
53+
This requires a new shell after installing rbenv (it modifies your shell profile). The last line sets Ruby 2.7.8 to be the Ruby version used within the docs directory. A second shell restart may be needed again, after that line. Test your active Ruby version with `ruby -v`. Once working, you install the needed plugins with (from the deid/docs directory):
54+
4455
```bash
45-
brew install ruby
46-
gem install jekyll
47-
gem install bundler
4856
bundle install
4957
```
5058

51-
Now you can see the site locally by running the server with jekyll:
59+
Now you can see the site locally by running the server with Jekyll:
5260

5361
```bash
5462
bundle exec jekyll serve

0 commit comments

Comments
 (0)