Merge branch 'master' into 1786-replace-jekyll-with-zenweb

[arvados.git] / doc / user / tutorials / tutorial-firstscript.textile

diff --git a/doc/user/tutorials/tutorial-firstscript.textile b/doc/user/tutorials/tutorial-firstscript.textile
index bfde02cfa80c250cd6d64a0e489f5fcd475b7851..5cb8c26cb110207df65c1683a4451ba6bc803f3b 100644 (file)
--- a/doc/user/tutorials/tutorial-firstscript.textile
+++ b/doc/user/tutorials/tutorial-firstscript.textile
@@ -4,9 +4,9 @@ navsection: userguide
 navmenu: Tutorials
 title: "Writing a Crunch script"
 navorder: 13
----
+...
 
-h1. Tutorial: Writing a Crunch script
+h1. Writing a Crunch script
 
 In this tutorial, we will write the "hash" script demonstrated in the first tutorial.
 
@@ -30,7 +30,7 @@ On the Arvados Workbench, navigate to _Access %(rarr)→% Repositories._  You
 Next, on the Arvados virtual machine, clone your git repository:
 
 <notextile>
-<pre><code>$ <span class="userinput">git clone git://git.{{ site.arvados_api_host }}:you.git</span>
+<pre><code>$ <span class="userinput">git clone git@git.{{ site.arvados_api_host }}:you.git</span>
 Cloning into 'you'...</code></pre>
 </notextile>
 
@@ -39,14 +39,14 @@ This will create an git checkout in the directory called @you@.
 {% include notebox-begin.html %}
 For more information about using @git@, try
 
-notextile. <pre><code>$ <span class="userinput">man gittutoral</span></code></pre>
+notextile. <pre><code>$ <span class="userinput">man gittutorial</span></code></pre>
 
-or "click here to search Google for git tutorials":http://google.com/#q=git+tutorial
+or <b>"click here to search Google for git tutorials":http://google.com/#q=git+tutorial</b>
 {% include notebox-end.html %}
 
 h2. Creating a Crunch script
 
-Start by entering the @you@ directory, creating a subdirectory called @crunch_scripts@ and changing to that directory:
+Start by entering the @you@ directory created by @git clone@.  Next create a subdirectory called @crunch_scripts@ and change to that directory:
 
 <notextile>
 <pre><code>$ <span class="userinput">cd you</span>
@@ -54,7 +54,11 @@ $ <span class="userinput">mkdir crunch_scripts</span>
 $ <span class="userinput">cd crunch_scripts</span></code></pre>
 </notextile>
 
-Next, using your favorite text editor, create a new file called @hash.py@ in the @crunch_scripts@ directory.  Add the following code to compute the md5 hash of each file in a collection:
+Next, using @nano@ or your favorite Unix text editor, create a new file called @hash.py@ in the @crunch_scripts@ directory.
+
+notextile. <pre>$ <code class="userinput">nano hash.py</code></pre>
+
+Add the following code to compute the md5 hash of each file in a collection:
 
 <pre><code class="userinput">{% include tutorial_hash_script.py %}</code></pre>
 
@@ -87,7 +91,7 @@ To git@git.qr1hi.arvadosapi.com:you.git
  * [new branch]      master -> master</code></pre>
 </notextile>
 
-You should now be able to run your script using Crunch, similar to how we did it in the "first tutorial.":tutorial-job1.html  The field @"script_version"@ should be @you:master@ to tell Crunch to run the script that you just uploaded.
+You should now be able to run your script using Crunch, similar to how we did it in the "first tutorial.":tutorial-job1.html  The field @"script_version"@ should be @you:master@ to tell Crunch to run the script at the head of the "master" git branch, which you just uploaded.
 
 <notextile>
 <pre><code>$ <span class="userinput">cat &gt;the_job &lt;&lt;EOF
@@ -96,7 +100,7 @@ You should now be able to run your script using Crunch, similar to how we did it
  "script_version": "you:master",
  "script_parameters":
  {
-  "input": "33a9f3842b01ea3fdf27cc582f5ea2af"
+  "input": "c1bad4b39ca5a924e481008009d94e32+210"
  }
 }
 EOF</span>
@@ -109,10 +113,10 @@ $ <span class="userinput">arv -h job create --job "$(cat the_job)"</span>
 $ <span class="userinput">arv -h job get --uuid qr1hi-xxxxx-xxxxxxxxxxxxxxx</span>
 {
  ...
- "output":"880b55fb4470b148a447ff38cacdd952+54+K@qr1hi",
+ "output":"880b55fb4470b148a447ff38cacdd952+54",
  ...
 }
-$ <span class="userinput">arv keep get 880b55fb4470b148a447ff38cacdd952+54+K@qr1hi/md5sum.txt</span>
+$ <span class="userinput">arv keep get 880b55fb4470b148a447ff38cacdd952+54/md5sum.txt</span>
 44b8ae3fde7a8a88d2f7ebd237625b4f var-GS000016015-ASM.tsv.bz2
 </code></pre>
 </notextile>