doc: Improve flow of CLI pipeline run.
authorBrett Smith <brett@curoverse.com>
Tue, 11 Mar 2014 19:26:52 +0000 (15:26 -0400)
committerBrett Smith <brett@curoverse.com>
Tue, 11 Mar 2014 19:26:52 +0000 (15:26 -0400)
The previous version assumed that we already had a static pipeline
template.  That's no longer true under the current flow, so instruct
the user to make one at the start of the tutorial.

doc/user/topics/running-pipeline-command-line.html.textile.liquid

index 3f850777445558370c8b45b6b0cf8a43c06a9945..cda0540b8a6334a4c1a94a1a01b0a529883be961 100644 (file)
@@ -4,10 +4,39 @@ navsection: userguide
 title: "Running a pipeline on the command line"
 ...
 
-It is possible run pipelines on the command line using @arv pipeline run@ using the UUID that you received from @arv pipeline create@:
+In "Writing a pipeline":{{ site.baseurl }}/user/tutorials/tutorial-firstscript.html, we learned how to create a pipeline template on the command-line.  Let's create one that doesn't require any user input to start:
 
 <notextile>
-<pre><code>$ <span class="userinput">arv pipeline run --template qr1hi-p5p6p-xxxxxxxxxxxxxxx</span>
+<pre><code>~$ <span class="userinput">cat &gt;the_pipeline &lt;&lt;EOF
+{
+  "name":"Filter md5 hash values",
+  "components":{
+    "do_hash":{
+      "script":"hash.py",
+      "script_parameters":{
+        "input": "887cd41e9c613463eab2f0d885c6dd96+83"
+      },
+      "script_version":"<b>you</b>:master"
+    },
+    "filter":{
+      "script":"0-filter.py",
+      "script_parameters":{
+        "input":{
+          "output_of":"do_hash"
+        }
+      },
+      "script_version":"<b>you</b>:master"
+    }
+  }
+}
+EOF</span>
+~$ <span class="userinput">arv pipeline_template create --pipeline-template "$(cat the_pipeline)"</span></code></pre>
+</notextile>
+
+You can run this pipeline from the command line using @arv pipeline run@, filling in the UUID that you received from @arv pipeline_template create@:
+
+<notextile>
+<pre><code>~$ <span class="userinput">arv pipeline run --template qr1hi-p5p6p-xxxxxxxxxxxxxxx</span>
 2013-12-16 14:08:40 +0000 -- pipeline_instance qr1hi-d1hrv-vxzkp38nlde9yyr
 do_hash qr1hi-8i9sb-hoyc2u964ecv1s6 queued 2013-12-16T14:08:40Z
 filter  -                           -