Merge branch 'master' into 14723-cwl-multiple-file-targets
[arvados.git] / doc / _config.yml
1 # Copyright (C) The Arvados Authors. All rights reserved.
2 #
3 # SPDX-License-Identifier: CC-BY-SA-3.0
4
5 # baseurl is the location of the generated site from the browser's
6 # perspective (e.g., http://doc.arvados.org or
7 # file:///tmp/arvados/doc/.site). To make docs show up inside
8 # workbench, use /doc here and add a symlink at
9 # apps/workbench/public/doc pointing to ../../../doc/.site
10 # You can also set these on the command line:
11 # $ rake generate baseurl=/example arvados_api_host=example.com
12
13 baseurl:
14 arvados_api_host: localhost
15 arvados_cluster_uuid: local
16 arvados_workbench_host: http://localhost
17
18 exclude: ["Rakefile", "tmp", "vendor"]
19
20 navbar:
21   userguide:
22     - Welcome:
23       - user/index.html.textile.liquid
24       - user/getting_started/community.html.textile.liquid
25     - Run a workflow using Workbench:
26       - user/getting_started/workbench.html.textile.liquid
27       - user/tutorials/tutorial-workflow-workbench.html.textile.liquid
28       - user/composer/composer.html.textile.liquid
29     - Access an Arvados virtual machine:
30       - user/getting_started/vm-login-with-webshell.html.textile.liquid
31       - user/getting_started/ssh-access-unix.html.textile.liquid
32       - user/getting_started/ssh-access-windows.html.textile.liquid
33       - user/getting_started/check-environment.html.textile.liquid
34       - user/reference/api-tokens.html.textile.liquid
35     - Working with data sets:
36       - user/tutorials/tutorial-keep.html.textile.liquid
37       - user/tutorials/tutorial-keep-get.html.textile.liquid
38       - user/tutorials/tutorial-keep-mount-gnu-linux.html.textile.liquid
39       - user/tutorials/tutorial-keep-mount-os-x.html.textile.liquid
40       - user/tutorials/tutorial-keep-mount-windows.html.textile.liquid
41       - user/topics/keep.html.textile.liquid
42       - user/tutorials/tutorial-keep-collection-lifecycle.html.textile.liquid
43       - user/topics/arv-copy.html.textile.liquid
44       - user/topics/storage-classes.html.textile.liquid
45       - user/topics/collection-versioning.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     - Working with git repositories:
50       - user/tutorials/add-new-repository.html.textile.liquid
51       - user/tutorials/git-arvados-guide.html.textile.liquid
52     - Develop an Arvados workflow:
53       - user/tutorials/intro-crunch.html.textile.liquid
54       - user/tutorials/writing-cwl-workflow.html.textile.liquid
55       - user/cwl/federated-workflows.html.textile.liquid
56       - user/cwl/cwl-style.html.textile.liquid
57       - user/cwl/cwl-extensions.html.textile.liquid
58       - user/topics/arv-docker.html.textile.liquid
59     - Reference:
60       - user/topics/link-accounts.html.textile.liquid
61       - user/reference/cookbook.html.textile.liquid
62     - Arvados License:
63       - user/copying/copying.html.textile.liquid
64       - user/copying/agpl-3.0.html
65       - user/copying/LICENSE-2.0.html
66       - user/copying/by-sa-3.0.html
67     - Obsolete documentation:
68       - user/topics/running-pipeline-command-line.html.textile.liquid
69       - user/topics/arv-run.html.textile.liquid
70       - user/tutorials/running-external-program.html.textile.liquid
71       - user/topics/crunch-tools-overview.html.textile.liquid
72       - user/tutorials/tutorial-firstscript.html.textile.liquid
73       - user/tutorials/tutorial-submit-job.html.textile.liquid
74       - user/topics/tutorial-parallel.html.textile.liquid
75       - user/topics/run-command.html.textile.liquid
76       - user/reference/job-pipeline-ref.html.textile.liquid
77       - user/examples/crunch-examples.html.textile.liquid
78       - user/topics/tutorial-trait-search.html.textile.liquid
79   sdk:
80     - Overview:
81       - sdk/index.html.textile.liquid
82     - Python:
83       - sdk/python/sdk-python.html.textile.liquid
84       - sdk/python/example.html.textile.liquid
85       - sdk/python/python.html.textile.liquid
86       - sdk/python/arvados-fuse.html.textile.liquid
87       - sdk/python/events.html.textile.liquid
88       - sdk/python/cookbook.html.textile.liquid
89       - sdk/python/crunch-utility-libraries.html.textile.liquid
90     - CLI:
91       - sdk/cli/install.html.textile.liquid
92       - sdk/cli/index.html.textile.liquid
93       - sdk/cli/reference.html.textile.liquid
94       - sdk/cli/subcommands.html.textile.liquid
95     - Go:
96       - sdk/go/index.html.textile.liquid
97       - sdk/go/example.html.textile.liquid
98     - R:
99       - sdk/R/index.html.md
100       - sdk/R/arvados/index.html.textile.liquid
101     - Perl:
102       - sdk/perl/index.html.textile.liquid
103       - sdk/perl/example.html.textile.liquid
104     - Ruby:
105       - sdk/ruby/index.html.textile.liquid
106       - sdk/ruby/example.html.textile.liquid
107     - Java:
108       - sdk/java/index.html.textile.liquid
109       - sdk/java/example.html.textile.liquid
110   api:
111     - Concepts:
112       - api/index.html.textile.liquid
113       - api/tokens.html.textile.liquid
114       - api/requests.html.textile.liquid
115       - api/methods.html.textile.liquid
116       - api/resources.html.textile.liquid
117     - Permission and authentication:
118       - api/methods/api_client_authorizations.html.textile.liquid
119       - api/methods/api_clients.html.textile.liquid
120       - api/methods/authorized_keys.html.textile.liquid
121       - api/methods/groups.html.textile.liquid
122       - api/methods/users.html.textile.liquid
123     - System resources:
124       - api/methods/keep_services.html.textile.liquid
125       - api/methods/links.html.textile.liquid
126       - api/methods/logs.html.textile.liquid
127       - api/methods/nodes.html.textile.liquid
128       - api/methods/virtual_machines.html.textile.liquid
129       - api/methods/keep_disks.html.textile.liquid
130     - Data management:
131       - api/methods/collections.html.textile.liquid
132       - api/methods/repositories.html.textile.liquid
133     - Container engine:
134       - api/methods/container_requests.html.textile.liquid
135       - api/methods/containers.html.textile.liquid
136       - api/methods/workflows.html.textile.liquid
137     - Jobs engine (deprecated):
138       - api/crunch-scripts.html.textile.liquid
139       - api/methods/jobs.html.textile.liquid
140       - api/methods/job_tasks.html.textile.liquid
141       - api/methods/pipeline_instances.html.textile.liquid
142       - api/methods/pipeline_templates.html.textile.liquid
143     - Metadata for bioinformatics:
144       - api/methods/humans.html.textile.liquid
145       - api/methods/specimens.html.textile.liquid
146       - api/methods/traits.html.textile.liquid
147   architecture:
148     - Topics:
149       - architecture/index.html.textile.liquid
150       - api/storage.html.textile.liquid
151       - api/execution.html.textile.liquid
152       - api/permission-model.html.textile.liquid
153       - architecture/federation.html.textile.liquid
154   admin:
155     - Topics:
156       - admin/index.html.textile.liquid
157     - Configuration:
158       - admin/config.html.textile.liquid
159     - Upgrading and migrations:
160       - admin/upgrading.html.textile.liquid
161       - admin/config-migration.html.textile.liquid
162       - install/migrate-docker19.html.textile.liquid
163       - admin/upgrade-crunch2.html.textile.liquid
164     - Users and Groups:
165       - install/cheat_sheet.html.textile.liquid
166       - admin/activation.html.textile.liquid
167       - admin/merge-remote-account.html.textile.liquid
168       - admin/migrating-providers.html.textile.liquid
169       - user/topics/arvados-sync-groups.html.textile.liquid
170     - Monitoring:
171       - admin/health-checks.html.textile.liquid
172       - admin/metrics.html.textile.liquid
173       - admin/management-token.html.textile.liquid
174     - Cloud:
175       - admin/storage-classes.html.textile.liquid
176       - admin/spot-instances.html.textile.liquid
177     - Other:
178       - admin/collection-versioning.html.textile.liquid
179       - admin/federation.html.textile.liquid
180       - admin/controlling-container-reuse.html.textile.liquid
181       - admin/logs-table-management.html.textile.liquid
182   installguide:
183     - Overview:
184       - install/index.html.textile.liquid
185     - Docker quick start:
186       - install/arvbox.html.textile.liquid
187     - Arvados on Kubernetes:
188       - install/arvados-on-kubernetes.html.textile.liquid
189     - Manual installation:
190       - install/install-manual-prerequisites.html.textile.liquid
191       - install/install-components.html.textile.liquid
192     - Core:
193       - install/install-postgresql.html.textile.liquid
194       - install/install-api-server.html.textile.liquid
195       - install/install-controller.html.textile.liquid
196     - Keep:
197       - install/install-keepstore.html.textile.liquid
198       - install/configure-fs-storage.html.textile.liquid
199       - install/configure-s3-object-storage.html.textile.liquid
200       - install/configure-azure-blob-storage.html.textile.liquid
201       - install/install-keepproxy.html.textile.liquid
202       - install/install-keep-web.html.textile.liquid
203       - install/install-keep-balance.html.textile.liquid
204     - User interface:
205       - install/install-sso.html.textile.liquid
206       - install/install-workbench-app.html.textile.liquid
207       - install/install-composer.html.textile.liquid
208     - Additional services:
209       - install/install-ws.html.textile.liquid
210       - install/install-shell-server.html.textile.liquid
211       - install/install-arv-git-httpd.html.textile.liquid
212     - Containers API support on SLURM:
213       - install/crunch2-slurm/install-prerequisites.html.textile.liquid
214       - install/crunch2-slurm/install-slurm.html.textile.liquid
215       - install/crunch2-slurm/install-compute-node.html.textile.liquid
216       - install/crunch2-slurm/install-dispatch.html.textile.liquid
217       - install/crunch2-slurm/install-test.html.textile.liquid
218       - install/install-nodemanager.html.textile.liquid
219       - install/install-compute-ping.html.textile.liquid
220     - Containers API support on cloud (experimental):
221       - install/install-dispatch-cloud.html.textile.liquid
222     - Jobs API support (deprecated):
223       - install/install-crunch-dispatch.html.textile.liquid
224       - install/install-compute-node.html.textile.liquid