doc/README.textile

   1 h1. Arvados documentation
   2
   3 This is the source code for "doc.arvados.org":http://doc.arvados.org.
   4
   5 Here's how to build the HTML pages locally so you can preview your
   6 updates before you commit and push.
   7
   8 Additional information is available on the
   9 "'Documentation' page on the Arvados wiki":https://arvados.org/projects/arvados/wiki/Documentation.
  10
  11 h2. 0. Install dependencies
  12
  13  arvados/doc$ bundle install
  14
  15 h2. 1. Generate HTML pages
  16
  17  arvados/doc$ rake
  18
  19 h2. 2. Preview HTML pages
  20
  21  arvados/doc$ rake run
  22 [2014-03-10 09:03:41] INFO  WEBrick 1.3.1
  23 [2014-03-10 09:03:41] INFO  ruby 2.1.1 (2014-02-24) [x86_64-linux]
  24 [2014-03-10 09:03:41] INFO  WEBrick::HTTPServer#start: pid=8926 port=8000
  25
  26 Preview the rendered pages at "http://localhost:8000":http://localhost:8000.
  27
  28 h2. 3. Publish HTML pages inside Workbench
  29
  30 (or some other web site)
  31
  32 You can set @baseurl@ (the URL prefix for all internal links),
  33 @arvados_api_host@ and @arvados_workbench_host@ without changing
  34 @_config.yml@:
  35
  36  arvados/doc$ rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com
  37
  38 Make the docs appear at {workbench_host}/doc by creating a symbolic
  39 link in Workbench's @public@ directory, pointing to the generated HTML
  40 tree.
  41
  42  arvados/doc$ ln -sn ../../../doc/.site ../apps/workbench/public/doc
  43
  44 h2. 4. Delete generated files
  45
  46  arvados/doc$ rake realclean