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 v2:
 108       - sdk/java-v2/index.html.textile.liquid
 109       - sdk/java-v2/javadoc.html.textile.liquid
 110     - Java v1:
 111       - sdk/java/index.html.textile.liquid
 112       - sdk/java/example.html.textile.liquid
 113   api:
 114     - Concepts:
 115       - api/index.html.textile.liquid
 116       - api/tokens.html.textile.liquid
 117       - api/requests.html.textile.liquid
 118       - api/methods.html.textile.liquid
 119       - api/resources.html.textile.liquid
 120     - Permission and authentication:
 121       - api/methods/api_client_authorizations.html.textile.liquid
 122       - api/methods/api_clients.html.textile.liquid
 123       - api/methods/authorized_keys.html.textile.liquid
 124       - api/methods/groups.html.textile.liquid
 125       - api/methods/users.html.textile.liquid
 126     - System resources:
 127       - api/methods/keep_services.html.textile.liquid
 128       - api/methods/links.html.textile.liquid
 129       - api/methods/logs.html.textile.liquid
 130       - api/methods/nodes.html.textile.liquid
 131       - api/methods/virtual_machines.html.textile.liquid
 132       - api/methods/keep_disks.html.textile.liquid
 133     - Data management:
 134       - api/methods/collections.html.textile.liquid
 135       - api/methods/repositories.html.textile.liquid
 136     - Container engine:
 137       - api/methods/container_requests.html.textile.liquid
 138       - api/methods/containers.html.textile.liquid
 139       - api/methods/workflows.html.textile.liquid
 140     - Jobs engine (deprecated):
 141       - api/crunch-scripts.html.textile.liquid
 142       - api/methods/jobs.html.textile.liquid
 143       - api/methods/job_tasks.html.textile.liquid
 144       - api/methods/pipeline_instances.html.textile.liquid
 145       - api/methods/pipeline_templates.html.textile.liquid
 146     - Metadata for bioinformatics:
 147       - api/methods/humans.html.textile.liquid
 148       - api/methods/specimens.html.textile.liquid
 149       - api/methods/traits.html.textile.liquid
 150   architecture:
 151     - Topics:
 152       - architecture/index.html.textile.liquid
 153       - api/storage.html.textile.liquid
 154       - api/execution.html.textile.liquid
 155       - api/permission-model.html.textile.liquid
 156       - architecture/federation.html.textile.liquid
 157   admin:
 158     - Topics:
 159       - admin/index.html.textile.liquid
 160     - Upgrading and migrations:
 161       - admin/upgrading.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   installguide:
 181     - Overview:
 182       - install/index.html.textile.liquid
 183     - Docker quick start:
 184       - install/arvbox.html.textile.liquid
 185     - Arvados on Kubernetes:
 186       - install/arvados-on-kubernetes.html.textile.liquid
 187     - Manual installation:
 188       - install/install-manual-prerequisites.html.textile.liquid
 189       - install/install-components.html.textile.liquid
 190     - Core:
 191       - install/install-postgresql.html.textile.liquid
 192       - install/install-api-server.html.textile.liquid
 193       - install/install-controller.html.textile.liquid
 194     - Keep:
 195       - install/install-keepstore.html.textile.liquid
 196       - install/configure-fs-storage.html.textile.liquid
 197       - install/configure-s3-object-storage.html.textile.liquid
 198       - install/configure-azure-blob-storage.html.textile.liquid
 199       - install/install-keepproxy.html.textile.liquid
 200       - install/install-keep-web.html.textile.liquid
 201       - install/install-keep-balance.html.textile.liquid
 202     - User interface:
 203       - install/install-sso.html.textile.liquid
 204       - install/install-workbench-app.html.textile.liquid
 205       - install/install-composer.html.textile.liquid
 206     - Additional services:
 207       - install/install-ws.html.textile.liquid
 208       - install/install-shell-server.html.textile.liquid
 209       - install/install-arv-git-httpd.html.textile.liquid
 210     - Containers API support on SLURM:
 211       - install/crunch2-slurm/install-prerequisites.html.textile.liquid
 212       - install/crunch2-slurm/install-slurm.html.textile.liquid
 213       - install/crunch2-slurm/install-compute-node.html.textile.liquid
 214       - install/crunch2-slurm/install-dispatch.html.textile.liquid
 215       - install/crunch2-slurm/install-test.html.textile.liquid
 216       - install/install-nodemanager.html.textile.liquid
 217       - install/install-compute-ping.html.textile.liquid
 218     - Containers API support on cloud (experimental):
 219       - install/install-dispatch-cloud.html.textile.liquid
 220     - Jobs API support (deprecated):
 221       - install/install-crunch-dispatch.html.textile.liquid
 222       - install/install-compute-node.html.textile.liquid