Skip to content

gallantries/workshop-template

Welcome to Gallantries: Galaxy meets the Carpentries

Find all the information about our community and projects at https://galaxy-carpentries.github.io/gallantries/.

Gitter

Welcome!

First and foremost, Welcome! 🎉 Willkommen! 🎊 Bienvenue! 🎈🎈🎈

This document (the README file) is a hub to give you some information about the project. Jump straight to one of the sections below, or just scroll down to find out more.

What are we doing?

We are working with life sciences training communities to adapt and deliver existing training materials for High Throughput Sequencing (HTS) data analysis skills needed in genomics research.

Who are we?

We think that knowledge transfer from different domains is crucial for this project hence Street Science Community consists of people with different expertise and skills. Computational- and molecular biology researchers as well as Bioinformaticians and we are all dealing with life-science problems on a daily basis, but from different angles.

What do we need?

You! In whatever way you can help.

We need expertise in fundraising, science, education, communication, interaction with the public. We'd love your feedback along the way, and of course.

Get involved

If you think you can help in any of the areas listed above (and we bet you can) or in any of the many areas that we haven't yet thought of (and here we're sure you can) then please check out our contributors' guidelines and our roadmap.

Please note that it's very important to us that we maintain a positive and supportive environment for everyone who wants to participate. When you join us we ask that you follow our code of conduct in all interactions both on and offline.

How can I generate the website locally?

You need a ruby environment (version >= 2.4). Either you have it installed and you know how to install Bundler and Jekyll and then run Jekyll, or you use (mini-)conda, a package management system that can install all these tools for you. You can install it by following the instructions on this page: https://conda.io/docs/user-guide/install/index.html

In the sequel, we assume you use miniconda.

  1. Open a terminal

  2. Clone this GitHub repository:

    git clone https://github.com/galaxy-carpentries/gallantries.git
    
  3. Navigate to the gallantries/ folder with cd

  4. Set up the conda environment:

    make create-env
    
  5. Install the project's dependencies:

    make install
    
  6. Start the website:

    make serve
    
  7. Open the website in your favorite browser at: http://127.0.0.1:4000/

Create a new blog post

To create a new blog post:

  1. Create a file in the folder _posts with a file named following the pattern yyyy-mm-dd-name.md

  2. Add some metadata on the top of the file

    ---
    layout: post
    title: <title of the post>
    author: <github id of the author>
    image: assets/images/yyyy-mm-dd-name.jpg
    ---
    
  3. Add content of the post in the file in Markdown

  4. Add images in assets/images/posts/

Create a new event

To create a new blog post:

  1. Create a file in the folder _posts with a file named following the pattern yyyy-mm-dd-name.md (with the current date)

  2. Add some metadata on the top of the file

    ---
    layout: event
    title: <title of the event>
    starts: yyyy-mm-dd
    ends: yyyy-mm-dd
    location:
        city: <city>
        country: <country>
    ---
    
  3. Add content of the event in the file in Markdown

  4. (Optional) Add images in assets/images/events/