training-material
training-material copied to clipboard
Update collections tutorial to meet GTN stylistic standards
https://training.galaxyproject.org/training-material/topics/galaxy-interface/tutorials/collections/tutorial.html#processing-data-organized-as-a-collection needs to be updated, there are a few low hanging fruit for anyone wanting to help!
- Hands on activities need to be in hands on boxes (from linked section)
- They need to use the standard layout for "import data" that is used across tutorials
- Remove videos
- Remove screenshots
- Remove "Click execute"
- Improve figure captions which are not sufficient for a visually impaired user. what's appropriate for alt-text vs captions in the GTN Contributing Guide
- Fix rST style image (
.. image:: ${static_path}/images/tools/collection_ops/filter_empty.svg :width: 500 :alt: Filtering empty datasets
) - Fix tool references to use modern GTN tool referencing guide on how to do it
Hi Helena, I'd love to take care of this low hanging fruits as well! How could I proceed to do so? I saw that galaxy requires either Mac or Unix/Linux but I'm on Windows. Would installing Windows Subsystem for Linux (WSL). and running galaxy on it be good of use? Or do you have another approach to do so? Thanks in advance
Hi @mariipia10, you can use any public Galaxy server to test the tutorial on Galaxy (usegalaxy.org or usegalaxy.eu). For contributing to the tutorial itself, you can build the website using GitPod: https://training.galaxyproject.org/training-material/topics/contributing/tutorials/gitpod/tutorial.html (no need for Linux then)
Hi @bebatut and @hexylena I'm reviewing this issue again and I have a couple of questions on some tasks
- Hands on activities need to be in hands on boxes (from linked section)
Could you explain a bit further what this means? I checked on other tutorials but I can't seem to grasp what it should look when done correctly
They need to use the standard layout for "import data" that is used across tutorials
Something like this down below, correct?
- Remove videos
- Remove screenshots
Is just removing them completely is fine or should they be replaced with something else?
Hi @mariipia10
Hands on activities need to be in hands on boxes (from linked section)
Could you explain a bit further what this means? I checked on other tutorials but I can't seem to grasp what it should look when done correctly
Of course! So like in the screenshot you posted above the step is just in the tutorial to import the data, it isn't in a hands-on box like in other tutorials.
Not in a hands-on box | Correctly in a hands-on box |
---|---|
![]() |
![]() |
We really want to make it clear to students that these are steps they should execute, and this is one of the very few tutorials in the entire GTN that doesn't do it properly, so, students who are familiar with the GTN may miss steps they really need to do because it isn't in the proper box.
They need to use the standard layout for "import data" that is used across tutorials
Something like this down below, correct?
yeah! All of the rest of our upload steps look like this: they have the URLs, they use the tip box for importing via link and then the tip box for importing from the library.
Is just removing them completely is fine or should they be replaced with something else?
Videos should be removed completely, we plan a different integration for videos during November. Screenshots of the tool form need to be removed as well because they are not accessible and we have made a significant effort to standardise how we describe tools. So all of these are against our guidelines:
Hi @hexylena @mariipia10 i am available to assist to get this done
Hi sandy, okay thanks! I'll reach out if I happen to get stuck somewhere :) @hexylena Awesome thank you very much for the clarification!
Hi @mariipia10 how is this coming on?
@bebatut I will like to work on this
Hi Sandy wanna work with the first two list item? Sorry I didn't get back to you I'm full on hectic with mid.terms and final season, I wanted to make a big commit with everything in the list but those two are the ones I havent done yet! "Hands on activities need to be in hands on boxes (from linked section)" "They need to use the standard layout for "import data" that is used across tutorials"
I have one or two figure captions to complete and the rest of the list is ready on my side
Noted @mariipia10