X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/55459e4c87f2ff9a2975971cf73b420f8d30bfc2..b6a55c2430033ee1a17b2266b529b425e641d19f:/doc/_config.yml diff --git a/doc/_config.yml b/doc/_config.yml index 3c4bb96a3c..cfae671929 100644 --- a/doc/_config.yml +++ b/doc/_config.yml @@ -1,3 +1,7 @@ +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: CC-BY-SA-3.0 + # baseurl is the location of the generated site from the browser's # perspective (e.g., http://doc.arvados.org or # file:///tmp/arvados/doc/.site). To make docs show up inside @@ -8,22 +12,12 @@ baseurl: arvados_api_host: localhost +arvados_cluster_uuid: local arvados_workbench_host: http://localhost exclude: ["Rakefile", "tmp", "vendor"] navbar: - #start: - #- Getting Started: - #- start/index.html.textile.liquid - #- Quickstart: - #- start/getting_started/publicproject.html.textile.liquid - #- start/getting_started/firstpipeline.html.textile.liquid - #- Common Use Cases: - #- start/getting_started/sharedata.html.textile.liquid - #- Next Steps: - #- start/getting_started/nextsteps.html.textile.liquid - userguide: - Welcome: - user/index.html.textile.liquid @@ -31,6 +25,7 @@ navbar: - Run a workflow using Workbench: - user/getting_started/workbench.html.textile.liquid - user/tutorials/tutorial-workflow-workbench.html.textile.liquid + - user/composer/composer.html.textile.liquid - Access an Arvados virtual machine: - user/getting_started/vm-login-with-webshell.html.textile.liquid - user/getting_started/ssh-access-unix.html.textile.liquid @@ -40,42 +35,47 @@ navbar: - Working with data sets: - user/tutorials/tutorial-keep.html.textile.liquid - user/tutorials/tutorial-keep-get.html.textile.liquid - - user/tutorials/tutorial-keep-collection-lifecycle.html.textile.liquid - - user/tutorials/tutorial-keep-mount.html.textile.liquid + - user/tutorials/tutorial-keep-mount-gnu-linux.html.textile.liquid + - user/tutorials/tutorial-keep-mount-os-x.html.textile.liquid + - user/tutorials/tutorial-keep-mount-windows.html.textile.liquid - user/topics/keep.html.textile.liquid + - user/tutorials/tutorial-keep-collection-lifecycle.html.textile.liquid - user/topics/arv-copy.html.textile.liquid + - user/topics/storage-classes.html.textile.liquid + - user/topics/collection-versioning.html.textile.liquid - Running workflows at the command line: - user/cwl/cwl-runner.html.textile.liquid - user/cwl/cwl-run-options.html.textile.liquid - - user/topics/running-pipeline-command-line.html.textile.liquid - - user/topics/arv-run.html.textile.liquid - Working with git repositories: - user/tutorials/add-new-repository.html.textile.liquid - user/tutorials/git-arvados-guide.html.textile.liquid - Develop an Arvados workflow: - user/tutorials/intro-crunch.html.textile.liquid - user/tutorials/writing-cwl-workflow.html.textile.liquid + - user/cwl/federated-workflows.html.textile.liquid - user/cwl/cwl-style.html.textile.liquid - user/cwl/cwl-extensions.html.textile.liquid - user/topics/arv-docker.html.textile.liquid + - Reference: + - user/topics/link-accounts.html.textile.liquid + - user/reference/cookbook.html.textile.liquid + - Arvados License: + - user/copying/copying.html.textile.liquid + - user/copying/agpl-3.0.html + - user/copying/LICENSE-2.0.html + - user/copying/by-sa-3.0.html + - Obsolete documentation: + - user/topics/running-pipeline-command-line.html.textile.liquid + - user/topics/arv-run.html.textile.liquid - user/tutorials/running-external-program.html.textile.liquid - user/topics/crunch-tools-overview.html.textile.liquid - user/tutorials/tutorial-firstscript.html.textile.liquid - user/tutorials/tutorial-submit-job.html.textile.liquid - user/topics/tutorial-parallel.html.textile.liquid - - Develop a web service: - - user/topics/arv-web.html.textile.liquid - - Reference: - user/topics/run-command.html.textile.liquid - user/reference/job-pipeline-ref.html.textile.liquid - user/examples/crunch-examples.html.textile.liquid - - Query the metadata database: - user/topics/tutorial-trait-search.html.textile.liquid - - Arvados License: - - user/copying/copying.html.textile.liquid - - user/copying/agpl-3.0.html - - user/copying/LICENSE-2.0.html - - user/copying/by-sa-3.0.html sdk: - Overview: - sdk/index.html.textile.liquid @@ -83,8 +83,10 @@ navbar: - sdk/python/sdk-python.html.textile.liquid - sdk/python/example.html.textile.liquid - sdk/python/python.html.textile.liquid - - sdk/python/crunch-utility-libraries.html.textile.liquid + - sdk/python/arvados-fuse.html.textile.liquid - sdk/python/events.html.textile.liquid + - sdk/python/cookbook.html.textile.liquid + - sdk/python/crunch-utility-libraries.html.textile.liquid - CLI: - sdk/cli/install.html.textile.liquid - sdk/cli/index.html.textile.liquid @@ -93,13 +95,20 @@ navbar: - Go: - sdk/go/index.html.textile.liquid - sdk/go/example.html.textile.liquid + - R: + - sdk/R/index.html.md + - sdk/R/arvados/index.html.textile.liquid - Perl: - sdk/perl/index.html.textile.liquid - sdk/perl/example.html.textile.liquid - Ruby: - sdk/ruby/index.html.textile.liquid - sdk/ruby/example.html.textile.liquid - - Java: + - Java v2: + - sdk/java-v2/index.html.textile.liquid + - sdk/java-v2/example.html.textile.liquid + - sdk/java-v2/javadoc.html.textile.liquid + - Java v1: - sdk/java/index.html.textile.liquid - sdk/java/example.html.textile.liquid api: @@ -109,9 +118,6 @@ navbar: - api/requests.html.textile.liquid - api/methods.html.textile.liquid - api/resources.html.textile.liquid - - api/permission-model.html.textile.liquid - - api/storage.html.textile.liquid - - api/execution.html.textile.liquid - Permission and authentication: - api/methods/api_client_authorizations.html.textile.liquid - api/methods/api_clients.html.textile.liquid @@ -142,26 +148,71 @@ navbar: - api/methods/humans.html.textile.liquid - api/methods/specimens.html.textile.liquid - api/methods/traits.html.textile.liquid + architecture: + - Topics: + - architecture/index.html.textile.liquid + - api/storage.html.textile.liquid + - api/execution.html.textile.liquid + - api/permission-model.html.textile.liquid + - architecture/federation.html.textile.liquid + admin: + - Topics: + - admin/index.html.textile.liquid + - Configuration: + - admin/config.html.textile.liquid + - Upgrading and migrations: + - admin/upgrading.html.textile.liquid + - admin/config-migration.html.textile.liquid + - install/migrate-docker19.html.textile.liquid + - admin/upgrade-crunch2.html.textile.liquid + - Users and Groups: + - install/cheat_sheet.html.textile.liquid + - admin/activation.html.textile.liquid + - admin/merge-remote-account.html.textile.liquid + - admin/migrating-providers.html.textile.liquid + - user/topics/arvados-sync-groups.html.textile.liquid + - Monitoring: + - admin/health-checks.html.textile.liquid + - admin/metrics.html.textile.liquid + - admin/management-token.html.textile.liquid + - Cloud: + - admin/storage-classes.html.textile.liquid + - admin/spot-instances.html.textile.liquid + - Other: + - admin/collection-versioning.html.textile.liquid + - admin/federation.html.textile.liquid + - admin/controlling-container-reuse.html.textile.liquid + - admin/logs-table-management.html.textile.liquid installguide: - Overview: - install/index.html.textile.liquid - Docker quick start: - install/arvbox.html.textile.liquid + - Arvados on Kubernetes: + - install/arvados-on-kubernetes.html.textile.liquid - Manual installation: - install/install-manual-prerequisites.html.textile.liquid + - install/install-components.html.textile.liquid + - Core: - install/install-postgresql.html.textile.liquid - - install/install-sso.html.textile.liquid - install/install-api-server.html.textile.liquid - - install/install-ws.html.textile.liquid - - install/install-arv-git-httpd.html.textile.liquid - - install/install-workbench-app.html.textile.liquid - - install/install-shell-server.html.textile.liquid - - install/create-standard-objects.html.textile.liquid + - install/install-controller.html.textile.liquid + - Keep: - install/install-keepstore.html.textile.liquid + - install/configure-fs-storage.html.textile.liquid + - install/configure-s3-object-storage.html.textile.liquid - install/configure-azure-blob-storage.html.textile.liquid - install/install-keepproxy.html.textile.liquid - install/install-keep-web.html.textile.liquid - install/install-keep-balance.html.textile.liquid + - User interface: + - install/install-sso.html.textile.liquid + - install/install-workbench-app.html.textile.liquid + - install/install-composer.html.textile.liquid + - Additional services: + - install/install-ws.html.textile.liquid + - install/install-shell-server.html.textile.liquid + - install/install-arv-git-httpd.html.textile.liquid - Containers API support on SLURM: - install/crunch2-slurm/install-prerequisites.html.textile.liquid - install/crunch2-slurm/install-slurm.html.textile.liquid @@ -170,11 +221,8 @@ navbar: - install/crunch2-slurm/install-test.html.textile.liquid - install/install-nodemanager.html.textile.liquid - install/install-compute-ping.html.textile.liquid + - Containers API support on cloud (experimental): + - install/install-dispatch-cloud.html.textile.liquid - Jobs API support (deprecated): - install/install-crunch-dispatch.html.textile.liquid - install/install-compute-node.html.textile.liquid - - Helpful hints: - - install/copy_pipeline_from_curoverse.html.textile.liquid - - install/cheat_sheet.html.textile.liquid - - Migrating from Docker 1.9: - - install/migrate-docker19.html.textile.liquid