How can I contribute in "advanced" mode?

Authors: orcid logoSaskia Hiltemann avatar Saskia Hiltemann orcid logoHelena Rasche avatar Helena Rasche Add Contributions!

Most of the content is written in GitHub Flavored Markdown with some metadata (or variables) found in YAML files. Everything is stored on our GitHub repository. Each training material is related to a topic. All training materials (slides, tutorials, etc) related to a topic are found in a dedicated directory (e.g. transcriptomics directory contains the material related to transcriptomic analysis). Each topic has the following structure:

Structure of the repository

  • a metadata file in YAML format
  • a directory with the topic introduction slide deck in Markdown with introductions to the topic

  • a directory with the tutorials:

    Inside the tutorials directory, each tutorial related to the topic has its own subdirectory with several files:

    • a tutorial file written in Markdown with hands-on
    • an optional slides file in Markdown with slides to support the tutorial
    • a directory with Galaxy Interactive Tours to reproduce the tutorial
    • a directory with workflows extracted from the tutorial
    • a YAML file with the links to the input data needed for the tutorial
    • a YAML file with the description of needed tools to run the tutorial
  • a directory with the Dockerfile describing the details to build a container for the topic (self-study environments).

To manage changes, we use GitHub flow based on Pull Requests (check our tutorial):

  1. Create a fork of this repository on GitHub
  2. Clone your fork of this repository to create a local copy on your computer and initialize the required submodules (git submodule init and git submodule update)
  3. Create a new branch in your local copy for each significant change
  4. Commit the changes in that branch
  5. Push that branch to your fork on GitHub
  6. Submit a pull request from that branch to the original repository
  7. If you receive feedback, make changes in your local clone and push them to your branch on GitHub: the pull request will update automatically
  8. Pull requests will be merged by the training team members after at least one other person has reviewed the Pull request and approved it.

Globally, the process of development of new content is open and transparent:

  1. Creation of a branch derived from the main branch of the GitHub repository
  2. Initialization of a new directory for the tutorial
  3. Filling of the metadata with title, questions, learning objectives, etc
  4. Generation of the input dataset for the tutorial
  5. Filling of the tutorial content
  6. Extraction of the workflows of the tutorial
  7. Automatic extraction of the required tools to populate the tool file
  8. Automatic annotation of the public Galaxy servers
  9. Generation of an interactive tour for the tutorial with the Tourbuilder web-browser extension
  10. Upload of the datasets to Zenodo and addition of the links in the data library file.
  11. Once ready, opening a Pull Request
  12. Automatic checks of the changes are automatically checked for the right format and working links using continuous integration testing on Travis CI
  13. Review of the content by several other instructors via discussions
  14. After the review process, merge of the content into the main branch, starting a series of automatic steps triggered by Travis CI
  15. Regeneration of the website and publication on https://training.galaxyproject.org/training-material/
  16. Generation of PDF artifacts of the tutorials and slides and upload on the FTP server
  17. Population of TeSS, the ELIXIR’s Training Portal, via the metadata

Development process

To learn how to add new content, check out our series of tutorials on creating new content:

  1. Contributing with GitHub via command-line
  2. Overview of the Galaxy Training Material
  3. Creating Interactive Galaxy Tours
  4. Including a new topic
  5. Teaching Python
  6. GTN Metadata
  7. Tools, Data, and Workflows for tutorials
  8. Running the GTN website online using GitHub CodeSpaces
  9. Adding Quizzes to your Tutorial
  10. Adding auto-generated video to your slides
  11. Principles of learning and how they apply to training and teaching
  12. Design and plan session, course, materials
  13. Running the GTN website online using GitPod
  14. FAIR-by-Design methodology
  15. Contributing with GitHub via its interface
  16. Updating diffs in admin training
  17. Generating PDF artefacts of the website
  18. Running the GTN website locally using the command line
  19. Creating a new tutorial
  20. Single Cell Publication - Data Plotting
  21. FAIR Galaxy Training Material
  22. Single Cell Publication - Data Analysis
  23. Creating content in Markdown
  24. Creating Slides
  25. Updating tool versions in a tutorial

We also strongly recommend you read and follow The Carpentries recommendations on lesson design and lesson writing if you plan to add or change some training materials, and also to check the structure of the training material above.

Persistent URL
Resource PURL: https://gxy.io/GTN:F00141
Still have questions?
Gitter Chat Support
Galaxy Help Forum