Bug #13690
closed
[Composer] Document install & use of Composer
Added by Tom Morris about 6 years ago.
Updated about 6 years ago.
Release relationship:
Auto
Description
The Arvados Composer package appears to be completely undocumented for both sysadmins and users.
Please add it to the documentation for both.
- Assigned To set to Peter Amstutz
- Related to Idea #13799: Organize manual install docs into sections added
- Status changed from New to In Progress
- Target version changed from 2018-07-18 Sprint to 2018-08-01 Sprint
Doc review:
- 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)
analysis workflows 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
and from"
- Step 19 - warn that it will take several minutes
Composer Bugs noticed while doing doc review:
- 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)
Updated review comments after figuring out that I needed to click the save icon to get things to work.
- 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)
analysis workflows 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
and from"
Fixed
- Step 19 - warn that it will take several minutes
Done
13690-composer-user-guide @ cd5cd1855c02319ca31410943c4d944133294b17
- Status changed from Calendar to Resolved
Also available in: Atom
PDF