Document baseurl and change to a useful default.

[arvados.git] / doc / _config.yml

diff --git a/doc/_config.yml b/doc/_config.yml
index fe779ef6439331fd7fc2a1b4a94c3d81a95bd89c..9b80a96b9139db13fd36f8ce3934d50c6db5c4b0 100644 (file)
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -1,10 +1,18 @@
-exclude: ["Rakefile", "tmp", "vendor"]
+# baseurl is the location of the generated site from the browser's
+# perspective (e.g., http://doc.arvados.org or
+# file:///tmp/arvados/doc/.site). To make docs show up inside
+# workbench, use /doc here and add a symlink at
+# apps/workbench/public/doc pointing to ../../../doc/.site
+
 baseurl: /doc
+
+exclude: ["Rakefile", "tmp", "vendor"]
 arvados_api_host: qr1hi.arvadosapi.com
 
 navbar:
   userguide:
     - Getting Started:
+      - user/index.html.textile.liquid
       - user/getting_started/workbench.html.textile.liquid
       - user/getting_started/ssh-access.html.textile.liquid
       - user/getting_started/check-environment.html.textile.liquid
@@ -25,12 +33,15 @@ navbar:
       - user/reference/api-tokens.html.textile.liquid
       - user/reference/sdk-cli.html.textile.liquid
   sdk:
+    - Overview:
+      - sdk/index.html.textile.liquid
     - Python:
       - sdk/python/sdk-python.html.textile.liquid
       - sdk/python/python.html.textile.liquid
       - sdk/python/crunch-utility-libraries.html.textile.liquid
   api:
     - Concepts:
+      - api/index.html.textile.liquid
       - api/authentication.html.textile.liquid
       - api/methods.html.textile.liquid
       - api/resources.html.textile.liquid