github.com/guilhermebr/docker@v1.4.2-0.20150428121140-67da055cebca/docs/mkdocs.yml (about)

     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  
     7  dev_addr: '0.0.0.0:8000'
     8  
     9  repo_url: https://github.com/docker/docker/
    10  
    11  docs_dir: sources
    12  
    13  include_search: true
    14  
    15  use_absolute_urls: true
    16  
    17  # theme: docker
    18  theme_dir: ./theme/mkdocs/
    19  theme_center_lead: false
    20  
    21  copyright: Copyright © 2014-2015, Docker, Inc.
    22  google_analytics: ['UA-6096819-11', 'docker.io']
    23  
    24  pages:
    25  
    26  # Introduction:
    27  - ['index.md', 'About', 'Docker']
    28  - ['release-notes.md', 'About', 'Release notes']
    29  - ['introduction/index.md', '**HIDDEN**']
    30  - ['introduction/understanding-docker.md', 'About', 'Understanding Docker']
    31  
    32  # Installation:
    33  - ['installation/index.md', '**HIDDEN**']
    34  - ['installation/ubuntulinux.md', 'Installation', 'Ubuntu']
    35  - ['installation/mac.md', 'Installation', 'Mac OS X']
    36  - ['installation/windows.md', 'Installation', 'Microsoft Windows']
    37  - ['installation/testing-windows-docker-client.md', 'Installation', 'Building and testing the Windows Docker client']
    38  - ['installation/amazon.md', 'Installation', 'Amazon EC2']
    39  - ['installation/archlinux.md', 'Installation', 'Arch Linux']
    40  - ['installation/binaries.md', 'Installation', 'Binaries']
    41  - ['installation/centos.md', 'Installation', 'CentOS']
    42  - ['installation/cruxlinux.md', 'Installation', 'CRUX Linux']
    43  - ['installation/debian.md', 'Installation', 'Debian']
    44  - ['installation/fedora.md', 'Installation', 'Fedora']
    45  - ['installation/frugalware.md', 'Installation', 'FrugalWare']
    46  - ['installation/google.md', 'Installation', 'Google Cloud Platform']
    47  - ['installation/gentoolinux.md', 'Installation', 'Gentoo']
    48  - ['installation/softlayer.md', 'Installation', 'IBM Softlayer']
    49  - ['installation/joyent.md', 'Installation', 'Joyent Compute Service']
    50  - ['installation/azure.md', 'Installation', 'Microsoft Azure']
    51  - ['installation/rackspace.md', 'Installation', 'Rackspace Cloud']
    52  - ['installation/rhel.md', 'Installation', 'Red Hat Enterprise Linux']
    53  - ['installation/oracle.md', 'Installation', 'Oracle Linux']
    54  - ['installation/SUSE.md', 'Installation', 'SUSE']
    55  - ['compose/install.md', 'Installation', 'Docker Compose']
    56  
    57  # User Guide:
    58  - ['userguide/index.md', 'User Guide', 'The Docker user guide' ]
    59  - ['userguide/dockerhub.md', 'User Guide', 'Getting started with Docker Hub' ]
    60  - ['userguide/dockerizing.md', 'User Guide', 'Dockerizing applications' ]
    61  - ['userguide/usingdocker.md', 'User Guide', 'Working with containers' ]
    62  - ['userguide/dockerimages.md', 'User Guide', 'Working with Docker images' ]
    63  - ['userguide/dockerlinks.md', 'User Guide', 'Linking containers together' ]
    64  - ['userguide/dockervolumes.md', 'User Guide', 'Managing data in containers' ]
    65  - ['userguide/labels-custom-metadata.md', 'User Guide', 'Apply custom metadata' ]
    66  - ['userguide/dockerrepos.md', 'User Guide', 'Working with Docker Hub' ]
    67  - ['userguide/level1.md', '**HIDDEN**' ]
    68  - ['userguide/level2.md', '**HIDDEN**' ]
    69  - ['compose/index.md', 'User Guide', 'Docker Compose' ]
    70  - ['compose/production.md', 'User Guide', '    ▪  Use Compose in production' ]
    71  - ['compose/extends.md', 'User Guide', '    ▪  Extend Compose services' ]
    72  - ['machine/index.md', 'User Guide', 'Docker Machine' ]
    73  - ['swarm/index.md', 'User Guide', 'Docker Swarm' ]
    74  
    75  # Docker Hub docs:
    76  - ['docker-hub/index.md', 'Docker Hub', 'Docker Hub' ]
    77  - ['docker-hub/accounts.md', 'Docker Hub', 'Accounts']
    78  - ['docker-hub/repos.md', 'Docker Hub', 'Repositories']
    79  - ['docker-hub/builds.md', 'Docker Hub', 'Automated Builds']
    80  - ['docker-hub/official_repos.md', 'Docker Hub', 'Official repo guidelines']
    81  
    82  # Docker Hub Enterprise:
    83  - ['docker-hub-enterprise/index.md', 'Docker Hub Enterprise', 'Overview' ]
    84  - ['docker-hub-enterprise/quick-start.md', 'Docker Hub Enterprise', 'Quick Start: Basic Workflow' ]
    85  - ['docker-hub-enterprise/userguide.md', 'Docker Hub Enterprise', 'User Guide' ]
    86  - ['docker-hub-enterprise/adminguide.md', 'Docker Hub Enterprise', 'Admin Guide' ]
    87  - ['docker-hub-enterprise/install.md', 'Docker Hub Enterprise', '  Installation' ]
    88  - ['docker-hub-enterprise/configuration.md', 'Docker Hub Enterprise', '  Configuration options' ]
    89  - ['docker-hub-enterprise/support.md', 'Docker Hub Enterprise', 'Support' ]
    90  
    91  # Examples:
    92  - ['examples/index.md', '**HIDDEN**']
    93  - ['examples/nodejs_web_app.md', 'Examples', 'Dockerizing a Node.js web application']
    94  - ['examples/mongodb.md', 'Examples', 'Dockerizing MongoDB']
    95  - ['examples/running_redis_service.md', 'Examples', 'Dockerizing a Redis service']
    96  - ['examples/postgresql_service.md', 'Examples', 'Dockerizing a PostgreSQL service']
    97  - ['examples/running_riak_service.md', 'Examples', 'Dockerizing a Riak service']
    98  - ['examples/running_ssh_service.md', 'Examples', 'Dockerizing an SSH service']
    99  - ['examples/couchdb_data_volumes.md', 'Examples', 'Dockerizing a CouchDB service']
   100  - ['examples/apt-cacher-ng.md', 'Examples', 'Dockerizing an Apt-Cacher-ng service']
   101  - ['compose/django.md', 'Examples', 'Getting started with Compose and Django']
   102  - ['compose/rails.md', 'Examples', 'Getting started with Compose and Rails']
   103  - ['compose/wordpress.md', 'Examples', 'Getting started with Compose and Wordpress']
   104  
   105  # Articles
   106  - ['articles/index.md', '**HIDDEN**']
   107  - ['articles/basics.md', 'Articles', 'Docker basics']
   108  - ['articles/networking.md', 'Articles', 'Advanced networking']
   109  - ['articles/security.md', 'Articles', 'Security']
   110  - ['articles/https.md', 'Articles', 'Running Docker with HTTPS']
   111  - ['articles/registry_mirror.md', 'Articles', 'Run a local registry mirror']
   112  - ['articles/host_integration.md', 'Articles', 'Automatically starting containers']
   113  - ['articles/baseimages.md', 'Articles', 'Creating a base image']
   114  - ['articles/dockerfile_best-practices.md', 'Articles', 'Best practices for writing Dockerfiles']
   115  - ['articles/certificates.md', 'Articles', 'Using certificates for repository client verification']
   116  - ['articles/using_supervisord.md', 'Articles', 'Using Supervisor']
   117  - ['articles/configuring.md', 'Articles', 'Configuring Docker']
   118  - ['articles/cfengine_process_management.md', 'Articles', 'Process management with CFEngine']
   119  - ['articles/puppet.md', 'Articles', 'Using Puppet']
   120  - ['articles/chef.md', 'Articles', 'Using Chef']
   121  - ['articles/dsc.md', 'Articles', 'Using PowerShell DSC']
   122  - ['articles/ambassador_pattern_linking.md', 'Articles', 'Cross-Host linking using ambassador containers']
   123  - ['articles/runmetrics.md', 'Articles', 'Runtime metrics']
   124  - ['articles/b2d_volume_resize.md', 'Articles', 'Increasing a Boot2Docker volume']
   125  - ['articles/systemd.md', 'Articles', 'Controlling and configuring Docker using Systemd']
   126  
   127  # Reference
   128  - ['reference/index.md', '**HIDDEN**']
   129  - ['reference/commandline/index.md', '**HIDDEN**']
   130  - ['reference/commandline/cli.md', 'Reference', 'Docker command line']
   131  - ['reference/builder.md', 'Reference', 'Dockerfile']
   132  - ['faq.md', 'Reference', 'FAQ']
   133  - ['reference/run.md', 'Reference', 'Run reference']
   134  - ['compose/cli.md', 'Reference', 'Compose command line']
   135  - ['compose/yml.md', 'Reference', 'Compose yml']
   136  - ['compose/env.md', 'Reference', 'Compose ENV variables']
   137  - ['compose/completion.md', 'Reference', 'Compose commandline completion']
   138  - ['swarm/discovery.md', 'Reference', 'Swarm discovery']
   139  - ['swarm/scheduler/strategy.md', 'Reference', 'Swarm strategies']
   140  - ['swarm/scheduler/filter.md', 'Reference', 'Swarm filters']
   141  - ['swarm/API.md', 'Reference', 'Swarm API']
   142  - ['reference/api/index.md', '**HIDDEN**']
   143  - ['registry/index.md', 'Reference', 'Docker Registry 2.0']
   144  - ['registry/deploying.md', 'Reference', '    ▪  Deploy a registry' ]
   145  - ['registry/configuration.md', 'Reference', '    ▪  Configure a registry' ]
   146  - ['registry/storagedrivers.md', 'Reference', '    ▪  Storage driver model' ]
   147  - ['registry/notifications.md', 'Reference', '    ▪  Work with notifications' ]
   148  - ['registry/spec/api.md', 'Reference', '    ▪  Registry Service API v2' ]
   149  - ['registry/spec/json.md', 'Reference', '    ▪  JSON format' ]
   150  - ['registry/spec/auth/token.md', 'Reference', '    ▪  Authenticate via central service' ]
   151  - ['reference/api/hub_registry_spec.md', 'Reference', 'Docker Hub and Registry 1.0']
   152  - ['reference/api/registry_api.md', 'Reference', '    ▪ Docker Registry API v1']
   153  - ['reference/api/registry_api_client_libraries.md', 'Reference', '    ▪ Docker Registry 1.0 API client libraries']
   154  #- ['reference/image-spec-v1.md', 'Reference', 'Docker Image Specification v1.0.0']
   155  - ['reference/api/docker-io_api.md', 'Reference', 'Docker Hub API']
   156  #- ['reference/image-spec-v1.md', 'Reference', 'Docker Image Specification v1.0.0']
   157  - ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API']
   158  - ['reference/api/docker_remote_api_v1.18.md', 'Reference', 'Docker Remote API v1.18']
   159  - ['reference/api/docker_remote_api_v1.17.md', 'Reference', 'Docker Remote API v1.17']
   160  - ['reference/api/docker_remote_api_v1.16.md', 'Reference', 'Docker Remote API v1.16']
   161  - ['reference/api/docker_remote_api_v1.15.md', '**HIDDEN**']
   162  - ['reference/api/docker_remote_api_v1.14.md', '**HIDDEN**']
   163  - ['reference/api/docker_remote_api_v1.13.md', '**HIDDEN**']
   164  - ['reference/api/docker_remote_api_v1.12.md', '**HIDDEN**']
   165  - ['reference/api/docker_remote_api_v1.11.md', '**HIDDEN**']
   166  - ['reference/api/docker_remote_api_v1.10.md', '**HIDDEN**']
   167  - ['reference/api/docker_remote_api_v1.9.md', '**HIDDEN**']
   168  - ['reference/api/docker_remote_api_v1.8.md', '**HIDDEN**']
   169  - ['reference/api/docker_remote_api_v1.7.md', '**HIDDEN**']
   170  - ['reference/api/docker_remote_api_v1.6.md', '**HIDDEN**']
   171  - ['reference/api/docker_remote_api_v1.5.md', '**HIDDEN**']
   172  - ['reference/api/docker_remote_api_v1.4.md', '**HIDDEN**']
   173  - ['reference/api/docker_remote_api_v1.3.md', '**HIDDEN**']
   174  - ['reference/api/docker_remote_api_v1.2.md', '**HIDDEN**']
   175  - ['reference/api/docker_remote_api_v1.1.md', '**HIDDEN**']
   176  - ['reference/api/docker_remote_api_v1.0.md', '**HIDDEN**']
   177  - ['reference/api/remote_api_client_libraries.md', 'Reference', 'Docker Remote API client libraries']
   178  - ['reference/api/docker_io_accounts_api.md', 'Reference', 'Docker Hub accounts API']
   179  
   180  # Hidden registry files
   181  - ['registry/storage-drivers/azure.md', '**HIDDEN**' ]
   182  - ['registry/storage-drivers/filesystem.md', '**HIDDEN**' ]
   183  - ['registry/storage-drivers/inmemory.md', '**HIDDEN**' ]
   184  - ['registry/storage-drivers/s3.md', '**HIDDEN**' ]
   185  
   186  - ['jsearch.md', '**HIDDEN**']
   187  
   188  # - ['static_files/README.md', 'static_files', 'README']
   189  - ['terms/index.md', '**HIDDEN**']
   190  - ['terms/layer.md', '**HIDDEN**']
   191  - ['terms/index.md', '**HIDDEN**']
   192  - ['terms/registry.md', '**HIDDEN**']
   193  - ['terms/container.md', '**HIDDEN**']
   194  - ['terms/repository.md', '**HIDDEN**']
   195  - ['terms/filesystem.md', '**HIDDEN**']
   196  - ['terms/image.md', '**HIDDEN**']
   197  
   198  
   199  # Project:
   200  - ['project/index.md', '**HIDDEN**']
   201  - ['project/who-written-for.md', 'Contributor', 'README first']
   202  - ['project/software-required.md', 'Contributor', 'Get required software for Linux or OS X'] 
   203  - ['project/software-req-win.md', 'Contributor', 'Get required software for Windows']
   204  - ['project/set-up-git.md', 'Contributor', 'Configure Git for contributing'] 
   205  - ['project/set-up-dev-env.md', 'Contributor', 'Work with a development container'] 
   206  - ['project/test-and-docs.md', 'Contributor', 'Run tests and test documentation']
   207  - ['project/make-a-contribution.md', 'Contributor', 'Understand contribution workflow']
   208  - ['project/find-an-issue.md', 'Contributor', 'Find an issue'] 
   209  - ['project/work-issue.md', 'Contributor', 'Work on an issue'] 
   210  - ['project/create-pr.md', 'Contributor', 'Create a pull request'] 
   211  - ['project/review-pr.md', 'Contributor', 'Participate in the PR review'] 
   212  - ['project/advanced-contributing.md', 'Contributor', 'Advanced contributing']
   213  - ['project/get-help.md', 'Contributor', 'Where to get help']
   214  - ['project/coding-style.md', 'Contributor', 'Coding style guide']
   215  - ['project/doc-style.md', 'Contributor', 'Documentation style guide']
   216