galaxyproject / galaxyproject/training-material

Create new tutorial on how to add visualizations to Galaxy

Open
#6,987 0 comments 3 reactions 1 assignee Claimed by @guerler View on GitHub
Dominant language
HTML
Stars
367
Forks
1.1k
Avg merge
16h 27m
Merged PRs (30d)
49

Description

### Issue:

Current process has been improved a great deal since 2024 but documentation on GTN hasn't kept pace. Thus, there is a bottleneck for the number of visualization/plugin submissions we can handle.

### Goals:

1. (high) Create new tutorial document covering latest Galaxy release changes for visualizations (keep old documents for older versions of Galaxy?)
2. (high) Create any missing systems that allow for increase number of visualization submissions [metric] and being added to Galaxy; more seamless submission process (may involve work with dev team).
3. (high) Sync with Special Interest Groups to assume new duties of vetting visualizations related to their field/topic and possible incentives

### Requirements:

- Reuse GTN content, diagrams where necessary - but leave old documents untouched for older Galaxy versions; do not blindly carry-over old content (like be careful on [this content about Mako files](https://training.galaxyproject.org/training-material/topics/dev/tutorials/visualization-generic/tutorial.html#hands-on-data-upload-1))
- Clarify definitions between: "visualization" and "plugin" (@guerler: we call it ‘visualizations’ its actually arbitrary javascript plugins)
- Determining if is actually something that is a viz, report, tool (see [this diagram](https://training.galaxyproject.org/training-material/topics/dev/tutorials/visualization-charts/slides-plain.html#which-should-i-use))
- Explains how to add viz to main Galaxy.* instances
- improving the integration of viz into reports and galaxy ai (@guerler)
- Getting scientific review handled by corresponding Special Interest Group before submission
- Proper way to format PR request (screenshot/GIF, refer to https://charts.galaxyproject.org/galaxy-charts/deploy-request/)
- Include way to add "highest viewed" Social Media account (so we can request cross-posting on their platform once approved/live on UseGalaxy.org)
- keep an eye on wasm based viz which in some cases can replace interactive tools. IE’s require separate containers and are often not stable (MikeS)
- Sync content with https://charts.galaxyproject.org/galaxy-charts (eg. when content complete, submit change request PRs to Galaxy-Charts owners)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.