Story #10604

Additional Crunch2 CWL User Guide updates

Added by Tom Morris over 4 years ago. Updated over 4 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Radhika Chippada
Category:
-
Target version:
Start date:
11/23/2016
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
-

Description

A few ideas (I can work on these, once we agree on the list of changes to be made):

1. Run a pipeline using Workbench section:
  • Rename as "Using Crunch" or something like that
  • Move "Introduction to Crunch" from "Develop an Arvados Pipeline" as the first item in this section
  • Add a new page "Running a workflow using Workbench" after "Accessing workbench". This would of course need adding a tutorial workflow to qr1hi and authoring this page etc
  • Rename "Running a pipeline using workbench" as "Running a pipeline using workbench (Deprecated)"
2. user/cwl/cwl-runner.html
  • Registering a workflow with Workbench => "Use --create-template to register a CWL workflow" -- use "--create-workflow" instead?
3. topics/arv-copy.html
  • How to copy a pipeline template => Do we need to add any notes here about workflows? Otherwise, add a "How to copy a workflow" section?
4. Working on the command line
  • Append "(Deprecated)" to both page titles?
  • Do we want to add a page to work with container_requests and / or workflows here?
5. Develop an Arvados pipeline
  • Rename it as "Develop an Arvados pipeline (Deprecated)" ?
  • This would need moving a couple pages.
  • Move "Introduction to Crunch" to the top of the list as noted in the first comment
  • Add a new "Docker" section and move "Customizing Crunch environment using Docker" into it?

Subtasks

Task #10618: Review branch 10604-crunch2-user-guideResolvedRadhika Chippada


Related issues

Related to Arvados - Story #10499: [Doc] Improve user guide for CWL with Crunch2Resolved11/09/2016

Associated revisions

Revision 2d4b14cf
Added by Radhika Chippada over 4 years ago

closes #10604
Merge branch '10604-crunch2-user-guide'

History

#1 Updated by Radhika Chippada over 4 years ago

  • Target version changed from Arvados Future Sprints to 2016-12-14 sprint

#2 Updated by Radhika Chippada over 4 years ago

  • Assigned To set to Radhika Chippada

#3 Updated by Radhika Chippada over 4 years ago

  • Status changed from New to In Progress

#4 Updated by Radhika Chippada over 4 years ago

  • Description updated (diff)

#5 Updated by Radhika Chippada over 4 years ago

  • Description updated (diff)

#6 Updated by Radhika Chippada over 4 years ago

  • Description updated (diff)

#7 Updated by Radhika Chippada over 4 years ago

@ 6b2481ad in branch 10604-crunch2-user-guide

Run a pipeline using Workbench section:

  • Rather than implementing those ideas listed under this item, per Peter's suggestion, updated the page to use bwa-mem.cwl so that it is the same one way or another.
    • In crunch2 only environments, where bwa-mem.cwl is a "workflow" instead of a "pipeline_template", the default values will not be populated due to issue #10576, but works as expected in qr1hi. Also, #10576 is on this sprint, so it's ok to update the user guide at this time with the expectation that the user guide steps will work as expected in 9tee4 as well pretty soon.
  • Deleted crunch1only note from this page due to this.
  • Updating the page required adding bwa-mem.cwl "pipeline template" to "Arvados tutorial public project" in qr1hi

user/cwl/cwl-runner.html -- Registering a workflow with Workbench => "Use --create-template to register a CWL workflow" -- use "--create-workflow" instead?

This was already done by Tom (when he made the change to --create-workflow == --create-template update)

topics/arv-copy.html

  • Added a note at the top of the page saying arv-copy for workflows is not yet implemented

Working on the command line

  • Made several include files from the "Using Common Workflow Language" page and using these shared include files added a "Running an Arvados workflow" page

Develop an Arvados pipeline

  • Using the includes from the "Using Common Workflow Language" page, added a new "Writing a CWL workflow" page

Append "(Deprecated)" to page titles ...

Since we do not yet have crunch2 working in qr1hi, it is not the right time to add "(Deprecated)" to page titles. For now the note within the page with "crunch1 deprecated" note will suffice. We can add this to the page titles when are supporting Crunch2 in qr1hi environment.

#8 Updated by Lucas Di Pentima over 4 years ago

Some minor comments:

  • doc/user/tutorials/tutorial-pipeline-workbench.html.textile.liquid file:
    • could be renamed to tutorial-workflow-workbench.html.textile.liquid for consistency?
    • Maybe if we don’t want to break backlinks, we can leave the old file with a link referring to the new one? Or a http redirection?
    • Typo: pupulated
  • doc/_includes/_arvados_cwl_runner.liquid & doc/user/cwl/cwl-runner.html.textile.liquid files:
    • Should CWL and UUID references be always in uppercase, as they’re acronyms?

Other than that, looks good to me.

#9 Updated by Radhika Chippada over 4 years ago

@ c494f4c3

doc/user/tutorials/tutorial-pipeline-workbench.html.textile.liquid file

Renamed this file as tutorial-workflow-workbench.html.textile.liquid

CWL and UUID in uppercase

Updated to uppercase

Thanks.

#10 Updated by Radhika Chippada over 4 years ago

  • Status changed from In Progress to Resolved

Applied in changeset arvados|commit:2d4b14cf28c71d3aa7e0417a2951806c15e29fb1.

Also available in: Atom PDF