Merge branch 'master' into 10112-workflow-show
[arvados.git] / doc / _config.yml
1 # baseurl is the location of the generated site from the browser's
2 # perspective (e.g., http://doc.arvados.org or
3 # file:///tmp/arvados/doc/.site). To make docs show up inside
4 # workbench, use /doc here and add a symlink at
5 # apps/workbench/public/doc pointing to ../../../doc/.site
6 # You can also set these on the command line:
7 # $ rake generate baseurl=/example arvados_api_host=example.com
8
9 baseurl:
10 arvados_api_host: localhost
11 arvados_workbench_host: http://localhost
12
13 exclude: ["Rakefile", "tmp", "vendor"]
14
15 navbar:
16   #start:
17     #- Getting Started:
18       #- start/index.html.textile.liquid
19     #- Quickstart:
20       #- start/getting_started/publicproject.html.textile.liquid
21       #- start/getting_started/firstpipeline.html.textile.liquid
22     #- Common Use Cases:
23       #- start/getting_started/sharedata.html.textile.liquid
24     #- Next Steps:
25       #- start/getting_started/nextsteps.html.textile.liquid
26
27   userguide:
28     - Welcome:
29       - user/index.html.textile.liquid
30       - user/getting_started/community.html.textile.liquid
31     - Run a workflow using Workbench:
32       - user/getting_started/workbench.html.textile.liquid
33       - user/tutorials/tutorial-workflow-workbench.html.textile.liquid
34     - Access an Arvados virtual machine:
35       - user/getting_started/vm-login-with-webshell.html.textile.liquid
36       - user/getting_started/ssh-access-unix.html.textile.liquid
37       - user/getting_started/ssh-access-windows.html.textile.liquid
38       - user/getting_started/check-environment.html.textile.liquid
39       - user/reference/api-tokens.html.textile.liquid
40     - Working with data sets:
41       - user/tutorials/tutorial-keep.html.textile.liquid
42       - user/tutorials/tutorial-keep-get.html.textile.liquid
43       - user/tutorials/tutorial-keep-mount.html.textile.liquid
44       - user/topics/keep.html.textile.liquid
45       - user/topics/arv-copy.html.textile.liquid
46     - Running workflows at the command line:
47       - user/cwl/cwl-runner.html.textile.liquid
48       - user/cwl/cwl-run-options.html.textile.liquid
49       - user/topics/running-pipeline-command-line.html.textile.liquid
50       - user/topics/arv-run.html.textile.liquid
51     - Working with git repositories:
52       - user/tutorials/add-new-repository.html.textile.liquid
53       - user/tutorials/git-arvados-guide.html.textile.liquid
54     - Develop an Arvados workflow:
55       - user/tutorials/intro-crunch.html.textile.liquid
56       - user/tutorials/writing-cwl-workflow.html.textile.liquid
57       - user/cwl/cwl-style.html.textile.liquid
58       - user/cwl/cwl-extensions.html.textile.liquid
59       - user/topics/arv-docker.html.textile.liquid
60       - user/tutorials/running-external-program.html.textile.liquid
61       - user/topics/crunch-tools-overview.html.textile.liquid
62       - user/tutorials/tutorial-firstscript.html.textile.liquid
63       - user/tutorials/tutorial-submit-job.html.textile.liquid
64       - user/topics/tutorial-parallel.html.textile.liquid
65     - Develop a web service:
66       - user/topics/arv-web.html.textile.liquid
67     - Reference:
68       - user/topics/run-command.html.textile.liquid
69       - user/reference/job-pipeline-ref.html.textile.liquid
70       - user/examples/crunch-examples.html.textile.liquid
71     - Query the metadata database:
72       - user/topics/tutorial-trait-search.html.textile.liquid
73     - Arvados License:
74       - user/copying/copying.html.textile.liquid
75       - user/copying/agpl-3.0.html
76       - user/copying/LICENSE-2.0.html
77       - user/copying/by-sa-3.0.html
78   sdk:
79     - Overview:
80       - sdk/index.html.textile.liquid
81     - Python:
82       - sdk/python/sdk-python.html.textile.liquid
83       - sdk/python/example.html.textile.liquid
84       - sdk/python/python.html.textile.liquid
85       - sdk/python/crunch-utility-libraries.html.textile.liquid
86       - sdk/python/events.html.textile.liquid
87     - CLI:
88       - sdk/cli/install.html.textile.liquid
89       - sdk/cli/index.html.textile.liquid
90       - sdk/cli/reference.html.textile.liquid
91       - sdk/cli/subcommands.html.textile.liquid
92     - Go:
93       - sdk/go/index.html.textile.liquid
94       - sdk/go/example.html.textile.liquid
95     - Perl:
96       - sdk/perl/index.html.textile.liquid
97       - sdk/perl/example.html.textile.liquid
98     - Ruby:
99       - sdk/ruby/index.html.textile.liquid
100       - sdk/ruby/example.html.textile.liquid
101     - Java:
102       - sdk/java/index.html.textile.liquid
103       - sdk/java/example.html.textile.liquid
104   api:
105     - Concepts:
106       - api/index.html.textile.liquid
107       - api/tokens.html.textile.liquid
108       - api/requests.html.textile.liquid
109       - api/methods.html.textile.liquid
110       - api/resources.html.textile.liquid
111       - api/permission-model.html.textile.liquid
112       - api/storage.html.textile.liquid
113       - api/execution.html.textile.liquid
114     - Permission and authentication:
115       - api/methods/api_client_authorizations.html.textile.liquid
116       - api/methods/api_clients.html.textile.liquid
117       - api/methods/authorized_keys.html.textile.liquid
118       - api/methods/groups.html.textile.liquid
119       - api/methods/users.html.textile.liquid
120     - System resources:
121       - api/methods/keep_services.html.textile.liquid
122       - api/methods/links.html.textile.liquid
123       - api/methods/logs.html.textile.liquid
124       - api/methods/nodes.html.textile.liquid
125       - api/methods/virtual_machines.html.textile.liquid
126       - api/methods/keep_disks.html.textile.liquid
127     - Data management:
128       - api/methods/collections.html.textile.liquid
129       - api/methods/repositories.html.textile.liquid
130     - Container engine:
131       - api/methods/container_requests.html.textile.liquid
132       - api/methods/containers.html.textile.liquid
133       - api/methods/workflows.html.textile.liquid
134     - Jobs engine (deprecated):
135       - api/crunch-scripts.html.textile.liquid
136       - api/methods/jobs.html.textile.liquid
137       - api/methods/job_tasks.html.textile.liquid
138       - api/methods/pipeline_instances.html.textile.liquid
139       - api/methods/pipeline_templates.html.textile.liquid
140     - Metadata for bioinformatics:
141       - api/methods/humans.html.textile.liquid
142       - api/methods/specimens.html.textile.liquid
143       - api/methods/traits.html.textile.liquid
144   installguide:
145     - Overview:
146       - install/index.html.textile.liquid
147     - Docker quick start:
148       - install/arvbox.html.textile.liquid
149     - Manual installation:
150       - install/install-manual-prerequisites.html.textile.liquid
151       - install/install-postgresql.html.textile.liquid
152       - install/install-sso.html.textile.liquid
153       - install/install-api-server.html.textile.liquid
154       - install/install-ws.html.textile.liquid
155       - install/install-arv-git-httpd.html.textile.liquid
156       - install/install-workbench-app.html.textile.liquid
157       - install/install-shell-server.html.textile.liquid
158       - install/create-standard-objects.html.textile.liquid
159       - install/install-keepstore.html.textile.liquid
160       - install/configure-azure-blob-storage.html.textile.liquid
161       - install/install-keepproxy.html.textile.liquid
162       - install/install-keep-web.html.textile.liquid
163       - install/install-keep-balance.html.textile.liquid
164     - Containers API support on SLURM:
165       - install/crunch2-slurm/install-prerequisites.html.textile.liquid
166       - install/crunch2-slurm/install-slurm.html.textile.liquid
167       - install/crunch2-slurm/install-compute-node.html.textile.liquid
168       - install/crunch2-slurm/install-dispatch.html.textile.liquid
169       - install/crunch2-slurm/install-test.html.textile.liquid
170       - install/install-nodemanager.html.textile.liquid
171       - install/install-compute-ping.html.textile.liquid
172     - Jobs API support (deprecated):
173       - install/install-crunch-dispatch.html.textile.liquid
174       - install/install-compute-node.html.textile.liquid
175     - Helpful hints:
176       - install/copy_pipeline_from_curoverse.html.textile.liquid
177       - install/cheat_sheet.html.textile.liquid
178     - Migrating from Docker 1.9:
179       - install/migrate-docker19.html.textile.liquid