A few extra notes from feedback.
[arvados-vscode-cwl-training.git] / README.md
index fe1897c644e82e16cbf575d95d24e109f5e423c3..26928c5adc3b800e228e12f1e74250280f5d33d8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,18 +10,20 @@ Code (abbreviated "vscode") to develop CWL workflows on Arvados.
 
 ## 1. SSH Setup
 
-1. (Windows only) Install git for windows [https://git-scm.com/download/win](https://git-scm.com/download/win)
+1. (Windows only) Install Git for Windows [https://git-scm.com/download/win](https://git-scm.com/download/win)
    1. Choose "64-bit Git for Windows Setup".  It does not require admin privileges to install.
    1. Hit "Next" a bunch of times to accept the defaults
-   1. The most important things is that "install git bash" and "install OpenSSH" are enabled.
+   1. The most important things is that "install git bash" and "install OpenSSH" are enabled (this is the default).
    1. At the end of the installation, you can launch tick a box to git bash directly.
    1. Open "Git Bash" (installed in the "Git" folder of the start menu)
-1. From an open bash shell
+1. (All operating systems) Starting from bash shell (on MacOS or Linux you will open "Terminal")
    1. Shell: Run `ssh-keygen`
       1. Hit enter to save to a default location
       1. You can choose to protect the key with a password, or just hit enter for no password.
-   1. Shell: Look for a message like `Your public key has been saved in /c/Users/MyUsername/.ssh/id_rsa.pub`
-   1. Shell: Run `cat /c/Users/MyUsername/.ssh/id_rsa.pub`
+   1. Shell: Look for a message like `Your public key has been saved
+      in /c/Users/MyUsername/.ssh/id_rsa.pub` (Windows git bash
+      example, on MacOS or Linux this will probably start with `/Users` or `/home`)
+      1. Shell: Run `cat /c/Users/MyUsername/.ssh/id_rsa.pub`
    1. Shell: Use the pointer to highlight and copy the lines starting
       with `ssh-rsa …` up to the next blank line.  Right click and
       select "Copy"
@@ -55,20 +57,23 @@ Code (abbreviated "vscode") to develop CWL workflows on Arvados.
    1. Right click the newly added ssh target in the list and select “connect to host in current window`
    1. If it asks `Select platform of the remote host` select `Linux`.
 1. Vscode: On the left sidebar, go back to `Extensions` ![](images/Extensions.png)
-   1. Search for "benten" and install `CWL (Rabix/Benten)`
-   1. You should see a message `Extension is enabled on 'SSH: ...' and disabled locally.`
+   1. Search for "benten", then look for `CWL (Rabix/Benten)` and click `Install`
+   1. On the information page for `CWL (Rabix/Benten)`
+      1. If you see a warning `Install the extension on 'SSH: ...' to enable` then click the button `Install in SSH: ...`
+   1. You should now see a message `Extension is enabled on 'SSH: ...' and disabled locally.`
 1. Vscode: On the left sidebar, choose `Explorer` ![](images/Explorer.png)
    1. Select `Clone Repository` and enter [https://github.com/arvados/arvados-vscode-cwl-training](https://github.com/arvados/arvados-vscode-cwl-training), then click `Open`
    1. If asked `Would you like to open the cloned repository?` choose `Open`
-1. Go to Arvados Workbench
-   1. Workbench: In the user menu, select `Current token`
-   1. Vscode: Click on the `Terminal` menu
+1. Vscode: Click on the `Terminal` menu
    1. Vscode: Click `Run Task…`
    1. Vscode: Select `Configure Arvados`
-   1. Workbench: Copy the string following `ARVADOS_API_HOST=`
+   1. Go to Arvados Workbench
+   1. Workbench: In the user menu, select `Current token`
+   1. Workbench: Copy the text following `ARVADOS_API_HOST=` to the end of the line
    1. Vscode: Paste the string at the `Value for ARVADOS_API_HOST` prompt
-   1. Workbench: Copy the string following `ARVADOS_API_TOKEN=`
+   1. Workbench: Copy the text following `ARVADOS_API_TOKEN=` to the end of the line
    1. Vscode: Paste the string at the `Value for ARVADOS_API_TOKEN` prompt
+   1. This will create files called `API_HOST` and `API_TOKEN`
 
 ## 3. Register & run a workflow
 
@@ -76,6 +81,7 @@ Code (abbreviated "vscode") to develop CWL workflows on Arvados.
    1. Click on the `Terminal` menu
    1. Click `Run Task…`
    1. Select `Register or update CWL workflow on Arvados Workbench`
+   1. This will create a file called `WORKFLOW_UUID`
 1. Workbench: Go to `+NEW` and select `New project`
    1. Enter a name for the project like "Lesson 1"
    1. You should arrive at the panel for the new project
@@ -150,6 +156,8 @@ The default value for the `message` parameter will taken from the `lesson3/defau
    1. The `#main/message` parameter will be pre-filled with your default value.  You can choose to change it or use the default.
    1. Click `Run process`
    1. This should take you to the status page for this workflow
+   1. The greeting will appear in the `Log` of the `echo` task, which
+      can be found the same way as described earlier in section 3.
 
 ## 6. Run a workflow without registering it
 
@@ -172,7 +180,7 @@ The `message` parameter will be taken from the file `lesson4/main-input.yaml`.
 1. Vscode: In the bottom panel select the `Terminal` tab
    1. In the upper right corner of the Terminal tab select `Task - Run CWL Workflow` from the drop-down
    1. Look for logging text like `submitted container_request zzzzz-xvhdp-0123456789abcde`
-   1. Highlight and copy the workflow identifier (this the string containing -xvhdp- in the middle)
+   1. Highlight and copy the workflow identifier (this the string containing `-xvhdp-` in the middle)
    1. The results of this run will appear in the terminal when the run completes.
 1. Workbench: Paste the workflow identifier into the search box
    1. This will take you to the status page for this workflow