Merge branch 'master' into 2221-complete-docker

[arvados.git] / doc / user / index.html.textile.liquid

diff --git a/doc/user/index.html.textile.liquid b/doc/user/index.html.textile.liquid
index 17c435ec35037dba7d11e2d769fc1b7d92e89aca..982b1c3fc3378dc741ecb3045036740d927b082c 100644 (file)
--- a/doc/user/index.html.textile.liquid
+++ b/doc/user/index.html.textile.liquid
@@ -11,7 +11,7 @@ This guide is intended to introduce new users to the Arvados system.  It covers
 
 This user guide introduces how to use the major components of Arvados.  These are:
 
-* Keep: Content-addressable cluster file system designed for robust storage of very large files, such as whole genome sequences
+* Keep: Content-addressable cluster file system designed for robust storage of very large files, such as whole genome sequences running in the hundreds of gigabytes
 * Crunch: Cluster compute engine designed for genomic analysis, e.g. alignment, variant calls
 * Metadata Database: Information about the genomic data stored in Keep, such as genomic traits, human subjects
 * Workbench: Web interface to Arvados components
@@ -24,8 +24,7 @@ To get the most value out of this guide, you should be comfortable with the foll
 # Using the unix command line shell @bash@
 # Viewing and editing files using a unix text editor such as @vi@, @emacs@, or @nano@
 # Programming in @python@
-
-It will also be helpful (but not essential) if you are familiar with revision control using @git@.
+# Revision control using @git@
 
 The examples in this guide uses the public Arvados instance located at "https://workbench.{{ site.arvados_api_host }}/":https://workbench.{{ site.arvados_api_host }}/ .  You must have an account in order to use this service.  If you would like to request an account, please send an email to "arvados@curoverse.com":mailto:arvados@curoverse.com .
 
@@ -37,10 +36,12 @@ This manual uses the following typographic conventions:
 
 <notextile>
 <ul>
-<li>Code blocks which are set aside from the text indicate user input to the system.  Commands that should be entered into a Unix shell are indicated with a '$' at the beginning of the line, and the entire user input <span class="userinput">will be highlighted</span>, possibly followed by example command output in black:
-<pre><code>$ <span class="userinput">ls foo</span>
+<li>Code blocks which are set aside from the text indicate user input to the system.  Commands that should be entered into a Unix shell are indicated by the directory where you should  enter the command ('~' indicates your home directory) followed by '$', followed by the highlighted <span class="userinput">command to enter</span> (do not enter the '$'), and possibly followed by example command output in black.  For example, the following block indicates that you should type "ls foo" while in your home directory and the expected output will be "foo".
+
+<pre><code>~$ <span class="userinput">ls foo</span>
 foo
 </code></pre></li>
+
 <li>Code blocks inline with text emphasize specific <code>programs</code>, <code>files</code>, or <code>options</code> that are being discussed.</li>
 <li>Bold text emphasizes <b>specific items</b> to look when discussing Arvados Workbench pages.</li>
 <li>A sequence of steps separated by right arrows (<span class="rarr">&rarr;</span>) indicate a path the user should follow through the Arvados Workbench to access some piece of information under discussion.  The steps indicate a menu, hyperlink, column name, field name, or other label on the page that guide the user where to look or click.