Add suggested Training material to Tool Form

[ElectronicBlueberry]

closes #15612

Adds a "Tutorials" Section, if tutorials referencing current tool are available.
Feature can be turned off, or pointed to a custom API.

default collapsed state

expanded

How to test the changes?

(Select all options that apply)

• I've included appropriate automated tests.
• This is a refactoring of components with existing test coverage.
• Instructions for manual testing are as follows:
  1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

• I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

[nsoranzo]

Maybe it would be better if the new section goes after Help?

[ElectronicBlueberry]

Since this section only appears on a subset of tools, I fear it would be missed easily if we were to move it to the bottom. What would the benefits of putting it after Help be?

[mvdbeek]

I think it's more common that you want to look at the help or citations than the tutorial, so having it come last (or completely collapsed by default) seems like the least intrusive change.

[ElectronicBlueberry]

It is collapsed by default

[mvdbeek]

That's how it looks like for me:

I would prefer this not to be before the actual help, which is much more relevant than any of the tutorials.

[ElectronicBlueberry]

This section only appears on ~10% of tools. I fear moving a section which only appears occasionally to the bottom will make it practically invisible, especially to newcomers who would benefit the most from this feature.

[davelopez]

Just my 2 cents... It is a bad idea to also make the Help section collapsed by default? Then the tutorials can have a bit more visibility if placed at the end, and the user chooses what to read.

[mvdbeek]

Or maybe there's a way to have this in the form header ?

[martenson]

@davelopez taking it a bit further, we could make all the form sections obviously collapsible to make it easier to navigate around long instances

[bgruening]

I think it's more common that you want to look at the help or citations than the tutorial, so having it come last (or completely collapsed by default) seems like the least intrusive change.

I agree. Linking for GTN stuff is awesome, but a well-written tool help will be more useful for the user at first. Eg. just to know what this tool is doing. It is the more condensed information about this particular tool.

This section only appears on ~10% of tools. I fear moving a section which only appears occasionally to the bottom will make it practically invisible, especially to newcomers who would benefit the most from this feature.

Agreed. But I think we should approach this problem differently. Discoverability of all information in a tool form is hard and might get harder with more that we add.
What about adding some kind of ToC? I also like to idea from @mvdbeek to put it into the tool header. What about adding a hamburger menu to the tool header which offers the ToC and you can then jump to all sections? At least this should provide better visibility. The arrow button currently is somehow hidden.

[ElectronicBlueberry]

I've moved the tutorials down for now. I think the suggested changes for tool form navigation / discoverability are great, but out of scope for this PR.

I tried both moving it to the very bottom, and above the footer. I think having the tutorials below the footer looks strange, due to the footer being a distinct section from the rest of the tool form:

Above Footer

Below Footer

[nsoranzo]

I tried both moving it to the very bottom, and above the footer. I think having the tutorials below the footer looks strange, due to the footer being a distinct section from the rest of the tool form:

Agreed, both help and tutorials provide guidance and should stay close together, while citations feel more natural at the very bottom like in a scientific paper.

[bgruening]

@ElectronicBlueberry can you please rebase. We should get it in and motivate more annotations in GTN :)

[davelopez]

Looks great to me! Thank you @ElectronicBlueberry!

[dannon]

Unit test failures are an unrelated network timeout, looks good. I like the updated position in the form, thanks!

[github-actions]

This PR was merged without a "kind/" label, please correct.