Onboarding for new contributors

purlPURL: https://gxy.io/GTN:
Comment: What is a Learning Pathway?
A graphic depicting a winding path from a start symbol to a trophy, with tutorials along the way
We recommend you follow the tutorials in the order presented on this page. They have been selected to fit together and build up your knowledge step by step. If a lesson has both slides and a tutorial, we recommend you start with the slides, then proceed with the tutorial.

This learning path aims to teach you how to contribute to GTN training materials. From editing typos to rendering test GTN sites, you will progress from being a user to a contributor. For support throughout these tutorials, join our Galaxy training network on Matrix to ask questions!

New to making edits or creating training materials? Follow this learning pathway to get familiar with the basics!

Module 0: Introduction to Galaxy

If you’ve never used the Galaxy interface before, you will need to take our introductory tutorial first. Here, you will get a first look at the Galaxy platform for data analysis. You only need the short introduction to enable minor contributions, but for larger contributions, you can gain more familiarity through doing both tutorials.

Time estimation: 1 hour 40 minutes

Learning Objectives
  • Learn how to upload a file
  • Learn how to use a tool
  • Learn how to view results
  • Learn how to view histories
  • Learn how to extract and run a workflow
  • Learn how to share a history
  • Familiarize yourself with the basics of Galaxy
  • Learn how to obtain data from external sources
  • Learn how to run tools
  • Learn how histories work
  • Learn how to create a workflow
  • Learn how to share your work
Lesson Slides Hands-on Recordings
A short introduction to Galaxy
Galaxy Basics for genomics

Module 1: Edit a small error

Make a minor correction to an existing training material. You will edit one page using GitHub, so find a typo and get ready!

Time estimation:

Learning Objectives
Lesson Slides Hands-on Recordings
help Making a minor correction to the GTN

Module 2: Add yourself as a contributor

While you can make minor corrections using the web-based Github interface, for larger changes (and, indeed, for building new materials altogether), you will need to work more extensively with Github. When you make larger changes, you should be acknowledged for your work - we will therefore use this Github training to also add yourself to our contributors list, so that we can acknowledge you going forward!

Time estimation: 30 minutes

Learning Objectives
  • Fork a repository on GitHub
  • Clone a remote repository locally
  • Create a branch
  • Commit changes
  • Push changes to a remote repository
  • Create a pull request
  • Update a pull request
Lesson Slides Hands-on Recordings
Contributing to the Galaxy Training Network with GitHub

Reference: Cool content

If you want to add icons, images, cool learning boxes and more, you will need to use this next resource. Treat it as the Wikipedia of building training material - it’s not meant to be a tutorial, but rather a resource to look up or scan through for ideas.

Time estimation: 15 minutes

Learning Objectives
  • Create hands-on
  • Use the different boxes
Lesson Slides Hands-on Recordings
Creating content in Markdown

Module 3: Make a larger change

You will also need to decide on a larger change to make in Galaxy! You may already have ideas on what to fix; you can reference our FAQ for ideas on what to change; or contact a Community of Practice to see if they have anything that needs doing. We will show you how to visualise those changes, and see how what you do will impact the materials. Finally, we show you had to add yourself as an editor, to acknowledge your contribution!

Time estimation: 20 minutes

Learning Objectives
  • Preview the GTN website
  • Make changes to the GTN website and preview those changes
  • Save the changes to your fork of the GTN repo
  • Create a pull request (PR) based on your changes
Lesson Slides Hands-on Recordings
help How can I get started with contributing?
Preview the GTN website as you edit your training material
help Using the new Contributions Annotation framework

Module 4: Make an even bigger change!

Tutorials often need their workflows updated to the latest set of tools. Or, you might find that you want to want to build something entirely new! Pick the tutorial that is right for you!

Time estimation: 1 hour 15 minutes

Learning Objectives
  • Implement tutorial tool version update on existing GTN material
  • Create a tutorial from scratch
  • Link a tutorial to a topic
  • Create hands-on
  • Add technical support for a tutorial
  • Create a new set of slides
  • Add presenter comments
Lesson Slides Hands-on Recordings
Updating tool versions in a tutorial
Creating a new tutorial
Creating Slides

The End!

And now you’re done! There are still loads of resources to help you improve your training conceptually or structurally.


Editorial Board

This material is reviewed by our Editorial Board:

orcid logoWendi Bacon avatar Wendi Baconorcid logoPhil Reed avatar Phil Reed