Instructions for installing the tools needed to contribute to Stitch Docs.

Step 1: Install Ruby

Jekyll is a Ruby Gem that can be installed on most operating systems.

To see if you have Ruby installed, open up a command line and run the following:

ruby -v

A response like the following means Ruby is already installed:

ruby 2.3.7p456 (2018-03-28 revision 63024) [universal.x86_64-darwin18]

Otherwise, you’ll first need to install Ruby to use Jekyll. Refer to the Ruby documentation for instructions for each operating system.

Step 2: Install Bundler

Next, you’ll install Bundler. Bundler is a a package manager for Ruby, allowing you to easily install and manage Ruby dependencies.

In the Terminal, run the following:

gem install bundler

Step 3: Cloning the repository

The Stitch Docs are stored in the stitchdata/docs repository on GitHub. The first step to start contributing to Stitch Docs is to clone it.

If you are using GitHub Desktop:

1. Click File>Add repository.
2. Click the URL tab and enter https://github.com/stitchdata/docs.
3. Select a folder on your machine to store the repository and click Clone.

If you are using a command line, run the following command:

git clone https://github.com/stitchdata/docs.git

Step 4: Install Jekyll

Run the following command to install Jekyll:

gem install jekyll

Step 5: Retrieve the gems needed for the docs

Go to the Stitch Docs repository on your machine, open a command line ans use the following command:

bundle install

Last updated: 22 February 2022