Project

General

Profile

Actions

Idea #9489

closed

[Documentation] Refresh User Guide

Added by Sarah Guthrie over 9 years ago. Updated about 6 years ago.

Status:
Closed
Priority:
Normal
Assigned To:
-
Category:
Documentation
Target version:
-
Start date:
06/23/2016
Due date:
Story points:
-

Description

Update User Guide:
  • Update "Running a pipeline using Workbench" to use a newer pipeline that conforms to standards - possibly Tom's GATK bcbio pipeline
  • Add an explanation about the difference between jobs and pipeline instances (preferably after "Running a pipeline using Workbench"). First time users often try to rerun jobs, then are confused when the pipeline instance vanishes and the job is not in the project they began in
  • Add a section for sharing
    • Pipeline templates: including git repositories and docker images
  • Follow standards we currently use when writing pipeline templates and crunch scripts.
  • Link to Docker documentation for writing Dockerfiles and building images

The organization of the documentation is somewhat non-intuitive. I originally wanted to include "Add a section for running a pipeline on Workbench" in this ticket, because I expected to see it right before "Run a pipeline on the command line". It is possible that a link between the two sections would help.

Actions #1

Updated by Peter Amstutz about 6 years ago

  • Status changed from New to Closed
Actions

Also available in: Atom PDF