Documentation: installation pages improvements. Be clear about the

purpose of each installation method, and its limitations.

No issue #

diff --git a/doc/install/index.html.textile.liquid b/doc/install/index.html.textile.liquid
index 2ae58b987c19aec12e1dec108459b75e6e0ccc87..e9f3b5d3286396dde1c03adf13b0d123e473aa15 100644 (file)
--- a/doc/install/index.html.textile.liquid
+++ b/doc/install/index.html.textile.liquid
@@ -6,9 +6,11 @@ title: Installation overview
 
 Arvados components run on GNU/Linux systems, and do not depend on any particular cloud operating stack. It is developed primarily on Debian and Ubuntu GNU/Linux.
 
 
 Arvados components run on GNU/Linux systems, and do not depend on any particular cloud operating stack. It is developed primarily on Debian and Ubuntu GNU/Linux.
 

-Arvados components can be installed and configured in a number of different ways. Step-by-step instructions are available for a few specific setups:
-# "Install pre-built docker images":pre-built-docker.html *(quickest)*
-# "Build your own docker images":install-docker.html from source
-# "Manual installation":install-manual-prerequisites.html (most flexible)
+Arvados components can be installed and configured in a number of different ways. Step-by-step instructions are available for a few specific installation methods: 
+* "Install pre-built docker images":pre-built-docker.html *(quickest)*
+* "Build your own docker images":install-docker.html (from source)
+* "Manual installation":install-manual-prerequisites.html (most flexible)
+
+For local evaluation and testing on a single computer, use one of the docker installation methods.

 
 For production use or evaluation at scale, the "manual installation":install-manual-prerequisites.html is more appropriate. This method assumes you have a number of (virtual) machines at your disposal for running the various Arvados components.
 
 For production use or evaluation at scale, the "manual installation":install-manual-prerequisites.html is more appropriate. This method assumes you have a number of (virtual) machines at your disposal for running the various Arvados components.

diff --git a/doc/install/install-docker.html.textile.liquid b/doc/install/install-docker.html.textile.liquid
index e84b59203e95d0af11973c544a1283e6c268c8eb..d0222e03dc5c5c0468009a62fd4864b7edac2f14 100644 (file)
--- a/doc/install/install-docker.html.textile.liquid
+++ b/doc/install/install-docker.html.textile.liquid
@@ -4,7 +4,7 @@ navsection: installguide
 title: Build and install docker images
 ...
 
 title: Build and install docker images
 ...
 

-This installation method is appropriate for local testing, evaluation, and development. For production use, this method is not recommended.
+This installation method is appropriate for testing, evaluation and development on one computer. *For production use, this installation method is not recommended*.

 
 h2. Prerequisites
 
 
 h2. Prerequisites
 

diff --git a/doc/install/pre-built-docker.html.textile.liquid b/doc/install/pre-built-docker.html.textile.liquid
index fb87195e3e860027adb6b325beedf07916bae990..57b4d40cdcf2a319b06e784b06f7236f5621d893 100644 (file)
--- a/doc/install/pre-built-docker.html.textile.liquid
+++ b/doc/install/pre-built-docker.html.textile.liquid
@@ -5,13 +5,23 @@ title: Install pre-built docker images
 ...
 
 {% include 'notebox_begin' %}
 ...
 
 {% include 'notebox_begin' %}

-This method is easy, but is not yet suitable for production use. It is still in development: some features do not work yet.
+This method is easy, but is not suitable for production use. It is still in development: some features do not work yet.

 * Websockets service is not enabled. This means Workbench auto-refresh and web upload (and some other features) do not work.
 * The node manager is not enabled. Two worker containers are brought up at startup.
 * The automatic network configuration allows you to log in to Workbench from a browser _running on the same host as docker_. Connecting from other hosts will require additional configuration (not covered here).
 {% include 'notebox_end' %}
 
 * Websockets service is not enabled. This means Workbench auto-refresh and web upload (and some other features) do not work.
 * The node manager is not enabled. Two worker containers are brought up at startup.
 * The automatic network configuration allows you to log in to Workbench from a browser _running on the same host as docker_. Connecting from other hosts will require additional configuration (not covered here).
 {% include 'notebox_end' %}
 

-First, make sure that @curl@ and @docker@ are installed on your system, and that you are in the docker group (see "Installing Docker":https://docs.docker.com/installation/).
+This installation method is appropriate for testing and evaluation on one computer. *For production use, this installation method is not recommended*.
+
+h2. Prerequisites
+
+# A GNU/Linux (virtual) machine
+# A working Docker installation (see "Installing Docker":https://docs.docker.com/installation/)
+# curl
+
+h2. Verify prerequisites
+
+Make sure that @curl@ and @docker@ are installed on your system, and that you are in the docker group (see "Installing Docker":https://docs.docker.com/installation/).

 
 <notextile><pre><code>~$ <span class="userinput">which curl</span>
 /usr/bin/curl
 
 <notextile><pre><code>~$ <span class="userinput">which curl</span>
 /usr/bin/curl


@@ -21,7 +31,7 @@ Docker version 1.2.0-dev, build dc243c8
 yourusername sudo fuse docker
 </code></pre></notextile>
 
 yourusername sudo fuse docker
 </code></pre></notextile>
 

-Download and install Arvados.
+h2. Download and install Arvados.

 
 <notextile>
 <pre><code>~$ <span class="userinput">\curl -sSL get.arvados.org | bash</span>
 
 <notextile>
 <pre><code>~$ <span class="userinput">\curl -sSL get.arvados.org | bash</span>