Frequently Asked Questions
Hands-on: Defining a Learning Pathway
Learning Pathways are sets of tutorials curated by community experts to form a coherent set of lessons around a topic, building up knowledge step by step.
To define a learning pathway, create a file in the
learning-pathways/folder. An example file is also given in this folder (pathway-example.md). It should look something like this:
title: Title of your pathway
Description of the pathway. What will be covered, what are the learning objectives, etc?
Make this as thorough as possible, 1-2 paragraphs. This appears on the index page that
lists all the learning paths, and at the top of the pathway page
tags: [some, keywords, here ]
cover-image: path/to/image.png # optional cover image, defaults to GTN logo
cover-image-alt: alt text for this image
- section: "Module 1: Title"
description of the module. What will be covered, what should learners expect, etc.
- name: galaxy-intro-short
- name: galaxy-intro-101
- section: "Module 2: Title"
description of the tutorial
will be shown under the section title
- name: quality-control
- name: mapping
- name: general-introduction
- name: chloroplast-assembly
- name: "My non-GTN session"
type: hands_on # or 'slides'
# you can make as many sections as you want, with as many tutorials as you want
You can put some extra information here. Markdown syntax can be used. This is shown after the description on the pathway page, but not on the cards on the index page.
And that’s it!
We are happy to receive contributions of learning pathways! Did you teach a workshop around a topic using GTN materials? Capture the program as a learning pathways for others to reuse!
Problem: I have a notebook that I’d like to add to the GTN.
Solution: While we do not support directly adding notebooks to the GTN, as all of our notebooks are generated from the tutorial Markdown files, there is an alternative path! Instead you can:
- Use it to convert the ipynb file into a Markdown file (
jupytext notebook.ipynb --to markdown)
- Add this Markdown file to the GTN
- Fix any missing header metadata
Then the GTN’s infrastructure will automatically convert that Markdown file directly to a notebook on deployment. This approach has the advantage that Markdown files are more diff-friendly than ipynb, making it much easier to review updates to a tutorial.