galaxyproject / galaxyproject/training-material
MiniHackathon activities - BioNT Community Event & CarpentryConnect
- Dominant language
- HTML
- Stars
- 367
- Forks
- 1.1k
- Avg merge
- 16h 27m
- Merged PRs (30d)
- 49
Description
Hi Particpants! Thanks for joining our mini-hackathon! Below are some ideas for small and beginner-friendly contributions to work on, as well as contributing instructions.
## Setup
Have a look at our [contributing tutorials](https://training.galaxyproject.org/training-material/topics/contributing/), and in particular [running the GTN website locally using GitHub CodeSpaces](https://training.galaxyproject.org/training-material/topics/contributing/tutorials/running-codespaces/tutorial.html) to preview any changes you make.
## Contribution ideas
### 1. Updating screenshots
The Galaxy interface was overhauled recently, and some of the screenshot in introductory tutorials are out of sync.
Steps to contribute:
1. Pick a tutorial in the [introduction](https://training.galaxyproject.org/training-material/topics/introduction/) or [Using Galaxy and Managing your Data](https://training.galaxyproject.org/training-material/topics/galaxy-interface/) topics
3. Perform the tutorial on [GalaxyEU](https://usegalaxy.eu) (great if you're new to Galaxy!)
4. Replace any screenshots that don't match what you see on your screen
In addition to these tutorials, some [FAQS](https://training.galaxyproject.org/training-material/faqs/galaxy/) may also have outdated screenshots and/or instructions, and need an update
### 2. Adding/updating workflows
Every Galaxy tutorial should be accompanied by a Galaxy workflow, however, some older tutorials do not have this, and some tutorials have been updated without also updating the workflows, causing the two to be out of sync.
Steps to contribute:
1. Pick a tutorial from the list below (todo), follow the tutorial carefully on [Galaxy EU](https://usegalaxy.eu)
2. Once you are done, [extract a workflow from your history](https://training.galaxyproject.org/training-material/faqs/galaxy/workflows_extract_from_history.html).
3. Add this workflow to the GTN, in the `workflows/` folder of the tutorial
### 3. Enable GTN-in-Galaxy integration of a tutorial.
The GTN tutorials can be opened from within Galaxy, in so-called [tutorial-mode](https://training.galaxyproject.org/training-material/faqs/galaxy/tutorial_mode.html). When a tutorial is opened this way, any tools in hands-on boxes can be converted to buttons, which learners can click to immediately open the correct tool and version in Galaxy. This feature requires some additional information be added to the hands-on boxes of tutorials.
Steps to contribute:
1. Pick one of the tutorials in the list below (todo)
2. For each tool in each hands-on box, add the tool information (todo: link to instructions) to enable this feature
### 4. Choose your own Adventure
For the brave of heart, we could always use help:
- Testing tutorials
- Pick any tutorial that looks interesting to you, perform it on [Galaxy EU](https://usegalaxy.eu)
- Report any issues that arise, or ideas for improvements of the tutorial, fix typos, etc
- Reviewing [pull requests](https://github.com/galaxyproject/training-material/pulls) (e.g. for new tutorials)
- Fixing [issues](https://github.com/galaxyproject/training-material/issues)
- Filter on issues tagged ["help-wanted"](https://github.com/galaxyproject/training-material/labels/help-wanted), ["CoFest"](https://github.com/galaxyproject/training-material/labels/CoFest), ["newcomer-friendly"](https://github.com/galaxyproject/training-material/labels/newcomer-friendly), or ["Hacktoberfest"](https://github.com/galaxyproject/training-material/labels/hacktoberfest) or ["paper-cut"](https://github.com/galaxyproject/training-material/labels/paper-cut))
Contributor guide
Assessment
This issue has not been assessed yet.