Workflow Development Language Website

The main repo for the WDL Website.

GitHub: https://github.com/openwdl/openwdl.github.io

The website is built with Jekyll using the Minimal Mistakes Jekyll theme.

Getting Started

For setup and development instructions, see OpenWDL Website Instructions - Setup & Development

Contributing

Contributing to New Issues:

1. Create a new GitHub Issue
2. Fork or update your fork from the main repo.
3. In your terminal, from the main branch, create a new local branch by running git checkout -b branch-name-here
4. Edit & Commit your changes, mentioning the Issue number in your commit, e.g. git commit file-names-here -m "Fix XYZ from #99"
5. Push the changes via git push origin branch-name-here
6. Submit a pull request
7. The reviewers will either suggest additional revisions, or approve the pull request.

Editing the Site

Setup Instructions: OpenWDL Website Instructions - Setup & Development

Editing Guidelines: Editing the OpenWDL Website

The root directory contains the following important files and directories:

• _pages/ - directory for the site
• README.md - general readme for the repo.

Setup & Development

Prerequisites

You need the following in order to run the site:

• Ruby version 2.4.0 or higher, including all development headers (check your Ruby version using ruby -v)
• RubyGems (check your Gems version using gem -v)
• GCC and Make (check versions using gcc -v,g++ -v, and make -v)

For Ruby, you may need additional developer packages(e.g. ruby-dev, ruby-bundler). See the following links, for detailed instructions:

• Jekyll Docs - Installation
• macOS
• Ubuntu
• Other Linux
• Windows

Running the Site Locally

After installing the prerequisite software, in your terminal:

1. `bundle exec jekyll serve
2. In your browser, type localhost in your address bar, to view the site.

Dependencies: If you receive an error message about software dependencies, packages, gems, etc, then run bundle install or bundle update from the content directory. (Bundlr will be looking for Gemfile and Gemfile.lock, and can't run without them).