Skip to content
This repository has been archived by the owner on Nov 29, 2017. It is now read-only.

Latest commit

 

History

History
126 lines (80 loc) · 6.09 KB

CONTRIBUTING.md

File metadata and controls

126 lines (80 loc) · 6.09 KB

General process overview

The first step will be to get the code.

If you are a collaborator at the SciLifeLab GitHub organization it's easiest if you just clone the repo and if not, fork it.

Once you have the code, create a branch /project/my-awesome-project to work in and open a pull request at GitHub. You can continue to push changes before merging the code. The pull request can be used for general discussion. To make everything super easy, it is great if you provide some details on the project like links to the public code repository and documentation here as well.

Once you feel OK with the result and the code has been validated to work by lets say 2 other people, we will merge your code and the public site will update automatically.

Setup (optional)

It is recommended (but not required) to setup Jekyll so that you can view the resulting website as you compose your project page.

You first need ruby installed on your system.

Next we install our ruby dependencies.

If you get file permission errors, prefix the commands with sudo to run as an administrator.

	$ gem install jekyll
	$ bundle install

If you get the error -bash: bundle: command not found you need install it (gem install bundle), then log out and in again.

Now you should be prepared to serve the site locally.

	$ jekyll serve --watch

The --watch option will watch for changes to file and recompile the static assets automatically. Quite handy when you are writing your project page or altering SASS files.

See the Jekyll Documentation for more information.

Vagrant

You can also use Vagrant to setup development. This is nice since you don't need to mess with you system. With Vagrant, if you are perhaps a Python guy or gal, you don't need to set up a local Ruby environment (or touch the system Ruby install).

When you have Vagrant properly set up, run:

	$ cd /path/to/scilifelab.github.io
	$ vagrant up
	$ vagrant ssh
	$ cd /vagrant
	$ jekyll serve --watch --port 8087

You should now be able to open a web browser and view the site on the URL: http://0.0.0.0:8087/.

Adding a project page

Each project page is defined in a Jekyll post (markdown + YAML) and optionally a few assets.

Step 1: Adding a new project page

To add a new project page to the repository/site do the following.

  1. Duplicate the template file

    1. You'll find it in the _posts directory. Name your copy <year>-<month>-<day>-<project name>.markdown.

  2. Edit the YAML properties at the top of the file

  3. Special assets (optional) There are a list of special assets that optionally belong to each of the projects. They are all defied in the YAML portion of the project markdown file.

Step 2: Project branding

A project icon can be picked as shown by on the list of projects. The easiest solution is picking an icon from one the characters provided in the Entypo icon font. Find your corresponding class name in the Entypo css file.

A more flexible solution is to provide your own icon as a .png or .svg file. Replace the "icon" key in the post-file for a "icon_img" field and type in the relative path to where you put the image from the "img"-folder. E.g. if you put the file under img/my_project/my-icon.png you would write:

icon_img: my_project/my-icon.png

It's highly recommended that you compose a poster image for your project. It doesn't have to be very difficult, just include 1) a large background image and 2) your project logo.

  1. Consider an abstract or somewhat simple image. You can easily find great public domain photos online.

Don't worry too much about the file size - ~300-400 KB is totally fine. Make sure it is at least 1600x800 pixels. Finally, please consider running the background image through a [JPG minifier][jpegreducer] before commiting it to the repository.

  1. A Project logo can be composed with relatively cheap tools like Sketch, Keynote, or Powerpoint. If you want something even simpler you can check out Squarespace Logo.

Please look for options to export your logo in the vector format SVG. You future proof your logo to work great on all screens (infinite scalability), it's a drop-in replacement for a regular (binary) PNG file, and you keep the size of the image as small as possible.

Step 3: Write the body of project page

It should include:

  • a brief usage guide or reference to your main documentaion
  • an installation guide
  • Licensing information

Write the content in Markdown. It's a simple markup language used at GitHub and elsewhere. You can find many different tutorials.

The only difference from regular Markdown is when you want to add code blocks. They take this form:

{% highlight python %}

def some_function(argument):
    """Super function!"""
    return argument.split(',')

{% endhighlight %}

If you are having trouble figuring it out, just take a look at the source for another project page or this README file.

Finally, if you want to use any other assets like images inline with you text you should commit them to the repository. Store them in the img folder under a separate project directory for sanity.

Developing SASS

GitHub supports SCSS compilation, just commit the updates to the SCSS-files.