[ARVADOS] updated: 007446e69619bae44193f219b6d9b7fda31bafad

[git at public.curoverse.com]

Summary of changes:
 doc/README         |   28 ----------------------------
 doc/README.textile |   46 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 46 insertions(+), 28 deletions(-)
 delete mode 100644 doc/README
 create mode 100644 doc/README.textile

       via  007446e69619bae44193f219b6d9b7fda31bafad (commit)
      from  a8537e43ce618b6f71e7195a3c8d08c5c8909ad1 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.


commit 007446e69619bae44193f219b6d9b7fda31bafad
Author: Tom Clegg <tom at curoverse.com>
Date:   Fri Mar 21 20:38:23 2014 -0400

    Fix up README, convert to textile.

diff --git a/doc/README b/doc/README
deleted file mode 100644
index e7bd431..0000000
--- a/doc/README
+++ /dev/null
@@ -1,28 +0,0 @@
-Arvados Documentation
-
-0. Install dependencies
-
-  $ bundle install
-
-
-1. To build or update documentation:
-  $ rake generate
-
-
-2. To view documentation:
-  $ rake run
-[2014-03-10 09:03:41] INFO  WEBrick 1.3.1
-[2014-03-10 09:03:41] INFO  ruby 2.1.1 (2014-02-24) [x86_64-linux]
-[2014-03-10 09:03:41] INFO  WEBrick::HTTPServer#start: pid=8926 port=8000
-
-  Then go to http://localhost:8000
-
-
-2. You can set 'baseurl' (the URL prefix for all internal links),
-'arvados_api_host' and 'arvados_workbench_host' without changing _config.yml:
-
- $ rake generate baseurl=/example arvados_api_host=example.com
-
-
-4. To delete generated files:
-  $ rake realclean
diff --git a/doc/README.textile b/doc/README.textile
new file mode 100644
index 0000000..de97e5d
--- /dev/null
+++ b/doc/README.textile
@@ -0,0 +1,46 @@
+h1. Arvados documentation
+
+This is the source code for "doc.arvados.org":http://doc.arvados.org.
+
+Here's how to build the HTML pages locally so you can preview your
+updates before you commit and push.
+
+Additional information is available on the
+"'Documentation' page on the Arvados wiki":https://arvados.org/projects/arvados/wiki/Documentation.
+
+h2. 0. Install dependencies
+
+ arvados/doc$ bundle install
+
+h2. 1. Generate HTML pages
+
+ arvados/doc$ rake
+
+h2. 2. Preview HTML pages
+
+ arvados/doc$ rake run
+[2014-03-10 09:03:41] INFO  WEBrick 1.3.1
+[2014-03-10 09:03:41] INFO  ruby 2.1.1 (2014-02-24) [x86_64-linux]
+[2014-03-10 09:03:41] INFO  WEBrick::HTTPServer#start: pid=8926 port=8000
+
+Preview the rendered pages at "http://localhost:8000":http://localhost:8000.
+
+h2. 3. Publish HTML pages inside Workbench
+
+(or some other web site)
+
+You can set @baseurl@ (the URL prefix for all internal links),
+ at arvados_api_host@ and @arvados_workbench_host@ without changing
+ at _config.yml@:
+
+ arvados/doc$ rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com
+
+Make the docs appear at {workbench_host}/doc by creating a symbolic
+link in Workbench's @public@ directory, pointing to the generated HTML
+tree.
+
+ arvados/doc$ ln -sn ../../../doc/.site ../apps/workbench/public/doc
+
+h2. 4. Delete generated files
+
+ arvados/doc$ rake realclean

-----------------------------------------------------------------------


hooks/post-receive
--