Project

General

Profile

Actions

Idea #4566

open

[Documentation] Introduce compute workflow / pipeline concepts in user guide

Added by Tom Clegg about 10 years ago. Updated 9 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
Documentation
Target version:
Start date:
Due date:
Story points:
1.0
Release:
Release relationship:
Auto

Description

The first page about running your own compute jobs (beyond using an existing template in Workbench) dives right into the deep end with bwa-mem and some UUIDs. http://doc.arvados.org/user/topics/running-pipeline-command-line.html

Before this page we need to
  • introduce the relevant concepts of pipeline templates, pipeline instances, components, and jobs
  • mention the basic features of pipeline templates
    • how data gets passed from one job to another in a pipeline with output_of
    • how script_parameters in a pipeline template relates to workbench UI, jobs, and task processes
  • offer a couple of different scenarios, with a summary of the appropriate way to build and invoke pipelines in each case (with links to the examples on the other tutorial pages).
Actions

Also available in: Atom PDF