mkdocs.yml 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. site_name: Docker Documentation
  2. #site_url: http://docs.docker.io/
  3. site_url: /
  4. site_description: Documentation for fast and lightweight Docker container based virtualization framework.
  5. site_favicon: img/favicon.png
  6. dev_addr: '0.0.0.0:8000'
  7. repo_url: https://github.com/dotcloud/docker/
  8. docs_dir: sources
  9. include_search: true
  10. use_absolute_urls: true
  11. # theme: docker
  12. theme_dir: ./theme/mkdocs/
  13. theme_center_lead: false
  14. include_search: true
  15. copyright: Copyright © 2014, Docker, Inc.
  16. google_analytics: ['UA-6096819-11', 'docker.io']
  17. pages:
  18. # Introduction:
  19. - ['index.md', 'About', 'Docker']
  20. - ['introduction/index.md', '**HIDDEN**']
  21. - ['introduction/understanding-docker.md', 'About', 'Understanding Docker']
  22. - ['introduction/technology.md', 'About', 'The Technology']
  23. - ['introduction/working-with-docker.md', 'About', 'Working with Docker']
  24. - ['introduction/get-docker.md', 'About', 'Get Docker']
  25. # Installation:
  26. - ['installation/index.md', '**HIDDEN**']
  27. - ['installation/mac.md', 'Installation', 'Mac OS X']
  28. - ['installation/ubuntulinux.md', 'Installation', 'Ubuntu']
  29. - ['installation/rhel.md', 'Installation', 'Red Hat Enterprise Linux']
  30. - ['installation/debian.md', 'Installation', 'Debian']
  31. - ['installation/gentoolinux.md', 'Installation', 'Gentoo']
  32. - ['installation/google.md', 'Installation', 'Google Cloud Platform']
  33. - ['installation/rackspace.md', 'Installation', 'Rackspace Cloud']
  34. - ['installation/amazon.md', 'Installation', 'Amazon EC2']
  35. - ['installation/softlayer.md', 'Installation', 'IBM Softlayer']
  36. - ['installation/archlinux.md', 'Installation', 'Arch Linux']
  37. - ['installation/frugalware.md', 'Installation', 'FrugalWare']
  38. - ['installation/fedora.md', 'Installation', 'Fedora']
  39. - ['installation/openSUSE.md', 'Installation', 'openSUSE']
  40. - ['installation/cruxlinux.md', 'Installation', 'CRUX Linux']
  41. - ['installation/windows.md', 'Installation', 'Microsoft Windows']
  42. - ['installation/binaries.md', 'Installation', 'Binaries']
  43. # Examples:
  44. - ['use/index.md', '**HIDDEN**']
  45. - ['use/basics.md', 'Examples', 'First steps with Docker']
  46. - ['examples/index.md', '**HIDDEN**']
  47. - ['examples/hello_world.md', 'Examples', 'Hello World']
  48. - ['examples/nodejs_web_app.md', 'Examples', 'Node.js web application']
  49. - ['examples/python_web_app.md', 'Examples', 'Python web application']
  50. - ['examples/mongodb.md', 'Examples', 'Dockerizing MongoDB']
  51. - ['examples/running_redis_service.md', 'Examples', 'Redis service']
  52. - ['examples/postgresql_service.md', 'Examples', 'PostgreSQL service']
  53. - ['examples/running_riak_service.md', 'Examples', 'Running a Riak service']
  54. - ['examples/running_ssh_service.md', 'Examples', 'Running an SSH service']
  55. - ['examples/couchdb_data_volumes.md', 'Examples', 'CouchDB service']
  56. - ['examples/apt-cacher-ng.md', 'Examples', 'Apt-Cacher-ng service']
  57. - ['examples/https.md', 'Examples', 'Running Docker with HTTPS']
  58. - ['examples/using_supervisord.md', 'Examples', 'Using Supervisor']
  59. - ['examples/cfengine_process_management.md', 'Examples', 'Process management with CFEngine']
  60. - ['use/working_with_links_names.md', 'Examples', 'Linking containers together']
  61. - ['use/working_with_volumes.md', 'Examples', 'Sharing Directories using volumes']
  62. - ['use/puppet.md', 'Examples', 'Using Puppet']
  63. - ['use/chef.md', 'Examples', 'Using Chef']
  64. - ['use/workingwithrepository.md', 'Examples', 'Working with a Docker Repository']
  65. - ['use/port_redirection.md', 'Examples', 'Redirect ports']
  66. - ['use/ambassador_pattern_linking.md', 'Examples', 'Cross-Host linking using Ambassador Containers']
  67. - ['use/host_integration.md', 'Examples', 'Automatically starting Containers']
  68. #- ['user-guide/index.md', '**HIDDEN**']
  69. # - ['user-guide/writing-your-docs.md', 'User Guide', 'Writing your docs']
  70. # - ['user-guide/styling-your-docs.md', 'User Guide', 'Styling your docs']
  71. # - ['user-guide/configuration.md', 'User Guide', 'Configuration']
  72. # ./faq.md
  73. # Docker.io docs:
  74. - ['docker-io/index.md', '**HIDDEN**']
  75. # - ['index/home.md', 'Docker Index', 'Help']
  76. - ['docker-io/accounts.md', 'Docker.io', 'Accounts']
  77. - ['docker-io/repos.md', 'Docker.io', 'Repositories']
  78. - ['docker-io/builds.md', 'Docker.io', 'Trusted Builds']
  79. # Reference
  80. - ['reference/index.md', '**HIDDEN**']
  81. - ['reference/commandline/index.md', '**HIDDEN**']
  82. - ['reference/commandline/cli.md', 'Reference', 'Command line']
  83. - ['reference/builder.md', 'Reference', 'Dockerfile']
  84. - ['reference/run.md', 'Reference', 'Run Reference']
  85. - ['articles/index.md', '**HIDDEN**']
  86. - ['articles/runmetrics.md', 'Reference', 'Runtime metrics']
  87. - ['articles/security.md', 'Reference', 'Security']
  88. - ['articles/baseimages.md', 'Reference', 'Creating a Base Image']
  89. - ['use/networking.md', 'Reference', 'Advanced networking']
  90. - ['reference/api/index.md', '**HIDDEN**']
  91. - ['reference/api/docker-io_api.md', 'Reference', 'Docker.io API']
  92. - ['reference/api/registry_api.md', 'Reference', 'Docker Registry API']
  93. - ['reference/api/registry_index_spec.md', 'Reference', 'Registry & Index Spec']
  94. - ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API']
  95. - ['reference/api/docker_remote_api_v1.11.md', 'Reference', 'Docker Remote API v1.11']
  96. - ['reference/api/docker_remote_api_v1.10.md', 'Reference', 'Docker Remote API v1.10']
  97. - ['reference/api/docker_remote_api_v1.9.md', '**HIDDEN**']
  98. - ['reference/api/docker_remote_api_v1.8.md', '**HIDDEN**']
  99. - ['reference/api/docker_remote_api_v1.7.md', '**HIDDEN**']
  100. - ['reference/api/docker_remote_api_v1.6.md', '**HIDDEN**']
  101. - ['reference/api/docker_remote_api_v1.5.md', '**HIDDEN**']
  102. - ['reference/api/docker_remote_api_v1.4.md', '**HIDDEN**']
  103. - ['reference/api/docker_remote_api_v1.3.md', '**HIDDEN**']
  104. - ['reference/api/docker_remote_api_v1.2.md', '**HIDDEN**']
  105. - ['reference/api/docker_remote_api_v1.1.md', '**HIDDEN**']
  106. - ['reference/api/docker_remote_api_v1.0.md', '**HIDDEN**']
  107. - ['reference/api/remote_api_client_libraries.md', 'Reference', 'Docker Remote API Client Libraries']
  108. - ['reference/api/docker_io_oauth_api.md', 'Reference', 'Docker IO OAuth API']
  109. - ['reference/api/docker_io_accounts_api.md', 'Reference', 'Docker IO Accounts API']
  110. - ['jsearch.md', '**HIDDEN**']
  111. # - ['static_files/README.md', 'static_files', 'README']
  112. - ['terms/index.md', '**HIDDEN**']
  113. - ['terms/layer.md', '**HIDDEN**']
  114. - ['terms/index.md', '**HIDDEN**']
  115. - ['terms/registry.md', '**HIDDEN**']
  116. - ['terms/container.md', '**HIDDEN**']
  117. - ['terms/repository.md', '**HIDDEN**']
  118. - ['terms/filesystem.md', '**HIDDEN**']
  119. - ['terms/image.md', '**HIDDEN**']
  120. # TODO: our theme adds a dropdown even for sections that have no subsections.
  121. #- ['faq.md', 'FAQ']
  122. # Contribute:
  123. - ['contributing/index.md', '**HIDDEN**']
  124. - ['contributing/contributing.md', 'Contribute', 'Contributing']
  125. - ['contributing/devenvironment.md', 'Contribute', 'Development environment']