Pin the python-daemon backport for centos7, newer versions have

[arvados.git] / doc / README.textile

diff --git a/doc/README.textile b/doc/README.textile
index 23a82fe5b115e25468666e23980008d497ef7d50..f2936142c680eb650416360c00f7c641bd63ad94 100644 (file)
--- a/doc/README.textile
+++ b/doc/README.textile
@@ -4,21 +4,38 @@ 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://dev.arvados.org/projects/arvados/wiki/Documentation.

 
 

-h2. 0. Install dependencies
+h2. Install dependencies

 
 <pre>
 arvados/doc$ bundle install
 </pre>
 
 
 <pre>
 arvados/doc$ bundle install
 </pre>
 

-h2. 1. Generate HTML pages
+h2. Generate HTML pages

 
 <pre>
 arvados/doc$ rake
 </pre>
 
 
 <pre>
 arvados/doc$ rake
 </pre>
 

-h2. 2. Preview HTML pages
+Alternately, to make the documentation browsable on the local filesystem:
+
+<pre>
+arvados/doc$ rake generate baseurl=$PWD/.site
+</pre>
+
+h2. Run linkchecker
+
+If you have "Linkchecker":http://wummel.github.io/linkchecker/ installed on
+your system, you can run it against the documentation:
+
+<pre>
+arvados/doc$ rake linkchecker baseurl=file://$PWD/.site
+</pre>
+
+Please note that this will regenerate your $PWD/.site directory.
+
+h2. Preview HTML pages

 
 <pre>
 arvados/doc$ rake run
 
 <pre>
 arvados/doc$ rake run


@@ -29,7 +46,7 @@ arvados/doc$ rake run
 
 Preview the rendered pages at "http://localhost:8000":http://localhost:8000.
 
 
 Preview the rendered pages at "http://localhost:8000":http://localhost:8000.
 

-h2. 3. Publish HTML pages inside Workbench
+h2. Publish HTML pages inside Workbench

 
 (or some other web site)
 
 
 (or some other web site)
 


@@ -45,7 +62,7 @@ Make the docs appear at {workbench_host}/doc by creating a symbolic link in Work
 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
+h2. Delete generated files

 
 <pre>
 arvados/doc$ rake realclean
 
 <pre>
 arvados/doc$ rake realclean