A little bit of documentation work from home
authorPeter Amstutz <tetron@cosmos>
Sun, 8 Dec 2013 02:30:57 +0000 (21:30 -0500)
committerPeter Amstutz <tetron@cosmos>
Sun, 8 Dec 2013 02:30:57 +0000 (21:30 -0500)
doc/user/api-tokens.textile
doc/user/tutorial-job1.textile

index 3f2be99f672ae8789d68cfc7c2d7d43a80296a6c..f1107903cee385f7cff8122ededa78740aa21a60 100644 (file)
@@ -18,7 +18,7 @@ Access the Arvados workbench using this link:
 
 Use the menu to navigate to _Access %(rarr)&rarr;% API Tokens_.  There should be one or more rows.  The column *api_token* contains the actual token string that you will use.  Copy the value of *api_token* for the first row onto the clipboard.
 
-Next, open a shell on the system on which you intend to use the Arvados client (refer to "Accessing Arvados over ssh":ssh-access.html ) and enter the following:
+Next, open a shell on the system on which you intend to use the Arvados client (refer to "Accessing Arvados over ssh":ssh-access.html ) and enter the following (replace the value of @ARVADOS_API_TOKEN@ with the value you copied from the Workbench):
 
 <pre>
  $ export ARVADOS_API_HOST={{ site.arvados_api_host }}
@@ -28,7 +28,7 @@ Next, open a shell on the system on which you intend to use the Arvados client (
 * @ARVADOS_API_HOST@ tells @arv@ which host to connect to
 * @ARVADOS_API_TOKEN@ is the secret key used by the Arvados API server to authenticate access.
 
-For your convenience, the "API Tokens" Workbench page provides a section at the top of the  page that you may copy and paste directly into the shell.
+For your convenience, the "API Tokens" Workbench page provides a section at the top of the  page that you may copy and paste directly into the shell.  It will look something like this:
 
 <pre>
 ### Pasting the following lines at a shell prompt will allow Arvados SDKs
@@ -44,5 +44,11 @@ export ARVADOS_API_TOKEN ARVADOS_API_HOST=qr1hi.arvadosapi.com
 * The @<<EOF@ notation means read each line on stdin and pipe it to the command, terminating on reading the line @EOF@.
 * The @export@ command puts a local shell variable into the environment that will be inherited by child processes (e.g. the @arv@ client).
 
-Additionally for your convenience you may add the declarations of @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ to your @~/.bashrc@ file.
+For your convenience you may add the declarations of @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ to the @~/.bashrc@ file on the system on which you intend to use the Arvados client.  If you have already put the variables into the environment with instructions above, you can use these commands to append the environment variables to your @~/.bashrc@:
 
+<pre>
+ $ echo "export ARVADOS_API_HOST=$ARVADOS_API_HOST" >> ~/.bashrc
+ $ echo "export ARVADOS_API_TOKEN=$ARVADOS_API_TOKEN" >> ~/.bashrc
+<pre>
+
+You are now ready to "return to Tutorial 1"#tutorial-job1.html .
index 3aa6a9d26dd42dfb8199eb444a061f49b7ac566d..abab08af8e4031884cec4b8caa23bf958f6b6510 100644 (file)
@@ -21,7 +21,7 @@ $ arv user current
 
 If you receive the message "ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables", follow the instructions "Getting an API token":api-tokens.html , then return to this document.
 
-If @arv user current@ is able to access the API server, it will print out the unique identifier associated with your account:
+If @arv user current@ is able to access the API server, it will print out the unique identifier associated with your account, for example (you will receive a different identifier than shown in this example):
 
 <pre>
 qr1hi-xioed-9z2p3pn12yqdaem