[Swift-commit] r6219 - in trunk/docs: cookbook userguide

[ketan at ci.uchicago.edu]

Author: ketan
Date: 2013-02-03 09:40:12 -0600 (Sun, 03 Feb 2013)
New Revision: 6219

Modified:
   trunk/docs/cookbook/overview
   trunk/docs/userguide/coasters
Log:
organize coasters section

Modified: trunk/docs/cookbook/overview
===================================================================
--- trunk/docs/cookbook/overview	2013-02-03 01:37:52 UTC (rev 6218)
+++ trunk/docs/cookbook/overview	2013-02-03 15:40:12 UTC (rev 6219)
@@ -5,7 +5,7 @@
 infrastructures. The Swift system comprises of SwiftScript language and the
 Swift runtime system. For
 introductory material, consult the Swift tutorial found 
-link:http://www.ci.uchicago.edu/swift/guides/tutorial.php[here].
+link:http://www.ci.uchicago.edu/swift/guides/trunk/tutorial/tutorial.html[here].
 
-WARNING: Please be warned that the cookbook is under construction and most recipes are not tested rigorously. You are advised to use them at your own risk.
+WARNING: Please be warned that the cookbook is under construction and the recipes are not tested rigorously. 
 

Modified: trunk/docs/userguide/coasters
===================================================================
--- trunk/docs/userguide/coasters	2013-02-03 01:37:52 UTC (rev 6218)
+++ trunk/docs/userguide/coasters	2013-02-03 15:40:12 UTC (rev 6219)
@@ -1,18 +1,27 @@
 Coasters
 --------
+
+Introduction
+~~~~~~~~~~~~
 In many applications, Swift performance can be greatly enhanced by the
-use of CoG coasters. CoG coasters provide a low-overhead job submission
+use of coasters. Coasters provide a low-overhead job submission
 and file transfer mechanism suited for the execution of short jobs (on
 the order of a few seconds) and the transfer of small files (on the
 order of a few kilobytes) for which other grid protocols such as GRAM
 and GridFTP are poorly suited.
 
+Benefits
+~~~~~~~~
+
 The coaster mechanism submits a pilot job using some other execution
 mechanism such as GRAM, and for each worker node that will be used in a
 remote cluster, it submits a worker job, again using some other
 execution mechanism such as GRAM. Details on the design of the coaster
 mechanism can be found here. <http://wiki.cogkit.org/wiki/Coasters>
 
+Mechanism
+~~~~~~~~~
+
 The pilot job manages file transfers and the dispatch of execution jobs
 to workers. Much of the overhead associated with other grid protocols
 (such as authentication and authorization, and allocation of worker
@@ -22,9 +31,12 @@
 potentially hundreds or thousands of Swift-level procedure invocations
 can be run through a single worker.
 
-Coasters can be configured for use in two situations: job execution and
-file transfer.
+Coasters can be configured for two purposes: job execution and
+file staging.
 
+Coasters How-to
+~~~~~~~~~~~~~~~
+
 To use for job execution, specify a sites.xml execution element like this:
 
 ----
@@ -46,6 +58,7 @@
 ----
 <filesystem provider="coaster" url="gt2://grid.myhost.org" />
 ----
+
 The url parameter should be a pseudo-URI formed with the URI scheme
 being the name of the provider to use to submit the coaster head job,
 and the hostname portion being the hostname to be used to execute the