Skip to content

GTN in Galaxy#10024

Merged
dannon merged 19 commits intogalaxyproject:devfrom
hexylena:gtn-webhook
Jul 27, 2020
Merged

GTN in Galaxy#10024
dannon merged 19 commits intogalaxyproject:devfrom
hexylena:gtn-webhook

Conversation

@hexylena
Copy link
Member

@hexylena hexylena commented Jul 22, 2020

I've implemented a webhook to overlay the GTN materials in Galaxy, and provide integration with Galaxy itself.

out

Materials will be accessible from the masthead

image

And upon activation, will be rendered in the main panel.

Selection_011

The blue buttons? Those don't show up in the GTN, they're hidden and only render when the GTN is accessed within Galaxy. Upon click they will close the popup and activate the tool (or upload interface) within the UI.

The magic buttons require the additional setup of a proxy route for the GTN as the iframe needs to be on the same domain as the Galaxy server to enable this to work:

location /training-material/ {
    proxy_pass https://training.galaxyproject.org/training-material/;
}

A small price for this feature I'd argue. Otherwise, it renders the GTN without buttons.

Whenever you want to visit the GTN again, clicking the button will show the popup at the same point you were in the tutorial when you left.

@bgruening
Copy link
Member

WTF, this is awesome! Magic @hexylena!

@Slugger70
Copy link
Contributor

Bloody oath! This is an awesome idea. Grouse.

@hexylena
Copy link
Member Author

Just for the record: I think there are potentially better long term solutions where Galaxy embraces training development/creation/learning within Galaxy by merging training with workflows (á la workflow reporting) but that's a long term goal. In the short term however, this makes a real improvement for users and helps users get in touch with us + training much more easily.

I'm going to make an quick addition to test the url for the iframe: if it's loading properly /training-materials/, go with it. If not: then update the iframe for the real training materials url. They won't get the fancy "click button to run", but they'll still get the GTN directly in their Galaxy.

@shiltemann and I discussed adding a feature to run WFs from this view as well, but their usage within the tutorials is not very high (basically metagenomics/metatranscriptomics only) so we are explicitly not doing that currently.

@hexylena
Copy link
Member Author

Added a test, if /training-material/ is present, it will use that. If it isn't, then it falls back to an iframe for the public site, without the fancy click-to-run buttons, and a notice so admins can set that up if they want:

image

which links to documentation (wow, I actually bothered to write some.) Explicitly tested with /galaxy/ proxy prefix and it works OK.

I think this is potentially good to go?

@dannon
Copy link
Member

dannon commented Jul 23, 2020

Without extra route configuration (but with the webhook enabled) I'm getting an undefined error when trying to activate it; debugging now.

Okay, so this actually preloads training.galaxyproject.org (including the gitter/sidecar stuff, etc) all in an iframe on every page load. We shouldn't do this, but rather load on activation, especially if this is going to be enabled by default.

@dannon
Copy link
Member

dannon commented Jul 27, 2020

@hexylena Thanks! This is great stuff.

@dannon dannon merged commit d49bc6b into galaxyproject:dev Jul 27, 2020
@hexylena
Copy link
Member Author

Thanks so much @dannon. Looking forward to using this in my next training.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants