It’s so great that you want to contribute! The documentation here includes information about using and developing Deid, and they are hosted on Github, meaning that you can easily contribute via a pull request.

Getting Started

Installing Dependencies

Initially (on OS X), you will need to setup Brew which is a package manager for OS X and Git. To install Brew and Git, run the following commands:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install git

If you are on Debian/Ubuntu, then you can easily install git with apt-get

apt-get update && apt-get install -y git

Fork the repo

To contribute to the web based documentation, you should obtain a GitHub account and fork the Deid Documentation repository by clicking the fork button on the top right of the page. Once forked, you will want to clone the fork of the repo to your computer. Let’s say my GitHub username is meatball:

git clone https://github.com/meatball/deid
cd deid/

Install a local Jekyll server

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.

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). rbenv is suggested to manage Ruby versions. On OS X, this looks like:

brew install rbenv
rbenv init
rbenv install 2.7.8
cd docs
rbenv local 2.7.8

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):

bundle install

Now you can see the site locally by running the server with Jekyll:

bundle exec jekyll serve

This will make the site viewable at http://localhost:4000/Deid/.