Technical Guide

Edit me

How to contribute

Thank you for your interest in contributing to this effort! These SOPs are published openly with the aim of helping the greater bioinformatics community, so we love to recieve contributions. There are many ways to do so, from reporting typos, issues, suggesting content, … etc.

To make it easier, we created this guide- let’s dive in!

Credit and Contributions

We find it important that all contributors get credit for their work. Along with including your name in the yml header of your contributed effort, please make sure you also update the authors.yml to include your contact details.

Inner working of the site

This website is based on the Documentation Jekyll theme. Jekyll, written in Ruby, is a “simple, blog-aware, static site generator”.

Before proposing any changes, test your changes first by building a local copy in your computer and viewing from your own browser as below:

1. Clone down the repository (git clone https://github.com/h3abionet/H3ABionet-SOPs.git)
2. cd into the cloned directory
3. Assuming Ruby is installed¹, at the prompt, simply run bundle².
4. Run bundle exec jekyll serve to start the preview server
5. Visit localhost:4000 in your browser to preview the site

Road map

• Split lenghty pages into smaller chunks
• Create diagrams for SOP pages
• Add authors’ contact details next to the pages they contribute to
• Generate pdf files of the SOPs: Requires some commercial license, so not going to happen
• Integrate with Disqus for easy commenting
• Add license information to pages
• Add proper H3ABioNet branding

Notes