Bug #13690
[Composer] Document install & use of Composer
100%
Description
The Arvados Composer package appears to be completely undocumented for both sysadmins and users.
Please add it to the documentation for both.
Subtasks
Related issues
Associated revisions
Merge branch '13690-composer-user-guide' closes #13690
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <pamstutz@veritasgenetics.com>
History
#1
Updated by Peter Amstutz over 2 years ago
- Assigned To set to Peter Amstutz
#2
Updated by Nico César over 2 years ago
review at 8ae6680ebae91af9b0aafd6c9cfe5e5fb97f8b12
LGTM.
#3
Updated by Peter Amstutz over 2 years ago
- Related to Story #13799: Organize manual install docs into sections added
#4
Updated by Peter Amstutz over 2 years ago
- Status changed from New to In Progress
#5
Updated by Peter Amstutz over 2 years ago
- Target version changed from 2018-07-18 Sprint to 2018-08-01 Sprint
#6
Updated by Tom Morris over 2 years ago
- Release set to 13
#7
Updated by Peter Amstutz over 2 years ago
13690-composer-user-guide @ 904e0b03fd558491d9dee39d7679a6c77eb6abd5
#8
Updated by Tom Morris over 2 years ago
- add branch points / cross-references to appropriate places in the existing command line oriented documentation (as mentioned in chat)
- Remove analysis from "The Arvados Workflow Composer is a graphical interface for building Common Workflow Language (CWL)
analysisworkflows to run on Arvados." - Need to explain that changes aren't saved automatically and how to find the Save button
- probably needs some words about what goes in the Docker repo field and how to find appropriate repos
- Step 11 - need to switch back to "Home" tab first to find "new workflow" button
- remove extra "and" in steps 13 & 15 "Drag
andfrom" - Step 19 - warn that it will take several minutes
- says "Resolving RDF schema ..." forever
- Angular ico instead of Arvados
- can't create a new destination directory from the "New workflow" dialog
- Field is labeled "Docker repository" but looks like it's actually the name:tag of a Docker image stored in Arvados
- clunky, unstyled tabs (no corner rounding, etc)
#9
Updated by Tom Morris over 2 years ago
Updated review comments after figuring out that I needed to click the save icon to get things to work.
#10
Updated by Peter Amstutz over 2 years ago
- Status changed from In Progress to Calendar
Tom Morris wrote:
Doc review:
- add branch points / cross-references to appropriate places in the existing command line oriented documentation (as mentioned in chat)
Added link on "Developing Workflows" (wasn't obvious where else it should go)
- Remove analysis from "The Arvados Workflow Composer is a graphical interface for building Common Workflow Language (CWL)
analysisworkflows to run on Arvados."
Fixed
- Need to explain that changes aren't saved automatically and how to find the Save button
Fixed
- probably needs some words about what goes in the Docker repo field and how to find appropriate repos
Done
- Step 11 - need to switch back to "Home" tab first to find "new workflow" button
Done
- remove extra "and" in steps 13 & 15 "Drag
andfrom"
Fixed
- Step 19 - warn that it will take several minutes
Done
13690-composer-user-guide @ cd5cd1855c02319ca31410943c4d944133294b17
#11
Updated by Tom Morris over 2 years ago
LGTM
#12
Updated by Peter Amstutz over 2 years ago
- Status changed from Calendar to Resolved
Applied in changeset arvados|996776292b5bfaeadb89457943ea1fba0700d030.
Merge branch '13690-composer-install' refs #13690
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <pamstutz@veritasgenetics.com>