[ARVADOS] updated: 46f47b1e941e1471363a5d5480dbe4c68c18703a
git at public.curoverse.com
git at public.curoverse.com
Fri Mar 21 22:14:56 EDT 2014
Summary of changes:
doc/README.textile | 38 ++++++++++++++++++++++----------------
1 files changed, 22 insertions(+), 16 deletions(-)
via 46f47b1e941e1471363a5d5480dbe4c68c18703a (commit)
from 007446e69619bae44193f219b6d9b7fda31bafad (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 46f47b1e941e1471363a5d5480dbe4c68c18703a
Author: Tom Clegg <tom at curoverse.com>
Date: Fri Mar 21 22:14:46 2014 -0400
Fix textile formatting.
diff --git a/doc/README.textile b/doc/README.textile
index de97e5d..23a82fe 100644
--- a/doc/README.textile
+++ b/doc/README.textile
@@ -2,26 +2,30 @@ 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.
+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.
+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
+<pre>
+arvados/doc$ bundle install
+</pre>
h2. 1. Generate HTML pages
- arvados/doc$ rake
+<pre>
+arvados/doc$ rake
+</pre>
h2. 2. Preview HTML pages
- arvados/doc$ rake run
+<pre>
+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
+</pre>
Preview the rendered pages at "http://localhost:8000":http://localhost:8000.
@@ -29,18 +33,20 @@ 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@:
+You can set @baseurl@ (the URL prefix for all internal links), @arvados_api_host@ and @arvados_workbench_host@ without changing @_config.yml@:
- arvados/doc$ rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com
+<pre>
+arvados/doc$ rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com
+</pre>
-Make the docs appear at {workbench_host}/doc by creating a symbolic
-link in Workbench's @public@ directory, pointing to the generated HTML
-tree.
+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
+<pre>
+arvados/doc$ ln -sn ../../../doc/.site ../apps/workbench/public/doc
+</pre>
h2. 4. Delete generated files
- arvados/doc$ rake realclean
+<pre>
+arvados/doc$ rake realclean
+</pre>
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list