Merge branch '21132-api-resources-fixes'
[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).  You can also set these on the
8 # command line: $ rake generate baseurl=/example
9 # arvados_api_host=example.com
10
11 baseurl:
12 current_version:
13 all_versions:
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     - Walkthough:
26       - user/getting_started/workbench.html.textile.liquid
27       - user/tutorials/wgs-tutorial.html.textile.liquid
28     - Working at the Command Line:
29       - user/getting_started/setup-cli.html.textile.liquid
30       - user/reference/api-tokens.html.textile.liquid
31       - user/getting_started/check-environment.html.textile.liquid
32     - Working with data sets:
33       - user/tutorials/tutorial-projects.html.textile.liquid
34       - user/tutorials/tutorial-keep.html.textile.liquid
35       - user/tutorials/tutorial-keep-get.html.textile.liquid
36       - user/tutorials/tutorial-keep-collection-lifecycle.html.textile.liquid
37       - user/topics/arv-copy.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/collection-versioning.html.textile.liquid
42       - user/topics/storage-classes.html.textile.liquid
43     - Data Analysis with Workflows:
44       - user/tutorials/tutorial-workflow-workbench.html.textile.liquid
45       - user/cwl/cwl-runner.html.textile.liquid
46       - user/cwl/cwl-run-options.html.textile.liquid
47       - user/cwl/crunchstat-summary.html.textile.liquid
48       - user/debugging/container-shell-access.html.textile.liquid
49       - user/cwl/costanalyzer.html.textile.liquid
50       - user/cwl/federated-workflows.html.textile.liquid
51     - Common Workflow Language:
52       - user/cwl/rnaseq-cwl-training.html.textile.liquid
53       - user/cwl/arvados-vscode-training.html.md.liquid
54       - user/topics/arv-docker.html.textile.liquid
55       - user/cwl/cwl-style.html.textile.liquid
56       - user/tutorials/writing-cwl-workflow.html.textile.liquid
57       - user/cwl/cwl-extensions.html.textile.liquid
58       - user/cwl/cwl-versions.html.textile.liquid
59     - Access an Arvados virtual machine:
60       - user/getting_started/vm-login-with-webshell.html.textile.liquid
61       - user/getting_started/ssh-access-unix.html.textile.liquid
62       - user/getting_started/ssh-access-windows.html.textile.liquid
63     - Reference:
64       - user/topics/workbench-migration.html.textile.liquid
65       - user/topics/link-accounts.html.textile.liquid
66       - user/reference/cookbook.html.textile.liquid
67     - Arvados License:
68       - user/copying/copying.html.textile.liquid
69       - user/copying/agpl-3.0.html
70       - user/copying/LICENSE-2.0.html
71       - user/copying/by-sa-3.0.html
72   sdk:
73     - Overview:
74       - sdk/index.html.textile.liquid
75     - Python:
76       - sdk/python/sdk-python.html.textile.liquid
77       - sdk/python/api-client.html.textile.liquid
78       - sdk/python/cookbook.html.textile.liquid
79       - sdk/python/python.html.textile.liquid
80       - sdk/python/arvados-fuse.html.textile.liquid
81       - sdk/python/arvados-cwl-runner.html.textile.liquid
82       - sdk/python/events.html.textile.liquid
83     - CLI:
84       - sdk/cli/install.html.textile.liquid
85       - sdk/cli/index.html.textile.liquid
86       - sdk/cli/reference.html.textile.liquid
87       - sdk/cli/subcommands.html.textile.liquid
88       - sdk/cli/project-management.html.textile.liquid
89     - Go:
90       - sdk/go/index.html.textile.liquid
91       - sdk/go/example.html.textile.liquid
92     - R:
93       - sdk/R/index.html.md
94       - sdk/R/arvados/index.html.textile.liquid
95     - Ruby:
96       - sdk/ruby/index.html.textile.liquid
97       - sdk/ruby/example.html.textile.liquid
98     - Java v2:
99       - sdk/java-v2/index.html.textile.liquid
100       - sdk/java-v2/example.html.textile.liquid
101       - sdk/java-v2/javadoc.html.textile.liquid
102   api:
103     - Concepts:
104       - api/index.html.textile.liquid
105       - api/tokens.html.textile.liquid
106       - api/requests.html.textile.liquid
107       - api/methods.html.textile.liquid
108       - api/resources.html.textile.liquid
109     - Permission and authentication:
110       - api/methods/users.html.textile.liquid
111       - api/methods/groups.html.textile.liquid
112       - api/methods/api_client_authorizations.html.textile.liquid
113       - api/methods/links.html.textile.liquid
114       - api/methods/authorized_keys.html.textile.liquid
115       - api/methods/api_clients.html.textile.liquid
116       - api/methods/user_agreements.html.textile.liquid
117       - api/methods/virtual_machines.html.textile.liquid
118     - Data management:
119       - api/keep-webdav.html.textile.liquid
120       - api/keep-s3.html.textile.liquid
121       - api/keep-web-urls.html.textile.liquid
122       - api/projects.html.textile.liquid
123       - api/properties.html.textile.liquid
124       - api/methods/collections.html.textile.liquid
125       - api/methods/logs.html.textile.liquid
126       - api/methods/keep_services.html.textile.liquid
127     - Container engine:
128       - api/methods/container_requests.html.textile.liquid
129       - api/methods/containers.html.textile.liquid
130       - api/methods/workflows.html.textile.liquid
131       - api/dispatch.html.textile.liquid
132     - Jobs engine (legacy):
133       - api/crunch-scripts.html.textile.liquid
134       - api/methods/jobs.html.textile.liquid
135       - api/methods/job_tasks.html.textile.liquid
136       - api/methods/pipeline_instances.html.textile.liquid
137       - api/methods/pipeline_templates.html.textile.liquid
138       - api/methods/nodes.html.textile.liquid
139       - api/methods/repositories.html.textile.liquid
140       - api/methods/keep_disks.html.textile.liquid
141     - Metadata for bioinformatics (legacy):
142       - api/methods/humans.html.textile.liquid
143       - api/methods/specimens.html.textile.liquid
144       - api/methods/traits.html.textile.liquid
145   architecture:
146     - Topics:
147       - architecture/index.html.textile.liquid
148     - Storage in Keep:
149       - architecture/storage.html.textile.liquid
150       - architecture/keep-components-overview.html.textile.liquid
151       - architecture/keep-clients.html.textile.liquid
152       - architecture/keep-data-lifecycle.html.textile.liquid
153       - architecture/manifest-format.html.textile.liquid
154     - Computation with Crunch:
155       - api/execution.html.textile.liquid
156       - architecture/dispatchcloud.html.textile.liquid
157       - architecture/hpc.html.textile.liquid
158       - architecture/singularity.html.textile.liquid
159     - Other:
160       - api/permission-model.html.textile.liquid
161       - architecture/federation.html.textile.liquid
162   admin:
163     - Topics:
164       - admin/index.html.textile.liquid
165     - Users and Groups:
166       - admin/user-management.html.textile.liquid
167       - admin/user-management-cli.html.textile.liquid
168       - admin/group-management.html.textile.liquid
169       - admin/reassign-ownership.html.textile.liquid
170       - admin/link-accounts.html.textile.liquid
171       - admin/federation.html.textile.liquid
172       - admin/merge-remote-account.html.textile.liquid
173       - admin/migrating-providers.html.textile.liquid
174       - user/topics/arvados-sync-external-sources.html.textile.liquid
175       - admin/scoped-tokens.html.textile.liquid
176       - admin/token-expiration-policy.html.textile.liquid
177     - Monitoring:
178       - admin/logging.html.textile.liquid
179       - admin/metrics.html.textile.liquid
180       - admin/health-checks.html.textile.liquid
181       - admin/inspect.html.textile.liquid
182       - admin/diagnostics.html.textile.liquid
183       - admin/management-token.html.textile.liquid
184       - admin/user-activity.html.textile.liquid
185     - Data Management:
186       - admin/collection-versioning.html.textile.liquid
187       - admin/collection-managed-properties.html.textile.liquid
188       - admin/restricting-upload-download.html.textile.liquid
189       - admin/keep-balance.html.textile.liquid
190       - admin/controlling-container-reuse.html.textile.liquid
191       - admin/logs-table-management.html.textile.liquid
192       - admin/metadata-vocabulary.html.textile.liquid
193       - admin/storage-classes.html.textile.liquid
194       - admin/keep-recovering-data.html.textile.liquid
195       - admin/keep-measuring-deduplication.html.textile.liquid
196     - Cloud:
197       - admin/spot-instances.html.textile.liquid
198       - admin/cloudtest.html.textile.liquid
199     - Other:
200       - install/migrate-docker19.html.textile.liquid
201       - admin/upgrade-crunch2.html.textile.liquid
202   installguide:
203     - Overview:
204       - install/index.html.textile.liquid
205     - Docker quick start:
206       - install/arvbox.html.textile.liquid
207     - Arvados Installer:
208       - install/salt-single-host.html.textile.liquid
209       - install/salt-multi-host.html.textile.liquid
210 #    - Arvados on Kubernetes:
211 #      - install/arvados-on-kubernetes.html.textile.liquid
212 #      - install/arvados-on-kubernetes-minikube.html.textile.liquid
213 #      - install/arvados-on-kubernetes-GKE.html.textile.liquid
214     - Manual installation:
215       - install/install-manual-prerequisites.html.textile.liquid
216       - install/packages.html.textile.liquid
217     - Configuration:
218       - install/config.html.textile.liquid
219       - admin/config-urls.html.textile.liquid
220       - admin/config.html.textile.liquid
221     - Maintenance and upgrading:
222       - admin/upgrading.html.textile.liquid
223       - admin/maintenance-and-upgrading.html.textile.liquid
224     - Core:
225       - install/install-api-server.html.textile.liquid
226       - install/diagnostics.html.textile.liquid
227     - Keep:
228       - install/install-keepstore.html.textile.liquid
229       - install/configure-fs-storage.html.textile.liquid
230       - install/configure-s3-object-storage.html.textile.liquid
231       - install/configure-azure-blob-storage.html.textile.liquid
232       - install/install-keepproxy.html.textile.liquid
233       - install/install-keep-web.html.textile.liquid
234       - install/install-keep-balance.html.textile.liquid
235     - User interface:
236       - install/setup-login.html.textile.liquid
237       - install/install-ws.html.textile.liquid
238       - install/install-workbench2-app.html.textile.liquid
239       - install/workbench.html.textile.liquid
240 #      - install/install-composer.html.textile.liquid
241     - Additional services:
242       - install/install-shell-server.html.textile.liquid
243       - install/install-webshell.html.textile.liquid
244       - install/install-arv-git-httpd.html.textile.liquid
245 #    - Containers API (all):
246 #      - install/install-jobs-image.html.textile.liquid
247     - Containers API (cloud):
248       - install/crunch2-cloud/install-compute-node.html.textile.liquid
249       - install/crunch2-cloud/install-dispatch-cloud.html.textile.liquid
250     - Compute nodes (Slurm or LSF):
251       - install/crunch2/install-compute-node-docker.html.textile.liquid
252       - install/crunch2/install-compute-node-singularity.html.textile.liquid
253     - Containers API (Slurm):
254       - install/crunch2-slurm/install-dispatch.html.textile.liquid
255       - install/crunch2-slurm/configure-slurm.html.textile.liquid
256       - install/crunch2-slurm/install-test.html.textile.liquid
257     - Containers API (LSF):
258       - install/crunch2-lsf/install-dispatch.html.textile.liquid
259     - Additional configuration:
260       - install/container-shell-access.html.textile.liquid
261     - External dependencies:
262       - install/install-postgresql.html.textile.liquid
263       - install/ruby.html.textile.liquid
264       - install/nginx.html.textile.liquid
265       - install/install-docker.html.textile.liquid