From: Javier Bértoli <jbertoli@curii.com>
Date: Mon, 19 Apr 2021 13:00:43 +0000 (-0300)
Subject: docs(provision): improve the documentation in the examples
X-Git-Tag: 2.2.0~65^2~2
X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/ea846236d6ad1fbb6791672236e9019066a488a8

docs(provision): improve the documentation in the examples

refs #17246
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <jbertoli@curii.com>
---

diff --git a/doc/install/salt-multi-host.html.textile.liquid b/doc/install/salt-multi-host.html.textile.liquid
index bb8cd0bdf4..5fbdc6a774 100644
--- a/doc/install/salt-multi-host.html.textile.liquid
+++ b/doc/install/salt-multi-host.html.textile.liquid
@@ -156,9 +156,9 @@ ssh user@host sudo ./provision.sh --config local.params --roles keepproxy,keepwe
 </code></pre>
 </notextile>
 
-#. Shell
+#. Shell (here we copy the CLI test workflow too)
 <notextile>
-<pre><code>scp -r provision.sh local* user@host:
+<pre><code>scp -r provision.sh local* tests user@host:
 ssh user@host sudo ./provision.sh --config local.params --roles shell
 </code></pre>
 </notextile>
@@ -183,11 +183,11 @@ Assuming you didn't change these values in the @local.params@ file, the initial
 
 h2(#test_install). Test the installed cluster running a simple workflow
 
-The @provision.sh@ script saves a simple example test workflow in the @/tmp/cluster_tests@ directory in the node. If you want to run it, just ssh to the node, change to that directory and run:
+If you followed the instructions above, the @provision.sh@ script saves a simple example test workflow in the @/tmp/cluster_tests@ directory in the @shell@ node. If you want to run it, just ssh to the node, change to that directory and run:
 
 <notextile>
 <pre><code>cd /tmp/cluster_tests
-./run-test.sh
+sudo /run-test.sh
 </code></pre>
 </notextile>
 
diff --git a/doc/install/salt-single-host.html.textile.liquid b/doc/install/salt-single-host.html.textile.liquid
index 8f9b00830d..5d7991c987 100644
--- a/doc/install/salt-single-host.html.textile.liquid
+++ b/doc/install/salt-single-host.html.textile.liquid
@@ -69,7 +69,7 @@ h2(#run_provision_script). Run the provision.sh script
 When you finished customizing the configuration, you are ready to copy the files to the host (if needed) and run the @provision.sh@ script:
 
 <notextile>
-<pre><code>scp -r provision.sh local* user@host:
+<pre><code>scp -r provision.sh local* tests user@host:
 ssh user@host sudo ./provision.sh
 </code></pre>
 </notextile>
@@ -77,7 +77,7 @@ ssh user@host sudo ./provision.sh
 or, if you saved the @local.params@ in another directory or with some other name
 
 <notextile>
-<pre><code>scp -r provision.sh local* user@host:
+<pre><code>scp -r provision.sh local* tests user@host:
 ssh user@host sudo ./provision.sh -c /path/to/your/local.params.file
 </code></pre>
 </notextile>
@@ -169,7 +169,7 @@ The @provision.sh@ script saves a simple example test workflow in the @/tmp/clus
 
 <notextile>
 <pre><code>cd /tmp/cluster_tests
-./run-test.sh
+sudo ./run-test.sh
 </code></pre>
 </notextile>