3787: Update title, grammar, add "Share Docker images", add job-pipeline-ref.html...

diff --git a/doc/_config.yml b/doc/_config.yml
index 3ad81669c0ff2448e14177bbfdd6fc10cf0fbd1e..3b31cb054396abd5f878e599eee26d0eb9b8a3b9 100644 (file)
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -42,8 +42,7 @@ navbar:
       - user/topics/arv-docker.html.textile.liquid
     - Reference:
       - user/topics/run-command.html.textile.liquid
-      - api/schema/PipelineTemplate.html.textile.liquid
-      - api/schema/Job.html.textile.liquid
+      - user/reference/job-pipeline-ref.html.textile.liquid
       - user/examples/crunch-examples.html.textile.liquid
     - Query the metadata database:
       - user/topics/tutorial-trait-search.html.textile.liquid

diff --git a/doc/user/reference/job-pipeline-ref.html.textile.liquid b/doc/user/reference/job-pipeline-ref.html.textile.liquid
new file mode 100644 (file)
index 0000000..f8f749c
--- /dev/null
+++ b/doc/user/reference/job-pipeline-ref.html.textile.liquid
@@ -0,0 +1,7 @@
+---
+layout: default
+navsection: userguide
+title: "Pipeline template reference"
+...
+
+Pipeline template options are described on the "pipeline template schema page.":{{site.baseurl}}/api/schema/PipelineTemplate.html

diff --git a/doc/user/topics/arv-docker.html.textile.liquid b/doc/user/topics/arv-docker.html.textile.liquid
index 46e220f13a13cc47b4b89ec9efdd40bae45726c2..5e75661faa0b9e1e9e0c876e8d9c88b287c83b51 100644 (file)
--- a/doc/user/topics/arv-docker.html.textile.liquid
+++ b/doc/user/topics/arv-docker.html.textile.liquid
@@ -1,24 +1,28 @@
 ---
 layout: default
 navsection: userguide
-title: "Customizing the Crunch runtime environment"
+title: "Customizing Crunch environment using Docker"
 ...
 
-This page describes how to customize the runtime environment (e.g. the programs, libraries, and other dependencies needed to run a job) that a crunch script will be run in using "Docker.":https://www.docker.com/
+This page describes how to customize the runtime environment (e.g. the programs, libraries, and other dependencies needed to run a job) that a crunch script will be run in using "Docker.":https://www.docker.com/  Docker is a tool for building and running containers that isolate applications from other applications running on the same node.  For detailed information about Docker, see the "Docker User Guide.":https://docs.docker.com/userguide/
 
-This page will demonstrate:
+This page will demonstrate how to:
 
-# How to fetch the arvados/jobs Docker image
+# Fetch the arvados/jobs Docker image
 # Manually install additional software into the container
 # Create a new custom image
 # Upload that image to Arvados for use by Crunch jobs.
-
+# Share your image with others
 
 {% include 'tutorial_expectations' %}
 
-h2. Fetching a starting image
+*You also need ensure that "Docker is installed":https://docs.docker.com/installation/ and the Docker daemon is running.  You can test this by running @docker version@.*
+
+h2. Fetch a starting image
+
+The easiest way to begin is to start from the "arvados/jobs" image which already has the Arvados SDK installed along with other configuration required for use with Crunch.
 
-First, download the latest image from the Docker registry:
+Download the latest "arvados/jobs" image from the Docker registry:
 
 <notextile>
 <pre><code>$ <span class="userinput">docker pull arvados/jobs</span>
@@ -41,7 +45,7 @@ c7fd77eedb96: Download complete
 </code></pre>
 </notextile>
 
-h2. Installing new packages
+h2. Install new packages
 
 Next, enter the container using "docker run", the arvados/jobs image, and the program you want to run (in this case the bash shell).
 
@@ -185,3 +189,14 @@ You are now able to specify the runtime environment for your program using the @
 <notextile>
 {% code 'example_docker' as javascript %}
 </notextile>
+
+* The @docker_image@ field can be one of: the Docker repository name (as shown above), the Docker image hash, the Arvados collection uuid, or the Arvados collection portable data hash.
+
+h2. Share Docker images
+
+Docker images are subject to normal Arvados permissions.  If wish to share your Docker image with others (or wish to share a pipeline template that uses your Docker image) you will need to use @arv keep docker@ with the @--project-uuid@ option to upload the image to a shared project.
+
+<notextile>
+<pre><code>$ <span class="userinput">arv keep docker --project-uuid zzzzz-j7d0g-u7zg1qdaowykd8d arvados/jobs-with-r</span>
+</code></pre>
+</notextile>