17668: basic documentation for the new container shell feature.
[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 current_version:
15 all_versions:
16 arvados_api_host: localhost
17 arvados_cluster_uuid: local
18 arvados_workbench_host: http://localhost
19
20 exclude: ["Rakefile", "tmp", "vendor"]
21
22 navbar:
23   userguide:
24     - Welcome:
25       - user/index.html.textile.liquid
26       - user/getting_started/community.html.textile.liquid
27     - Walkthough:
28       - user/tutorials/wgs-tutorial.html.textile.liquid
29     - Run a workflow using Workbench:
30       - user/getting_started/workbench.html.textile.liquid
31       - user/tutorials/tutorial-workflow-workbench.html.textile.liquid
32     - Working at the Command Line:
33       - user/getting_started/setup-cli.html.textile.liquid
34       - user/reference/api-tokens.html.textile.liquid
35       - user/getting_started/check-environment.html.textile.liquid
36     - Access an Arvados virtual machine:
37       - user/getting_started/vm-login-with-webshell.html.textile.liquid
38       - user/getting_started/ssh-access-unix.html.textile.liquid
39       - user/getting_started/ssh-access-windows.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-gnu-linux.html.textile.liquid
44       - user/tutorials/tutorial-keep-mount-os-x.html.textile.liquid
45       - user/tutorials/tutorial-keep-mount-windows.html.textile.liquid
46       - user/tutorials/tutorial-keep-collection-lifecycle.html.textile.liquid
47       - user/topics/arv-copy.html.textile.liquid
48       - user/topics/collection-versioning.html.textile.liquid
49       - user/topics/storage-classes.html.textile.liquid
50     - Data Analysis with Workflows:
51       - user/cwl/arvados-vscode-training.html.md.liquid
52       - user/cwl/cwl-runner.html.textile.liquid
53       - user/cwl/cwl-run-options.html.textile.liquid
54       - user/tutorials/writing-cwl-workflow.html.textile.liquid
55       - user/topics/arv-docker.html.textile.liquid
56       - user/cwl/cwl-style.html.textile.liquid
57       - user/cwl/cwl-extensions.html.textile.liquid
58       - user/cwl/federated-workflows.html.textile.liquid
59       - user/cwl/cwl-versions.html.textile.liquid
60       - user/cwl/crunchstat-summary.html.textile.liquid
61       - user/debugging/container-shell-access.html.textile.liquid
62     - Working with git repositories:
63       - user/tutorials/add-new-repository.html.textile.liquid
64       - user/tutorials/git-arvados-guide.html.textile.liquid
65     - Reference:
66       - user/topics/link-accounts.html.textile.liquid
67       - user/reference/cookbook.html.textile.liquid
68     - Arvados License:
69       - user/copying/copying.html.textile.liquid
70       - user/copying/agpl-3.0.html
71       - user/copying/LICENSE-2.0.html
72       - user/copying/by-sa-3.0.html
73   sdk:
74     - Overview:
75       - sdk/index.html.textile.liquid
76     - Python:
77       - sdk/python/sdk-python.html.textile.liquid
78       - sdk/python/example.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/cookbook.html.textile.liquid
83       - sdk/python/events.html.textile.liquid
84     - CLI:
85       - sdk/cli/install.html.textile.liquid
86       - sdk/cli/index.html.textile.liquid
87       - sdk/cli/reference.html.textile.liquid
88       - sdk/cli/subcommands.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     - Java v1:
103       - sdk/java/index.html.textile.liquid
104       - sdk/java/example.html.textile.liquid
105     - Perl:
106       - sdk/perl/index.html.textile.liquid
107       - sdk/perl/example.html.textile.liquid
108   api:
109     - Concepts:
110       - api/index.html.textile.liquid
111       - api/tokens.html.textile.liquid
112       - api/requests.html.textile.liquid
113       - api/methods.html.textile.liquid
114       - api/resources.html.textile.liquid
115       - api/tokens_sso.html.textile.liquid
116     - Permission and authentication:
117       - api/methods/api_client_authorizations.html.textile.liquid
118       - api/methods/api_clients.html.textile.liquid
119       - api/methods/authorized_keys.html.textile.liquid
120       - api/methods/groups.html.textile.liquid
121       - api/methods/users.html.textile.liquid
122       - api/methods/user_agreements.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/keep-webdav.html.textile.liquid
132       - api/keep-s3.html.textile.liquid
133       - api/keep-web-urls.html.textile.liquid
134       - api/projects.html.textile.liquid
135       - api/methods/collections.html.textile.liquid
136       - api/methods/repositories.html.textile.liquid
137     - Container engine:
138       - api/methods/container_requests.html.textile.liquid
139       - api/methods/containers.html.textile.liquid
140       - api/methods/workflows.html.textile.liquid
141     - Management (admin/system):
142       - api/dispatch.html.textile.liquid
143     - Jobs engine (legacy):
144       - api/crunch-scripts.html.textile.liquid
145       - api/methods/jobs.html.textile.liquid
146       - api/methods/job_tasks.html.textile.liquid
147       - api/methods/pipeline_instances.html.textile.liquid
148       - api/methods/pipeline_templates.html.textile.liquid
149     - Metadata for bioinformatics (deprecated):
150       - api/methods/humans.html.textile.liquid
151       - api/methods/specimens.html.textile.liquid
152       - api/methods/traits.html.textile.liquid
153   architecture:
154     - Topics:
155       - architecture/index.html.textile.liquid
156     - Storage in Keep:
157       - architecture/storage.html.textile.liquid
158       - architecture/keep-components-overview.html.textile.liquid
159       - architecture/keep-clients.html.textile.liquid
160       - architecture/keep-data-lifecycle.html.textile.liquid
161       - architecture/manifest-format.html.textile.liquid
162     - Computation with Crunch:
163       - api/execution.html.textile.liquid
164     - Other:
165       - api/permission-model.html.textile.liquid
166       - architecture/federation.html.textile.liquid
167   admin:
168     - Topics:
169       - admin/index.html.textile.liquid
170     - Users and Groups:
171       - admin/user-management.html.textile.liquid
172       - admin/user-management-cli.html.textile.liquid
173       - admin/reassign-ownership.html.textile.liquid
174       - admin/link-accounts.html.textile.liquid
175       - admin/group-management.html.textile.liquid
176       - admin/federation.html.textile.liquid
177       - admin/merge-remote-account.html.textile.liquid
178       - admin/migrating-providers.html.textile.liquid
179       - user/topics/arvados-sync-groups.html.textile.liquid
180       - admin/scoped-tokens.html.textile.liquid
181       - admin/token-expiration-policy.html.textile.liquid
182       - admin/user-activity.html.textile.liquid
183     - Monitoring:
184       - admin/logging.html.textile.liquid
185       - admin/metrics.html.textile.liquid
186       - admin/health-checks.html.textile.liquid
187       - admin/management-token.html.textile.liquid
188     - Data Management:
189       - admin/collection-versioning.html.textile.liquid
190       - admin/collection-managed-properties.html.textile.liquid
191       - admin/keep-balance.html.textile.liquid
192       - admin/controlling-container-reuse.html.textile.liquid
193       - admin/logs-table-management.html.textile.liquid
194       - admin/workbench2-vocabulary.html.textile.liquid
195       - admin/storage-classes.html.textile.liquid
196       - admin/keep-recovering-data.html.textile.liquid
197       - admin/keep-measuring-deduplication.html.textile.liquid
198     - Cloud:
199       - admin/spot-instances.html.textile.liquid
200       - admin/cloudtest.html.textile.liquid
201     - Other:
202       - install/migrate-docker19.html.textile.liquid
203       - admin/upgrade-crunch2.html.textile.liquid
204   installguide:
205     - Overview:
206       - install/index.html.textile.liquid
207     - Docker quick start:
208       - install/arvbox.html.textile.liquid
209     - Installation with Salt:
210       - install/salt.html.textile.liquid
211       - install/salt-vagrant.html.textile.liquid
212       - install/salt-single-host.html.textile.liquid
213       - install/salt-multi-host.html.textile.liquid
214     - Arvados on Kubernetes:
215       - install/arvados-on-kubernetes.html.textile.liquid
216       - install/arvados-on-kubernetes-minikube.html.textile.liquid
217       - install/arvados-on-kubernetes-GKE.html.textile.liquid
218     - Manual installation:
219       - install/install-manual-prerequisites.html.textile.liquid
220       - install/packages.html.textile.liquid
221       - admin/upgrading.html.textile.liquid
222     - Configuration:
223       - install/config.html.textile.liquid
224       - admin/config-migration.html.textile.liquid
225       - admin/config.html.textile.liquid
226     - Core:
227       - install/install-api-server.html.textile.liquid
228     - Keep:
229       - install/install-keepstore.html.textile.liquid
230       - install/configure-fs-storage.html.textile.liquid
231       - install/configure-s3-object-storage.html.textile.liquid
232       - install/configure-azure-blob-storage.html.textile.liquid
233       - install/install-keepproxy.html.textile.liquid
234       - install/install-keep-web.html.textile.liquid
235       - install/install-keep-balance.html.textile.liquid
236     - User interface:
237       - install/setup-login.html.textile.liquid
238       - install/install-ws.html.textile.liquid
239       - install/install-workbench-app.html.textile.liquid
240       - install/install-workbench2-app.html.textile.liquid
241       - install/install-composer.html.textile.liquid
242     - Additional services:
243       - install/install-shell-server.html.textile.liquid
244       - install/install-webshell.html.textile.liquid
245       - install/install-arv-git-httpd.html.textile.liquid
246     - Containers API (cloud):
247       - install/install-jobs-image.html.textile.liquid
248       - install/crunch2-cloud/install-compute-node.html.textile.liquid
249       - install/crunch2-cloud/install-dispatch-cloud.html.textile.liquid
250     - Containers API (slurm):
251       - install/crunch2-slurm/install-dispatch.html.textile.liquid
252       - install/crunch2-slurm/configure-slurm.html.textile.liquid
253       - install/crunch2-slurm/install-compute-node.html.textile.liquid
254       - install/crunch2-slurm/install-test.html.textile.liquid
255     - Additional configuration:
256       - install/container-shell-access.html.textile.liquid
257     - External dependencies:
258       - install/install-postgresql.html.textile.liquid
259       - install/ruby.html.textile.liquid
260       - install/nginx.html.textile.liquid
261       - install/install-docker.html.textile.liquid