Merge branch '2107-update-documentation'

[arvados.git] / doc / _config.yml

diff --git a/doc/_config.yml b/doc/_config.yml
index fe779ef6439331fd7fc2a1b4a94c3d81a95bd89c..3e04430b343f610b88a4c46c5e9a143939c6662b 100644 (file)
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -1,36 +1,55 @@
+# 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
+# You can also set these on the command line:
+# $ rake generate baseurl=/example arvados_api_host=example.comA
+
+baseurl: 
+arvados_api_host: localhost
+arvados_workbench_host: localhost
+
 exclude: ["Rakefile", "tmp", "vendor"]
-baseurl: /doc
-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
       - user/getting_started/community.html.textile.liquid
     - Tutorials:
       - user/tutorials/tutorial-keep.html.textile.liquid
-      - user/tutorials/tutorial-job1.html.textile.liquid
+      - user/tutorials/intro-crunch.html.textile.liquid
+      - user/tutorials/tutorial-pipeline-workbench.html.textile.liquid
       - user/tutorials/tutorial-firstscript.html.textile.liquid
-      - user/tutorials/tutorial-job-debug.html.textile.liquid
       - user/tutorials/tutorial-new-pipeline.html.textile.liquid
-      - user/tutorials/tutorial-parallel.html.textile.liquid
-      - user/tutorials/tutorial-trait-search.html.textile.liquid
-      - user/tutorials/tutorial-gatk-variantfiltration.html.textile.liquid
       - user/tutorials/running-external-program.html.textile.liquid
+    - Intermediate topics:
+      - user/topics/running-pipeline-command-line.html.textile.liquid
+      - user/topics/tutorial-job1.html.textile.liquid
+      - user/topics/tutorial-job-debug.html.textile.liquid
+      - user/topics/tutorial-parallel.html.textile.liquid
+      - user/topics/tutorial-trait-search.html.textile.liquid
+      - user/topics/tutorial-gatk-variantfiltration.html.textile.liquid
+      - user/topics/keep.html.textile.liquid
     - Examples:
       - user/examples/crunch-examples.html.textile.liquid
     - Reference:
       - 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
@@ -84,8 +103,8 @@ navbar:
       - admin/cheat_sheet.html.textile.liquid
   installguide:
     - Install:
-      - install/install-api-server.html.md.liquid
       - install/index.html.md.liquid
+      - install/install-api-server.html.md.liquid
       - install/install-workbench-app.html.md.liquid
       - install/client.html.textile.liquid
       - install/create-standard-objects.html.textile.liquid