X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/3cd8626eda1618b9f2be293fc01c29f3d00973a7..821cb42d42976ec6f750e0b0b191ccc36cbad295:/doc/_config.yml diff --git a/doc/_config.yml b/doc/_config.yml index cd13810e95..ba071d5b3c 100644 --- a/doc/_config.yml +++ b/doc/_config.yml @@ -1,16 +1,161 @@ -exclude: ["Rakefile", "tmp"] -baseurl: /doc -arvados_api_host: qr1hi.arvadosapi.com -layout: default +# 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 +# workbench, use /doc here and add a symlink at +# apps/workbench/public/doc pointing to ../../../doc/.site +# You can also set these on the command line: +# $ rake generate baseurl=/example arvados_api_host=example.com + +baseurl: +arvados_api_host: localhost +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: - - Getting Started - - Tutorials - - Examples - - Reference - api: - - Concepts - - API Methods - - Schema + - Welcome: + - user/index.html.textile.liquid + - user/getting_started/community.html.textile.liquid + - Run a pipeline using Workbench: + - user/getting_started/workbench.html.textile.liquid + - user/tutorials/tutorial-pipeline-workbench.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 + - user/getting_started/ssh-access-windows.html.textile.liquid + - user/getting_started/check-environment.html.textile.liquid + - user/reference/api-tokens.html.textile.liquid + - Working with data sets: + - user/tutorials/tutorial-keep.html.textile.liquid + - user/tutorials/tutorial-keep-get.html.textile.liquid + - user/tutorials/tutorial-keep-mount.html.textile.liquid + - user/topics/keep.html.textile.liquid + - user/topics/arv-copy.html.textile.liquid + - Run a pipeline on the command line: + - user/topics/running-pipeline-command-line.html.textile.liquid + - user/topics/arv-run.html.textile.liquid + - Working with Arvados Repositories: + - user/tutorials/add-new-repository.html.textile.liquid + - Develop a new pipeline: + - user/tutorials/intro-crunch.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 + - user/topics/arv-docker.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: - - Python + - Overview: + - sdk/index.html.textile.liquid + - Python: + - sdk/python/sdk-python.html.textile.liquid + - sdk/python/python.html.textile.liquid + - sdk/python/crunch-utility-libraries.html.textile.liquid + - sdk/python/events.html.textile.liquid + - Perl: + - sdk/perl/index.html.textile.liquid + - Ruby: + - sdk/ruby/index.html.textile.liquid + - Java: + - sdk/java/index.html.textile.liquid + - Go: + - sdk/go/index.html.textile.liquid + - CLI: + - sdk/cli/index.html.textile.liquid + - sdk/cli/install.html.textile.liquid + - sdk/cli/reference.html.textile.liquid + - sdk/cli/subcommands.html.textile.liquid + api: + - Concepts: + - api/index.html.textile.liquid + - api/authentication.html.textile.liquid + - api/methods.html.textile.liquid + - api/resources.html.textile.liquid + - api/crunch-scripts.html.textile.liquid + - api/permission-model.html.textile.liquid + - API Methods: + - api/methods/api_client_authorizations.html.textile.liquid + - api/methods/api_clients.html.textile.liquid + - api/methods/authorized_keys.html.textile.liquid + - api/methods/collections.html.textile.liquid + - api/methods/groups.html.textile.liquid + - api/methods/humans.html.textile.liquid + - api/methods/jobs.html.textile.liquid + - api/methods/job_tasks.html.textile.liquid + - api/methods/keep_disks.html.textile.liquid + - api/methods/keep_services.html.textile.liquid + - api/methods/links.html.textile.liquid + - api/methods/logs.html.textile.liquid + - api/methods/nodes.html.textile.liquid + - api/methods/pipeline_instances.html.textile.liquid + - api/methods/pipeline_templates.html.textile.liquid + - api/methods/repositories.html.textile.liquid + - api/methods/specimens.html.textile.liquid + - api/methods/traits.html.textile.liquid + - api/methods/users.html.textile.liquid + - api/methods/virtual_machines.html.textile.liquid + - Schema: + - api/schema/ApiClientAuthorization.html.textile.liquid + - api/schema/ApiClient.html.textile.liquid + - api/schema/AuthorizedKey.html.textile.liquid + - api/schema/Collection.html.textile.liquid + - api/schema/Group.html.textile.liquid + - api/schema/Human.html.textile.liquid + - api/schema/Job.html.textile.liquid + - api/schema/JobTask.html.textile.liquid + - api/schema/KeepDisk.html.textile.liquid + - api/schema/KeepService.html.textile.liquid + - api/schema/Link.html.textile.liquid + - api/schema/Log.html.textile.liquid + - api/schema/Node.html.textile.liquid + - api/schema/PipelineInstance.html.textile.liquid + - api/schema/PipelineTemplate.html.textile.liquid + - api/schema/Repository.html.textile.liquid + - api/schema/Specimen.html.textile.liquid + - api/schema/Trait.html.textile.liquid + - api/schema/User.html.textile.liquid + - api/schema/VirtualMachine.html.textile.liquid + installguide: + - Overview: + - install/index.html.textile.liquid + - Docker-based installation: + - install/pre-built-docker.html.textile.liquid + - install/install-docker.html.textile.liquid + - Manual installation: + - install/install-manual-prerequisites.html.textile.liquid + - install/install-sso.html.textile.liquid + - install/install-api-server.html.textile.liquid + - install/install-arv-git-httpd.html.textile.liquid + - install/install-keepstore.html.textile.liquid + - install/install-keepproxy.html.textile.liquid + - install/install-crunch-dispatch.html.textile.liquid + - install/install-compute-node.html.textile.liquid + - install/install-shell-server.html.textile.liquid + - install/create-standard-objects.html.textile.liquid + - install/install-workbench-app.html.textile.liquid + - install/cheat_sheet.html.textile.liquid