mkdocs.yml 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. site_name: Docker Documentation
  2. #site_url: http://docs.docker.com/
  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/docker/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. copyright: Copyright © 2014-2015, Docker, Inc.
  15. google_analytics: ['UA-6096819-11', 'docker.io']
  16. pages:
  17. # Introduction:
  18. - ['index.md', 'About', 'Docker']
  19. - ['release-notes.md', 'About', 'Release Notes']
  20. - ['introduction/index.md', '**HIDDEN**']
  21. - ['introduction/understanding-docker.md', 'About', 'Understanding Docker']
  22. # Installation:
  23. - ['installation/index.md', '**HIDDEN**']
  24. - ['installation/ubuntulinux.md', 'Installation', 'Ubuntu']
  25. - ['installation/mac.md', 'Installation', 'Mac OS X']
  26. - ['installation/windows.md', 'Installation', 'Microsoft Windows']
  27. - ['installation/amazon.md', 'Installation', 'Amazon EC2']
  28. - ['installation/archlinux.md', 'Installation', 'Arch Linux']
  29. - ['installation/binaries.md', 'Installation', 'Binaries']
  30. - ['installation/centos.md', 'Installation', 'CentOS']
  31. - ['installation/cruxlinux.md', 'Installation', 'CRUX Linux']
  32. - ['installation/debian.md', 'Installation', 'Debian']
  33. - ['installation/fedora.md', 'Installation', 'Fedora']
  34. - ['installation/frugalware.md', 'Installation', 'FrugalWare']
  35. - ['installation/google.md', 'Installation', 'Google Cloud Platform']
  36. - ['installation/gentoolinux.md', 'Installation', 'Gentoo']
  37. - ['installation/softlayer.md', 'Installation', 'IBM Softlayer']
  38. - ['installation/rackspace.md', 'Installation', 'Rackspace Cloud']
  39. - ['installation/rhel.md', 'Installation', 'Red Hat Enterprise Linux']
  40. - ['installation/oracle.md', 'Installation', 'Oracle Linux']
  41. - ['installation/SUSE.md', 'Installation', 'SUSE']
  42. - ['compose/install.md', 'Installation', 'Docker Compose']
  43. # User Guide:
  44. - ['userguide/index.md', 'User Guide', 'The Docker User Guide' ]
  45. - ['userguide/dockerhub.md', 'User Guide', 'Getting Started with Docker Hub' ]
  46. - ['userguide/dockerizing.md', 'User Guide', 'Dockerizing Applications' ]
  47. - ['userguide/usingdocker.md', 'User Guide', 'Working with Containers' ]
  48. - ['userguide/dockerimages.md', 'User Guide', 'Working with Docker Images' ]
  49. - ['userguide/dockerlinks.md', 'User Guide', 'Linking containers together' ]
  50. - ['userguide/dockervolumes.md', 'User Guide', 'Managing data in containers' ]
  51. - ['userguide/labels-custom-metadata.md', 'User Guide', 'Apply custom metadata' ]
  52. - ['userguide/dockerrepos.md', 'User Guide', 'Working with Docker Hub' ]
  53. - ['userguide/level1.md', '**HIDDEN**' ]
  54. - ['userguide/level2.md', '**HIDDEN**' ]
  55. - ['compose/index.md', 'User Guide', 'Docker Compose' ]
  56. - ['machine/index.md', 'User Guide', 'Docker Machine' ]
  57. - ['swarm/index.md', 'User Guide', 'Docker Swarm' ]
  58. # Docker Hub docs:
  59. - ['docker-hub/index.md', 'Docker Hub', 'Docker Hub' ]
  60. - ['docker-hub/accounts.md', 'Docker Hub', 'Accounts']
  61. - ['docker-hub/repos.md', 'Docker Hub', 'Repositories']
  62. - ['docker-hub/builds.md', 'Docker Hub', 'Automated Builds']
  63. - ['docker-hub/official_repos.md', 'Docker Hub', 'Official Repo Guidelines']
  64. # Docker Hub Enterprise
  65. #- ['docker-hub-enterprise/index.md', '**HIDDEN**' ]
  66. #- ['docker-hub-enterprise/install-config.md', 'Docker Hub Enterprise', 'Installation and Configuration' ]
  67. #- ['docker-hub-enterprise/usage.md', 'Docker Hub Enterprise', 'User Guide' ]
  68. # Examples:
  69. - ['examples/index.md', '**HIDDEN**']
  70. - ['examples/nodejs_web_app.md', 'Examples', 'Dockerizing a Node.js web application']
  71. - ['examples/mongodb.md', 'Examples', 'Dockerizing MongoDB']
  72. - ['examples/running_redis_service.md', 'Examples', 'Dockerizing a Redis service']
  73. - ['examples/postgresql_service.md', 'Examples', 'Dockerizing a PostgreSQL service']
  74. - ['examples/running_riak_service.md', 'Examples', 'Dockerizing a Riak service']
  75. - ['examples/running_ssh_service.md', 'Examples', 'Dockerizing an SSH service']
  76. - ['examples/couchdb_data_volumes.md', 'Examples', 'Dockerizing a CouchDB service']
  77. - ['examples/apt-cacher-ng.md', 'Examples', 'Dockerizing an Apt-Cacher-ng service']
  78. - ['compose/django.md', 'Examples', 'Getting started with Compose and Django']
  79. - ['compose/rails.md', 'Examples', 'Getting started with Compose and Rails']
  80. - ['compose/wordpress.md', 'Examples', 'Getting started with Compose and Wordpress']
  81. # Articles
  82. - ['articles/index.md', '**HIDDEN**']
  83. - ['articles/basics.md', 'Articles', 'Docker basics']
  84. - ['articles/networking.md', 'Articles', 'Advanced networking']
  85. - ['articles/security.md', 'Articles', 'Security']
  86. - ['articles/https.md', 'Articles', 'Running Docker with HTTPS']
  87. - ['articles/registry_mirror.md', 'Articles', 'Run a local registry mirror']
  88. - ['articles/host_integration.md', 'Articles', 'Automatically starting containers']
  89. - ['articles/baseimages.md', 'Articles', 'Creating a base image']
  90. - ['articles/dockerfile_best-practices.md', 'Articles', 'Best practices for writing Dockerfiles']
  91. - ['articles/certificates.md', 'Articles', 'Using certificates for repository client verification']
  92. - ['articles/using_supervisord.md', 'Articles', 'Using Supervisor']
  93. - ['articles/cfengine_process_management.md', 'Articles', 'Process management with CFEngine']
  94. - ['articles/puppet.md', 'Articles', 'Using Puppet']
  95. - ['articles/chef.md', 'Articles', 'Using Chef']
  96. - ['articles/dsc.md', 'Articles', 'Using PowerShell DSC']
  97. - ['articles/ambassador_pattern_linking.md', 'Articles', 'Cross-Host linking using ambassador containers']
  98. - ['articles/runmetrics.md', 'Articles', 'Runtime metrics']
  99. - ['articles/b2d_volume_resize.md', 'Articles', 'Increasing a Boot2Docker volume']
  100. - ['articles/systemd.md', 'Articles', 'Controlling and configuring Docker using Systemd']
  101. # Reference
  102. - ['reference/index.md', '**HIDDEN**']
  103. - ['reference/commandline/index.md', '**HIDDEN**']
  104. - ['reference/commandline/cli.md', 'Reference', 'Docker command line']
  105. - ['reference/builder.md', 'Reference', 'Dockerfile']
  106. - ['faq.md', 'Reference', 'FAQ']
  107. - ['reference/run.md', 'Reference', 'Run Reference']
  108. - ['compose/cli.md', 'Reference', 'Compose command line']
  109. - ['compose/yml.md', 'Reference', 'Compose yml']
  110. - ['compose/env.md', 'Reference', 'Compose ENV variables']
  111. - ['compose/completion.md', 'Reference', 'Compose commandline completion']
  112. - ['swarm/discovery.md', 'Reference', 'Swarm discovery']
  113. - ['swarm/scheduler/strategy.md', 'Reference', 'Swarm strategies']
  114. - ['swarm/scheduler/filter.md', 'Reference', 'Swarm filters']
  115. - ['swarm/API.md', 'Reference', 'Swarm API']
  116. - ['reference/api/index.md', '**HIDDEN**']
  117. - ['reference/api/docker-io_api.md', 'Reference', 'Docker Hub API']
  118. - ['reference/api/registry_api.md', 'Reference', 'Docker Registry API']
  119. - ['reference/api/registry_api_client_libraries.md', 'Reference', 'Docker Registry API Client Libraries']
  120. - ['reference/api/hub_registry_spec.md', 'Reference', 'Docker Hub and Registry Spec']
  121. #- ['reference/image-spec-v1.md', 'Reference', 'Docker Image Specification v1.0.0']
  122. - ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API']
  123. - ['reference/api/docker_remote_api_v1.18.md', 'Reference', 'Docker Remote API v1.18']
  124. - ['reference/api/docker_remote_api_v1.17.md', 'Reference', 'Docker Remote API v1.17']
  125. - ['reference/api/docker_remote_api_v1.16.md', 'Reference', 'Docker Remote API v1.16']
  126. - ['reference/api/docker_remote_api_v1.15.md', '**HIDDEN**']
  127. - ['reference/api/docker_remote_api_v1.14.md', '**HIDDEN**']
  128. - ['reference/api/docker_remote_api_v1.13.md', '**HIDDEN**']
  129. - ['reference/api/docker_remote_api_v1.12.md', '**HIDDEN**']
  130. - ['reference/api/docker_remote_api_v1.11.md', '**HIDDEN**']
  131. - ['reference/api/docker_remote_api_v1.10.md', '**HIDDEN**']
  132. - ['reference/api/docker_remote_api_v1.9.md', '**HIDDEN**']
  133. - ['reference/api/docker_remote_api_v1.8.md', '**HIDDEN**']
  134. - ['reference/api/docker_remote_api_v1.7.md', '**HIDDEN**']
  135. - ['reference/api/docker_remote_api_v1.6.md', '**HIDDEN**']
  136. - ['reference/api/docker_remote_api_v1.5.md', '**HIDDEN**']
  137. - ['reference/api/docker_remote_api_v1.4.md', '**HIDDEN**']
  138. - ['reference/api/docker_remote_api_v1.3.md', '**HIDDEN**']
  139. - ['reference/api/docker_remote_api_v1.2.md', '**HIDDEN**']
  140. - ['reference/api/docker_remote_api_v1.1.md', '**HIDDEN**']
  141. - ['reference/api/docker_remote_api_v1.0.md', '**HIDDEN**']
  142. - ['reference/api/remote_api_client_libraries.md', 'Reference', 'Docker Remote API Client Libraries']
  143. - ['reference/api/docker_io_accounts_api.md', 'Reference', 'Docker Hub Accounts API']
  144. - ['jsearch.md', '**HIDDEN**']
  145. # - ['static_files/README.md', 'static_files', 'README']
  146. - ['terms/index.md', '**HIDDEN**']
  147. - ['terms/layer.md', '**HIDDEN**']
  148. - ['terms/index.md', '**HIDDEN**']
  149. - ['terms/registry.md', '**HIDDEN**']
  150. - ['terms/container.md', '**HIDDEN**']
  151. - ['terms/repository.md', '**HIDDEN**']
  152. - ['terms/filesystem.md', '**HIDDEN**']
  153. - ['terms/image.md', '**HIDDEN**']
  154. # Project:
  155. - ['project/index.md', '**HIDDEN**']
  156. - ['project/who-written-for.md', 'Contributor Guide', 'README first']
  157. - ['project/software-required.md', 'Contributor Guide', 'Get required software']
  158. - ['project/set-up-git.md', 'Contributor Guide', 'Configure Git for contributing']
  159. - ['project/set-up-dev-env.md', 'Contributor Guide', 'Work with a development container']
  160. - ['project/test-and-docs.md', 'Contributor Guide', 'Run tests and test documentation']
  161. - ['project/make-a-contribution.md', 'Contributor Guide', 'Understand contribution workflow']
  162. - ['project/find-an-issue.md', 'Contributor Guide', 'Find an issue']
  163. - ['project/work-issue.md', 'Contributor Guide', 'Work on an issue']
  164. - ['project/create-pr.md', 'Contributor Guide', 'Create a pull request']
  165. - ['project/review-pr.md', 'Contributor Guide', 'Participate in the PR review']
  166. - ['project/advanced-contributing.md', 'Contributor Guide', 'Advanced contributing']
  167. - ['project/get-help.md', 'Contributor Guide', 'Where to get help']
  168. - ['project/coding-style.md', 'Contributor Guide', 'Coding style guide']
  169. - ['project/doc-style.md', 'Contributor Guide', 'Documentation style guide']