galaxyproject / galaxyproject/training-material

Workflow testing vs Notebook tutorials - help

Open
#5,751 3 comments 0 reactions 0 assignees View on GitHub
single-cell Spocathon-HDR-ELIXIR
Dominant language
HTML
Stars
367
Forks
1.1k
Avg merge
16h 27m
Merged PRs (30d)
49

Description

Workflow testing is great for automatically determining whether a given workflow/tutorial works on a given server.

However, Notebook based tutorials (example: https://training.galaxyproject.org/training-material/topics/single-cell/tutorials/alevin-commandline/tutorial.html) don't have 'traditional workflows'. Nevertheless, we need the CORRECT version of a given interactive tool (JupyLab, etc.) to exist in order for the tutorial to work.

How can this check (does this correct tool version exist?) be automated?

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing workflow-testing approach and the linked single-cell tutorial. Determine how the tutorial's required interactive tool and version are represented, then define what an automated availability check should verify and how its result would indicate that the tutorial can run.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.