mirror of https://github.com/docker/docs.git
1969 lines
74 KiB
HTML
1969 lines
74 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Contribute code overview </title>
|
|
<link rel="shortcut icon" href="/images/favicon.png" type="image/x-icon">
|
|
<link rel="stylesheet" href="/dist/assets/css/bootstrap-custom.css" />
|
|
<link rel="stylesheet" href="/dist/assets/css/app.css" />
|
|
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/animate.css/3.2.6/animate.min.css">
|
|
<link rel="stylesheet" href="/css/custom.css">
|
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
|
|
<script href="/dist/assets/js/modernizr.js"></script>
|
|
</head>
|
|
<body>
|
|
<div class="off-canvas-wrap" data-offcanvas>
|
|
<div class="inner-wrap">
|
|
|
|
<a class="left-off-canvas-toggle" href="#" >
|
|
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="35px" height="35px" viewBox="0 0 35 35" enable-background="new 0 0 35 35" xml:space="preserve">
|
|
<path fill="#3597D4" d="M30.583,9.328c0,0.752-0.539,1.362-1.203,1.362H5.113c-0.664,0-1.203-0.61-1.203-1.362l0,0
|
|
c0-0.752,0.539-1.362,1.203-1.362H29.38C30.045,7.966,30.583,8.576,30.583,9.328L30.583,9.328z"/>
|
|
<path fill="#3597D4" d="M30.583,17.09c0,0.752-0.539,1.362-1.203,1.362H5.113c-0.664,0-1.203-0.61-1.203-1.362l0,0
|
|
c0-0.752,0.539-1.362,1.203-1.362H29.38C30.045,15.728,30.583,16.338,30.583,17.09L30.583,17.09z"/>
|
|
<path fill="#3597D4" d="M30.583,24.387c0,0.752-0.539,1.362-1.203,1.362H5.113c-0.664,0-1.203-0.61-1.203-1.362l0,0
|
|
c0-0.752,0.539-1.362,1.203-1.362H29.38C30.045,23.025,30.583,23.635,30.583,24.387L30.583,24.387z"/>
|
|
</svg>
|
|
</a>
|
|
<a class="button secondary small get-started-cta">Get Started</a>
|
|
<header class="main-header">
|
|
<div class="row">
|
|
<div class="large-3 columns">
|
|
<a href="/"><img class="logo" src="/dist/assets/images/logo.png"></a>
|
|
</div>
|
|
<div class="large-9 columns">
|
|
<ul class="nav-global">
|
|
<li><a href="https://www.docker.com/support">Support</a></li>
|
|
<li><a href="https://training.docker.com/">Training</a></li>
|
|
<li><a href="/">Docs</a></li>
|
|
<li><a href="http://blog.docker.com/">Blog</a></li>
|
|
<li><a href="https://hub.docker.com/account/signup/">Docker Hub</a></li>
|
|
<li><a class="button" href="/mac/started/">Get Started</a></li>
|
|
</ul>
|
|
<ul class="nav-main">
|
|
<li><a href="https://www.docker.com/products">Products</a>
|
|
<ul>
|
|
<li><a href="https://www.docker.com/pricing">Pricing</a></li>
|
|
<li><a href="https://www.docker.com/whatisdocker">What is Docker?</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://www.docker.com/customers">Customers</a></li>
|
|
<li><a href="https://www.docker.com/community">Community</a>
|
|
<ul>
|
|
<li><a href="https://www.docker.com/community/meetups">Meetups</a></li>
|
|
<li><a href="https://www.docker.com/community/events">Events</a></li>
|
|
<li><a href="https://forums.docker.com">Forums</a></li>
|
|
<li><a href="http://www.scoop.it/t/docker-by-docker">Community News</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://www.docker.com/partners">Partners</a>
|
|
<ul>
|
|
<li><a href="https://www.docker.com/partners/partner-programs">Partner Programs</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://www.docker.com/company">Company</a>
|
|
<ul>
|
|
<li><a href="https://www.docker.com/news-and-press">News & Press</a></li>
|
|
<li><a href="https://www.docker.com/work-docker">Work at Docker</a></li>
|
|
<li><a href="https://www.docker.com/company/management">Management</a></li>
|
|
<li><a href="https://www.docker.com/company/contact">Contact</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://www.docker.com/open-source">Open Source</a>
|
|
<ul>
|
|
<li><a href="https://www.docker.com/contribute">Contribute</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
|
|
|
|
<aside class="left-off-canvas-menu">
|
|
<ul class="off-canvas-list">
|
|
<li class="has-submenu"><a href="#">Products</a>
|
|
<ul class="left-submenu">
|
|
<li class="back"><a href="#">Back</a></li>
|
|
<li><a href="#">Pricing</a></li>
|
|
<li><a href="#">What Is Docker</a></li>
|
|
<li><a href="#">Products</a></li>
|
|
<li><a href="#">Docker Engine</a></li>
|
|
<li><a href="#">Docker Hub</a></li>
|
|
<li><a href="#">Docker Registry</a></li>
|
|
<li><a href="#">Docker Machine</a></li>
|
|
<li><a href="#">Docker Swarm</a></li>
|
|
<li><a href="#">Docker Compose</a></li>
|
|
<li><a href="#">Kitematic</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#">Customers</a></li>
|
|
<li class="has-submenu"><a href="#">Community</a>
|
|
<ul class="left-submenu">
|
|
<li class="back"><a href="#">Back</a></li>
|
|
<li><a href="#">Community</a></li>
|
|
<li><a href="#">Meetups</a></li>
|
|
<li><a href="https://www.docker.com/community/events">Events</a></li>
|
|
<li><a href="#">Forum</a></li>
|
|
<li><a href="#">Scoop.it</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="has-submenu"><a href="#">Partners</a>
|
|
<ul class="left-submenu">
|
|
<li class="back"><a href="#">Back</a></li>
|
|
<li><a href="#">Partners</a></li>
|
|
<li><a href="https://www.docker.com/partners/partner-programs">Partners Programs</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#">Company</a></li>
|
|
<li class="has-submenu"><a href="#">Open Source</a>
|
|
<ul class="left-submenu">
|
|
<li class="back"><a href="#">Back</a></li>
|
|
<li><a href="#">Open Source</a></li>
|
|
<li><a href="#">Contribute</a></li>
|
|
<li><a href="#">Governance</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="nav-global-off-canvas">
|
|
<li><a href="#">Support</a></li>
|
|
<li><a href="#">Training</a></li>
|
|
<li><a href="#">Docs</a></li>
|
|
<li><a href="#">Blog</a></li>
|
|
<li><a href="#">Sign in</a></li>
|
|
<li><a href="#">Sign up</a></li>
|
|
</ul>
|
|
</aside>
|
|
|
|
<a class="exit-off-canvas"></a>
|
|
<div id="docs" class="row">
|
|
<div class="large-3 columns">
|
|
<section id="multiple" data-accordion-group>
|
|
|
|
|
|
<section data-accordion>
|
|
|
|
<article data-accordion>
|
|
<button data-control> Install</button>
|
|
<div data-content>
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Docker Engine</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/docker/installation/mac/" class=""> Installation on Mac OS X</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/installation/windows/" class=""> Installation on Windows</a>
|
|
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Linux</button>
|
|
<div data-content>
|
|
|
|
<a data-link href="/docker/installation/archlinux/" class=""> Installation on Arch Linux</a>
|
|
|
|
<a data-link href="/docker/installation/cruxlinux/" class=""> Installation on CRUX Linux</a>
|
|
|
|
<a data-link href="/docker/installation/centos/" class=""> Installation on CentOS</a>
|
|
|
|
<a data-link href="/docker/installation/debian/" class=""> Installation on Debian</a>
|
|
|
|
<a data-link href="/docker/installation/fedora/" class=""> Installation on Fedora</a>
|
|
|
|
<a data-link href="/docker/installation/frugalware/" class=""> Installation on FrugalWare</a>
|
|
|
|
<a data-link href="/docker/installation/gentoolinux/" class=""> Installation on Gentoo</a>
|
|
|
|
<a data-link href="/docker/installation/oracle/" class=""> Installation on Oracle Linux</a>
|
|
|
|
<a data-link href="/docker/installation/rhel/" class=""> Installation on Red Hat Enterprise Linux</a>
|
|
|
|
<a data-link href="/docker/installation/ubuntulinux/" class=""> Installation on Ubuntu </a>
|
|
|
|
<a data-link href="/docker/installation/SUSE/" class=""> Installation on openSUSE and SUSE Linux Enterprise</a>
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Cloud</button>
|
|
<div data-content>
|
|
|
|
<a data-link href="/docker/installation/amazon/" class=""> Amazon EC2 Installation</a>
|
|
|
|
<a data-link href="/docker/installation/joyent/" class=""> Install on Joyent Public Cloud</a>
|
|
|
|
<a data-link href="/docker/installation/google/" class=""> Installation on Google Cloud Platform</a>
|
|
|
|
<a data-link href="/docker/installation/softlayer/" class=""> Installation on IBM SoftLayer </a>
|
|
|
|
<a data-link href="/docker/installation/azure/" class=""> Installation on Microsoft Azure platform</a>
|
|
|
|
<a data-link href="/docker/installation/rackspace/" class=""> Installation on Rackspace Cloud</a>
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/installation/binaries/" class=""> Installation from binaries</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<a data-link href="/kitematic/" class=""> Kitematic</a>
|
|
|
|
|
|
|
|
<a data-link href="/machine/install-machine/" class=""> Docker Machine</a>
|
|
|
|
|
|
|
|
<a data-link href="/compose/install/" class=""> Docker Compose</a>
|
|
|
|
|
|
|
|
<a data-link href="/swarm/install-w-machine/" class=""> Docker Swarm</a>
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
</section>
|
|
|
|
<section data-accordion>
|
|
|
|
<article data-accordion>
|
|
<button data-control> Docker Fundamentals</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/docker/userguide/" class=""> The Docker user guide</a>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Work with Docker Images</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/articles/dockerfile_best-practices/" class=""> Best practices for writing Dockerfiles</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/articles/baseimages/" class=""> Create a base image</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/userguide/dockerimages/" class=""> Get started with images</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/userguide/dockerrepos/" class=""> Get started with Docker Hub</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Work with Docker Containers</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/articles/basics/" class=""> Get started with containers</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/userguide/usingdocker/" class=""> Working with containers</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/userguide/dockervolumes/" class=""> Managing data in containers</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/userguide/dockerlinks/" class=""> Linking containers together</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/articles/host_integration/" class=""> Automatically start containers</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Docker on Windows & OSX</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/articles/dsc/" class=""> PowerShell DSC Usage</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/articles/b2d_volume_resize/" class=""> Resizing a Boot2Docker volume </a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Use the Kitematic GUI</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/kitematic/userguide/" class=""> Kitematic User Guide: Intro & Overview</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/kitematic/nginx-web-server/" class=""> Set up an Nginx web server</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/kitematic/minecraft-server/" class=""> Set up a Minecraft Server</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/kitematic/rethinkdb-dev-database/" class=""> Creating a Local RethinkDB Database for Development</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/kitematic/faq/" class=""> Frequently Asked Questions</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/kitematic/known-issues/" class=""> Known Issues</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
</section>
|
|
|
|
<section data-accordion>
|
|
|
|
<article data-accordion>
|
|
<button data-control> Use Docker</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/docker/misc/" class=""> About Docker</a>
|
|
|
|
|
|
|
|
<a data-link href="/docker/userguide/labels-custom-metadata/" class=""> Apply custom metadata</a>
|
|
|
|
|
|
|
|
<a data-link href="/docker/introduction/understanding-docker/" class=""> Understand the architecture</a>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Provision & set up Docker hosts</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/machine/" class=""> Overview of Docker Machine</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Create multi-container applications</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/compose/" class=""> Overview of Docker Compose</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/compose/production/" class=""> Using Compose in production</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/compose/extends/" class=""> Extending services in Compose</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/compose/completion/" class=""> Command Completion</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/compose/django/" class=""> Quickstart Guide: Compose and Django</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/compose/rails/" class=""> Quickstart Guide: Compose and Rails</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/compose/wordpress/" class=""> Quickstart Guide: Compose and Wordpress</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Cluster Docker containers</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/swarm/" class=""> Docker Swarm</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/swarm/install-manual/" class=""> Create a swarm for development</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/swarm/discovery/" class=""> Docker Swarm discovery</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/swarm/scheduler/filter/" class=""> Docker Swarm filters</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/swarm/scheduler/strategy/" class=""> Docker Swarm strategies</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Adminstrate Docker</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/articles/networking/" class=""> Network configuration</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/articles/security/" class=""> Docker security</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/articles/configuring/" class=""> Configuring and running Docker</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/articles/runmetrics/" class=""> Runtime metrics</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/articles/https/" class=""> Protect the Docker daemon socket</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/articles/ambassador_pattern_linking/" class=""> Link via an ambassador container</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/articles/systemd/" class=""> Control and configure Docker with systemd</a>
|
|
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Applications and Services</button>
|
|
<div data-content>
|
|
|
|
<a data-link href="/docker/examples/running_riak_service/" class=""> Dockerizing a Riak service</a>
|
|
|
|
<a data-link href="/docker/examples/running_ssh_service/" class=""> Dockerizing an SSH service</a>
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Integrate with Third-party Tools</button>
|
|
<div data-content>
|
|
|
|
<a data-link href="/articles/cfengine_process_management/" class=""> Process management with CFEngine</a>
|
|
|
|
<a data-link href="/articles/chef/" class=""> Using Chef</a>
|
|
|
|
<a data-link href="/articles/puppet/" class=""> Using Puppet</a>
|
|
|
|
<a data-link href="/articles/using_supervisord/" class=""> Using Supervisor with Docker</a>
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Applied Docker</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/docker/examples/mongodb/" class=""> Dockerizing MongoDB</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/examples/postgresql_service/" class=""> Dockerizing PostgreSQL</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/examples/couchdb_data_volumes/" class=""> Dockerizing a CouchDB service</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/examples/nodejs_web_app/" class=""> Dockerizing a Node.js web app</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/examples/running_redis_service/" class=""> Dockerizing a Redis service</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/examples/apt-cacher-ng/" class=""> Dockerizing an apt-cacher-ng service</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/userguide/dockerizing/" class=""> Dockerizing applications: A 'Hello world'</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
</section>
|
|
|
|
<section data-accordion>
|
|
|
|
<article data-accordion>
|
|
<button data-control> Manage image repositories</button>
|
|
<div data-content>
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> The Public Hub</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/docker/docker-hub/userguide/" class=""> Docker Hub user guide</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/docker-hub/" class=""> The Docker Hub</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/docker-hub/accounts/" class=""> Accounts on Docker Hub</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/userguide/dockerhub/" class=""> Getting started with Docker Hub</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/docker-hub/repos/" class=""> Your Repositories on Docker Hub</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/docker-hub/builds/" class=""> Automated Builds on Docker Hub</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/docker-hub/official_repos/" class=""> Official Repositories on Docker Hub</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Docker Trusted Registry</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/docker-trusted-registry/" class=""> Overview</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker-trusted-registry/quick-start/" class=""> Quick-start: Basic Workflow</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker-trusted-registry/userguide/" class=""> User guide</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker-trusted-registry/adminguide/" class=""> Admin guide</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker-trusted-registry/install/" class=""> Installation</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker-trusted-registry/configuration/" class=""> Configuration options</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker-trusted-registry/support/" class=""> Support</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker-trusted-registry/release-notes/" class=""> Release notes</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker-trusted-registry/prior-release-notes/" class=""> Prior release notes archive</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Docker Registry</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/registry/" class=""> Docker Registry 2.0</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/registry/introduction/" class=""> Understanding the Registry</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/registry/deploying/" class=""> Deploying a registry server</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/registry/configuration/" class=""> Configure a Registry</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/registry/notifications/" class=""> Work with Notifications</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/registry/authentication/" class=""> Authentication for the Registry</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/registry/help/" class=""> Getting help</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<a data-link href="/articles/certificates/" class=""> Using certificates for repository client verification</a>
|
|
|
|
|
|
|
|
<a data-link href="/articles/registry_mirror/" class=""> Run a local registry mirror</a>
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
</section>
|
|
|
|
<section data-accordion>
|
|
|
|
<article data-accordion>
|
|
<button data-control> Command and API references</button>
|
|
<div data-content>
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Command line reference</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/cli/" class=""> Using the command line</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/daemon/" class=""> daemon</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/attach/" class=""> attach</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/build/" class=""> build</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/commit/" class=""> commit</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/cp/" class=""> cp</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/create/" class=""> create</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/diff/" class=""> diff</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/events/" class=""> events</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/exec/" class=""> exec</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/export/" class=""> export</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/history/" class=""> history</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/images/" class=""> images</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/import/" class=""> import</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/info/" class=""> info</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/inspect/" class=""> inspect</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/kill/" class=""> kill</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/load/" class=""> load</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/login/" class=""> login</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/logout/" class=""> logout</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/logs/" class=""> logs</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/pause/" class=""> pause</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/port/" class=""> port</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/ps/" class=""> ps</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/pull/" class=""> pull</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/push/" class=""> push</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/rename/" class=""> rename</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/restart/" class=""> restart</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/rm/" class=""> rm</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/rmi/" class=""> rmi</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/run/" class=""> run</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/save/" class=""> save</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/search/" class=""> search</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/start/" class=""> start</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/stats/" class=""> stats</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/stop/" class=""> stop</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/tag/" class=""> tag</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/top/" class=""> top</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/unpause/" class=""> unpause</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/version/" class=""> version</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/commandline/wait/" class=""> wait</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/run/" class=""> Docker run reference</a>
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/builder/" class=""> Dockerfile reference</a>
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/api/remote_api_client_libraries/" class=""> Remote API client libraries</a>
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/api/docker_io_accounts_api/" class=""> docker.io accounts API</a>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Docker Remote API</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/docker/reference/api/docker-io_api/" class=""> Docker Hub API</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/api/docker_remote_api/" class=""> Remote API</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/api/docker_remote_api_v1.19/" class=""> Remote API v1.19</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/api/docker_remote_api_v1.18/" class=""> Remote API v1.18</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/api/docker_remote_api_v1.17/" class=""> Remote API v1.17</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/api/docker_remote_api_v1.16/" class=""> Remote API v1.16</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/api/docker_remote_api_v1.15/" class=""> Remote API v1.15</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/api/docker_remote_api_v1.14/" class=""> Remote API v1.14</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Docker Hub</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/docker/reference/api/hub_registry_spec/" class=""> The Docker Hub and the Registry v1</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Docker Compose Reference</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/compose/cli/" class=""> Compose CLI reference</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/compose/yml/" class=""> docker-compose.yml reference</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/compose/env/" class=""> Compose environment variables reference</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<a data-link href="" class=""> Docker Machine Reference</a>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Docker Swarm Reference</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/swarm/api/swarm-api/" class=""> Docker Swarm API</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Docker Registry Reference</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/registry/spec/api/" class=""> Docker Registry HTTP API V2</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/registry/storagedrivers/" class=""> Docker Registry Storage Driver</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/registry/spec/auth/token/" class=""> Docker Registry v2 Authentication</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
</section>
|
|
|
|
<section data-accordion>
|
|
|
|
<article data-accordion>
|
|
<button data-control> Open Source at Docker</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/opensource/how-to-contribute/" class=""> Overview of contributing</a>
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/get-help/" class=""> Where to chat or get help</a>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Configure Development Environment</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/docker/project/who-written-for/" class=""> README first</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/software-required/" class=""> Get the required software</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/software-req-win/" class=""> Set up for development on Windows</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/set-up-git/" class=""> Configure Git for contributing</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/set-up-dev-env/" class=""> Work with a development container</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/test-and-docs/" class=""> Run tests and test documentation</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Contribution Workflow</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/docker/project/make-a-contribution/" class=""> Understand how to contribute</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/find-an-issue/" class=""> Find and claim an issue</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/work-issue/" class=""> Work on your issue</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/create-pr/" class=""> Create a pull request (PR)</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/review-pr/" class=""> Participate in the PR review</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/advanced-contributing/" class=""> Advanced contributing</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/coding-style/" class=""> Coding style checklist</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<a data-link href="/opensource/code/" class=" active"> Contribute code overview</a>
|
|
|
|
|
|
|
|
<a data-link href="/opensource/community/" class=""> Support the community</a>
|
|
|
|
|
|
|
|
<a data-link href="/opensource/issues/" class=""> Organize our issues</a>
|
|
|
|
|
|
|
|
<a data-link href="/opensource/meetups/" class=""> Organize a Docker Meetup</a>
|
|
|
|
|
|
|
|
<a data-link href="/opensource/test/" class=""> Testing contributions</a>
|
|
|
|
|
|
|
|
<article data-accordion>
|
|
<button data-control> Governance</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/opensource/governance/dgab-info/" class=""> Docker Governance Advisory Board</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/opensource/governance/board-profiles/" class=""> Board member profiles</a>
|
|
|
|
|
|
|
|
|
|
<a data-link href="/opensource/governance/conduct-code/" class=""> Code of conduct</a>
|
|
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
|
|
|
|
<a data-link href="/docker/project/doc-style/" class=""> Style guide for Docker documentation</a>
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
</section>
|
|
|
|
<section data-accordion>
|
|
|
|
<article data-accordion>
|
|
<button data-control> About</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="/release-notes/" class=""> Docker Release Notes</a>
|
|
|
|
|
|
|
|
<a data-link href="/swarm/release-notes/" class=""> Docker Swarm Release Notes</a>
|
|
|
|
|
|
|
|
<a data-link href="/docker/misc/faq/" class=""> FAQ</a>
|
|
|
|
|
|
|
|
<a data-link href="/docker/reference/glossary/" class=""> Docker Glossary</a>
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
</section>
|
|
|
|
<section data-accordion>
|
|
|
|
<article data-accordion>
|
|
<button style="visibility: hidden" data-control> Get older docs</button>
|
|
<div data-content>
|
|
|
|
|
|
<a data-link href="https://docs.docker.com/v1.6/" class=""> Version 1.6</a>
|
|
|
|
|
|
|
|
<a data-link href="https://docs.docker.com/v1.5/" class=""> Version 1.5</a>
|
|
|
|
|
|
|
|
<a data-link href="https://docs.docker.com/v1.4/" class=""> Version 1.4</a>
|
|
|
|
|
|
</div>
|
|
</article>
|
|
|
|
</section>
|
|
|
|
</section>
|
|
|
|
<script>
|
|
$(document).ready(function () {
|
|
var $activeLink = $('#multiple [data-link].active');
|
|
var $accordions = $activeLink.parents('article[data-accordion]');
|
|
$($accordions.get().reverse()).each(function (index, accordion) {
|
|
var $accordion = $(accordion);
|
|
var $content = $accordion.find('[data-content]');
|
|
$accordion.addClass('open');
|
|
$content.css({'max-height': '100%'});
|
|
});
|
|
});
|
|
</script>
|
|
</div>
|
|
<div class="large-6 columns">
|
|
<section id="main">
|
|
<article id="content">
|
|
|
|
|
|
<h1 id="contribute-code-overview">Contribute code overview</h1>
|
|
|
|
<p>If you’d like to improve the code of any of Docker’s projects, we would love to
|
|
have your contributions. All of our projects’ code repositories are on GitHub:</p>
|
|
|
|
<table class="tg" >
|
|
<col width="20%">
|
|
<col width="80%">
|
|
<tr>
|
|
<td class="tg-031e"><a href="https://github.com/docker/docker" target="_blank">docker/docker</a></td>
|
|
<td class="tg-031e">Docker the open-source application container engine</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tg-031e"><a href="https://github.com/docker/machine" target="_blank">docker/machine</a></td>
|
|
<td class="tg-031e">Software for the easy and quick creation of Docker hosts on your computer, on cloud providers, and inside your own data center.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tg-031e"><a href="https://github.com/kitematic/kitematic" target="_blank">kitematic/kitematic</a></td>
|
|
<td class="tg-031e">Kitematic is a simple application for managing Docker containers on Mac OS X.</td>
|
|
</tr>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tg-031e"><a href="https://github.com/docker/swarm" target="_blank">docker/swarm</a></td>
|
|
<td class="tg-031e">Native clustering for Docker; manage several Docker hosts as a single, virtual host.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tg-031e"><a href="https://github.com/docker/compose" target="_blank">docker/compose</a></td>
|
|
<td class="tg-031e">Define and run complex applications using one or many interlinked containers.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>See <a href="https://github.com/docker" target="_blank">the complete list of
|
|
Docker repositories</a> on GitHub.</p>
|
|
|
|
<p>If you want to contribute to the <code>docker/docker</code> repository you should be
|
|
familiar with or a invested in learning Go or the Markdown language. If you
|
|
know other languages, investigate our
|
|
other repositories—not all of them run on Go.</p>
|
|
|
|
<h1 id="code-contribution-workflow">Code contribution workflow</h1>
|
|
|
|
<p>Below is the general workflow for contributing Docker code or documentation.
|
|
If you are an experienced open source contributor you may be familiar with this
|
|
workflow. If you are new or just need reminders, the steps below link to more
|
|
detailed documentation in Docker’s project contributors guide.</p>
|
|
|
|
<ol>
|
|
<li><p><a href="http://docs.docker.com/project/software-required/"
|
|
target="_blank">Get the software</a> you need.</p>
|
|
|
|
<p>This explains how to install a couple of tools used in our development
|
|
environment. What you need (or don’t need) might surprise you.</p></li>
|
|
|
|
<li><p><a href="http://docs.docker.com/project/set-up-git/"
|
|
target="_blank">Configure Git and fork the repo</a>.</p>
|
|
|
|
<p>Your Git configuration can make it easier for you to contribute.
|
|
Configuration is especially key if are new to contributing or to Docker.</p></li>
|
|
|
|
<li><p><a href="http://docs.docker.com/project/set-up-dev-env/"
|
|
target="_blank">Learn to work with the Docker development container</a>.</p>
|
|
|
|
<p>Docker developers run <code>docker</code> in <code>docker</code>. If you are a geek,
|
|
this is a pretty cool experience.</p></li>
|
|
|
|
<li><p><a href="http://docs.docker.com/project/find-an-issue/"
|
|
target="_blank">Claim an issue</a> to work on.</p>
|
|
|
|
<p>We created a filter listing <a href="http://goo.gl/Hsp2mk" target="_blank">all open
|
|
and unclaimed issues</a> for Docker.</p></li>
|
|
|
|
<li><p><a
|
|
href="http://docs.docker.com/project/work-issue/" target="_blank">Work on the
|
|
issue</a>.</p>
|
|
|
|
<p>If you change or add code or docs to a project, you should test your changes
|
|
as you work. This page explains <a
|
|
href="http://docs.docker.com/project/test-and-docs/" target="_blank">how to
|
|
test in our development environment</a>.</p>
|
|
|
|
<p>Also, remember to always <strong>sign your commits</strong> as you work! To sign your
|
|
commits, include the <code>-s</code> flag in your commit like this:</p>
|
|
|
|
<pre><code>$ git commit -s -m "Add commit with signature example"
|
|
</code></pre>
|
|
|
|
<p>If you don’t sign <a href="https://twitter.com/gordontheturtle"
|
|
target="_blank">Gordon</a> will get you!</p></li>
|
|
|
|
<li><p><a href="http://docs.docker.com/project/create-pr/" target="_blank">Create a
|
|
pull request</a>.</p>
|
|
|
|
<p>If you make a change to fix an issue, add reference to the issue in the pull
|
|
request. Here is an example of a perfect pull request with a good description,
|
|
issue reference, and signature in the commit:</p>
|
|
|
|
<p><img src="/opensource/images/bonus.png" alt="Sign commits and issues" />
|
|
</p>
|
|
|
|
<p>We have also have checklist that describes <a href="#what-is-the-pre-pull-request-checklist">what each pull request
|
|
needs</a>.</p></li>
|
|
|
|
<li><p><a href="http://docs.docker.com/project/review-pr/"
|
|
target="_blank">Participate in the pull request review</a> till a successful
|
|
merge.</p></li>
|
|
</ol>
|
|
|
|
<h2 id="faq-and-troubleshooting-tips-for-coders">FAQ and troubleshooting tips for coders</h2>
|
|
|
|
<p>This section contains some frequently asked questions and tips for
|
|
troubleshooting problems in your code contribution.</p>
|
|
|
|
<ul>
|
|
<li><a href="#how-do-i-set-my-signature:cb7f612e17aad7eb26c06709ef92a867">How do I set my signature?</a></li>
|
|
<li><a href="#how-do-i-track-changes-from-the-docker-repo-upstream:cb7f612e17aad7eb26c06709ef92a867">How do I track changes from the docker repo upstream?</a></li>
|
|
<li><a href="#how-do-i-format-my-go-code:cb7f612e17aad7eb26c06709ef92a867">How do I format my Go code?</a></li>
|
|
<li><a href="#what-is-the-pre-pull-request-checklist:cb7f612e17aad7eb26c06709ef92a867">What is the pre-pull request checklist?</a></li>
|
|
<li><a href="#how-should-i-comment-my-code:cb7f612e17aad7eb26c06709ef92a867">How should I comment my code?</a></li>
|
|
<li><a href="#how-do-i-rebase-my-feature-branch:cb7f612e17aad7eb26c06709ef92a867">How do I rebase my feature branch?</a></li>
|
|
</ul>
|
|
|
|
<h3 id="how-do-i-set-my-signature">How do I set my signature</h3>
|
|
|
|
<ol>
|
|
<li><p>Change to the root of your <code>docker-fork</code> repository.</p>
|
|
|
|
<pre><code>$ cd docker-fork
|
|
</code></pre></li>
|
|
|
|
<li><p>Set your <code>user.name</code> for the repository.</p>
|
|
|
|
<pre><code>$ git config --local user.name "FirstName LastName"
|
|
</code></pre></li>
|
|
|
|
<li><p>Set your <code>user.email</code> for the repository.</p>
|
|
|
|
<pre><code>$ git config --local user.email "emailname@mycompany.com"
|
|
</code></pre></li>
|
|
</ol>
|
|
|
|
<h3 id="how-do-i-track-changes-from-the-docker-repo-upstream">How do I track changes from the docker repo upstream</h3>
|
|
|
|
<p>Set your local repo to track changes upstream, on the <code>docker</code> repository.</p>
|
|
|
|
<ol>
|
|
<li><p>Change to the root of your Docker repository.</p>
|
|
|
|
<pre><code>$ cd docker-fork
|
|
</code></pre></li>
|
|
|
|
<li><p>Add a remote called <code>upstream</code> that points to <code>docker/docker</code></p>
|
|
|
|
<pre><code>$ git remote add upstream https://github.com/docker/docker.git
|
|
</code></pre></li>
|
|
</ol>
|
|
|
|
<h3 id="how-do-i-format-my-go-code">How do I format my Go code</h3>
|
|
|
|
<p>Run <code>gofmt -s -w filename.go</code> on each changed file before committing your changes.
|
|
Most editors have plug-ins that do the formatting automatically.</p>
|
|
|
|
<h3 id="what-is-the-pre-pull-request-checklist">What is the pre-pull request checklist</h3>
|
|
|
|
<ul>
|
|
<li><p>Sync and cleanly rebase on top of Docker’s <code>master</code>; do not mix multiple branches
|
|
in the pull request.</p></li>
|
|
|
|
<li><p>Squash your commits into logical units of work using
|
|
<code>git rebase -i</code> and <code>git push -f</code>.</p></li>
|
|
|
|
<li><p>If your code requires a change to tests or documentation, include code,test,
|
|
and documentation changes in the same commit as your code; this ensures a
|
|
revert would remove all traces of the feature or fix.</p></li>
|
|
|
|
<li><p>Reference each issue in your pull request description (<code>#XXXX</code>).</p></li>
|
|
</ul>
|
|
|
|
<h3 id="how-should-i-comment-my-code">How should I comment my code?</h3>
|
|
|
|
<p>The Go blog wrote about code comments, it is <a href="http://goo.gl/fXCRu"
|
|
target="_blank">a single page explanation</a>. A summary follows:</p>
|
|
|
|
<ul>
|
|
<li>Comments begin with two forward <code>//</code> slashes.</li>
|
|
<li>To document a type, variable, constant, function, or even a package, write a
|
|
regular comment directly preceding the elements declaration, with no intervening blank
|
|
line.</li>
|
|
<li>Comments on package declarations should provide general package documentation.</li>
|
|
<li>For packages that need large amounts of introductory documentation: the
|
|
package comment is placed in its own file.</li>
|
|
<li>Subsequent lines of text are considered part of the same paragraph; you must
|
|
leave a blank line to separate paragraphs.</li>
|
|
<li>Indent pre-formatted text relative to the surrounding comment text (see gob’s doc.go for an example).</li>
|
|
<li>URLs are converted to HTML links; no special markup is necessary.</li>
|
|
</ul>
|
|
|
|
<h3 id="how-do-i-rebase-my-feature-branch">How do I rebase my feature branch?</h3>
|
|
|
|
<p>Always rebase and squash your commits before making a pull request.</p>
|
|
|
|
<ol>
|
|
<li><p>Fetch any of the last minute changes from <code>docker/docker</code>.</p>
|
|
|
|
<pre><code>$ git fetch upstream master
|
|
</code></pre></li>
|
|
|
|
<li><p>Start an interactive rebase.</p>
|
|
|
|
<pre><code>$ git rebase -i upstream/master
|
|
</code></pre></li>
|
|
|
|
<li><p>Rebase opens an editor with a list of commits.</p>
|
|
|
|
<pre><code> pick 1a79f55 Tweak some of images
|
|
pick 3ce07bb Add a new line
|
|
</code></pre>
|
|
|
|
<p>If you run into trouble, <code>git --rebase abort</code> removes any changes and gets you
|
|
back to where you started.</p></li>
|
|
|
|
<li><p>Squash the <code>pick</code> keyword with <code>squash</code> on all but the first commit.</p>
|
|
|
|
<pre><code>pick 1a79f55 Tweak some of images
|
|
squash 3ce07bb Add a new line
|
|
</code></pre>
|
|
|
|
<p>After closing the file, <code>git</code> opens your editor again to edit the commit
|
|
message.</p></li>
|
|
|
|
<li><p>Edit and save your commit message.</p>
|
|
|
|
<pre><code>$ git commit -s
|
|
</code></pre>
|
|
|
|
<p>Make sure your message includes your signature.</p></li>
|
|
|
|
<li><p>Push any changes to your fork on GitHub.</p>
|
|
|
|
<pre><code>$ git push origin my-keen-feature
|
|
</code></pre></li>
|
|
</ol>
|
|
|
|
</article>
|
|
</section>
|
|
</div>
|
|
<div id="toc" class="large-3 columns toc ">
|
|
On this page:
|
|
<nav id="TableOfContents">
|
|
<ul>
|
|
<li><a href="#contribute-code-overview">Contribute code overview</a></li>
|
|
<li><a href="#code-contribution-workflow">Code contribution workflow</a>
|
|
<ul>
|
|
<li><a href="#faq-and-troubleshooting-tips-for-coders">FAQ and troubleshooting tips for coders</a>
|
|
<ul>
|
|
<li><a href="#how-do-i-set-my-signature">How do I set my signature</a></li>
|
|
<li><a href="#how-do-i-track-changes-from-the-docker-repo-upstream">How do I track changes from the docker repo upstream</a></li>
|
|
<li><a href="#how-do-i-format-my-go-code">How do I format my Go code</a></li>
|
|
<li><a href="#what-is-the-pre-pull-request-checklist">What is the pre-pull request checklist</a></li>
|
|
<li><a href="#how-should-i-comment-my-code">How should I comment my code?</a></li>
|
|
<li><a href="#how-do-i-rebase-my-feature-branch">How do I rebase my feature branch?</a></li>
|
|
</ul></li>
|
|
</ul></li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="main-footer">
|
|
<div class="row">
|
|
</div>
|
|
<div class="row">
|
|
</div>
|
|
<div id="buildinfo">
|
|
Jul 8, 2015 at 6:45pm (PST)
|
|
BUILD_DATA
|
|
</div>
|
|
</footer>
|
|
<link rel="stylesheet" href="/highlight/styles/github.css">
|
|
<script src="/highlight/highlight.pack.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
|
|
<script src="/dist/assets/js/all.js"></script>
|
|
<script>
|
|
$( 'nav li:has(ul)' ).doubleTapToGo();
|
|
</script>
|
|
<script>
|
|
|
|
;(function ( $, window, document, undefined ) {
|
|
|
|
var pluginName = 'accordion',
|
|
defaults = {
|
|
transitionSpeed: 300,
|
|
transitionEasing: 'ease',
|
|
controlElement: '[data-control]',
|
|
contentElement: '[data-content]',
|
|
groupElement: '[data-accordion-group]',
|
|
singleOpen: true
|
|
};
|
|
|
|
function Accordion(element, options) {
|
|
this.element = element;
|
|
this.options = $.extend({}, defaults, options);
|
|
this._defaults = defaults;
|
|
this._name = pluginName;
|
|
this.init();
|
|
}
|
|
|
|
Accordion.prototype.init = function () {
|
|
var self = this,
|
|
opts = self.options;
|
|
|
|
var $accordion = $(self.element),
|
|
$controls = $accordion.find('> ' + opts.controlElement),
|
|
$content = $accordion.find('> ' + opts.contentElement);
|
|
|
|
var accordionParentsQty = $accordion.parents('[data-accordion]').length,
|
|
accordionHasParent = accordionParentsQty > 0;
|
|
|
|
var closedCSS = { 'max-height': 0, 'overflow': 'hidden' };
|
|
|
|
var CSStransitions = supportsTransitions();
|
|
|
|
function debounce(func, threshold, execAsap) {
|
|
var timeout;
|
|
|
|
return function debounced() {
|
|
var obj = this,
|
|
args = arguments;
|
|
|
|
function delayed() {
|
|
if (!execAsap) func.apply(obj, args);
|
|
timeout = null;
|
|
};
|
|
|
|
if (timeout) clearTimeout(timeout);
|
|
else if (execAsap) func.apply(obj, args);
|
|
|
|
timeout = setTimeout(delayed, threshold || 100);
|
|
};
|
|
}
|
|
|
|
function supportsTransitions() {
|
|
var b = document.body || document.documentElement,
|
|
s = b.style,
|
|
p = 'transition';
|
|
|
|
if (typeof s[p] == 'string') {
|
|
return true;
|
|
}
|
|
|
|
var v = ['Moz', 'webkit', 'Webkit', 'Khtml', 'O', 'ms'];
|
|
|
|
p = 'Transition';
|
|
|
|
for (var i=0; i<v.length; i++) {
|
|
if (typeof s[v[i] + p] == 'string') {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
function requestAnimFrame(cb) {
|
|
if(window.requestAnimationFrame || window.webkitRequestAnimationFrame || window.mozRequestAnimationFrame) {
|
|
return requestAnimationFrame(cb) ||
|
|
webkitRequestAnimationFrame(cb) ||
|
|
mozRequestAnimationFrame(cb);
|
|
} else {
|
|
return setTimeout(cb, 1000 / 60);
|
|
}
|
|
}
|
|
|
|
function toggleTransition($el, remove) {
|
|
if(!remove) {
|
|
$content.css({
|
|
'-webkit-transition': 'max-height ' + opts.transitionSpeed + 'ms ' + opts.transitionEasing,
|
|
'transition': 'max-height ' + opts.transitionSpeed + 'ms ' + opts.transitionEasing
|
|
});
|
|
} else {
|
|
$content.css({
|
|
'-webkit-transition': '',
|
|
'transition': ''
|
|
});
|
|
}
|
|
}
|
|
|
|
function calculateHeight($el) {
|
|
var height = 0;
|
|
|
|
$el.children().each(function() {
|
|
height = height + $(this).outerHeight(true);
|
|
});
|
|
|
|
$el.data('oHeight', height);
|
|
}
|
|
|
|
function updateParentHeight($parentAccordion, $currentAccordion, qty, operation) {
|
|
var $content = $parentAccordion.filter('.open').find('> [data-content]'),
|
|
$childs = $content.find('[data-accordion].open > [data-content]'),
|
|
$matched;
|
|
|
|
if(!opts.singleOpen) {
|
|
$childs = $childs.not($currentAccordion.siblings('[data-accordion].open').find('> [data-content]'));
|
|
}
|
|
|
|
$matched = $content.add($childs);
|
|
|
|
if($parentAccordion.hasClass('open')) {
|
|
$matched.each(function() {
|
|
var currentHeight = $(this).data('oHeight');
|
|
|
|
switch (operation) {
|
|
case '+':
|
|
$(this).data('oHeight', currentHeight + qty);
|
|
break;
|
|
case '-':
|
|
$(this).data('oHeight', currentHeight - qty);
|
|
break;
|
|
default:
|
|
throw 'updateParentHeight method needs an operation';
|
|
}
|
|
|
|
$(this).css('max-height', $(this).data('oHeight'));
|
|
});
|
|
}
|
|
}
|
|
|
|
function refreshHeight($accordion) {
|
|
if($accordion.hasClass('open')) {
|
|
var $content = $accordion.find('> [data-content]'),
|
|
$childs = $content.find('[data-accordion].open > [data-content]'),
|
|
$matched = $content.add($childs);
|
|
|
|
calculateHeight($matched);
|
|
|
|
$matched.css('max-height', $matched.data('oHeight'));
|
|
}
|
|
}
|
|
|
|
function closeAccordion($accordion, $content) {
|
|
$accordion.trigger('accordion.close');
|
|
|
|
if(CSStransitions) {
|
|
if(accordionHasParent) {
|
|
var $parentAccordions = $accordion.parents('[data-accordion]');
|
|
|
|
updateParentHeight($parentAccordions, $accordion, $content.data('oHeight'), '-');
|
|
}
|
|
|
|
$content.css(closedCSS);
|
|
|
|
$accordion.removeClass('open');
|
|
} else {
|
|
$content.css('max-height', $content.data('oHeight'));
|
|
|
|
$content.animate(closedCSS, opts.transitionSpeed);
|
|
|
|
$accordion.removeClass('open');
|
|
}
|
|
}
|
|
|
|
function openAccordion($accordion, $content) {
|
|
$accordion.trigger('accordion.open');
|
|
if(CSStransitions) {
|
|
toggleTransition($content);
|
|
|
|
if(accordionHasParent) {
|
|
var $parentAccordions = $accordion.parents('[data-accordion]');
|
|
|
|
updateParentHeight($parentAccordions, $accordion, $content.data('oHeight'), '+');
|
|
}
|
|
|
|
requestAnimFrame(function() {
|
|
$content.css('max-height', $content.data('oHeight'));
|
|
});
|
|
|
|
$accordion.addClass('open');
|
|
} else {
|
|
$content.animate({
|
|
'max-height': $content.data('oHeight')
|
|
}, opts.transitionSpeed, function() {
|
|
$content.css({'max-height': 'none'});
|
|
});
|
|
|
|
$accordion.addClass('open');
|
|
}
|
|
}
|
|
|
|
function closeSiblingAccordions($accordion) {
|
|
var $accordionGroup = $accordion.closest(opts.groupElement);
|
|
|
|
var $siblings = $accordion.siblings('[data-accordion]').filter('.open'),
|
|
$siblingsChildren = $siblings.find('[data-accordion]').filter('.open');
|
|
|
|
var $otherAccordions = $siblings.add($siblingsChildren);
|
|
|
|
$otherAccordions.each(function() {
|
|
var $accordion = $(this),
|
|
$content = $accordion.find(opts.contentElement);
|
|
|
|
closeAccordion($accordion, $content);
|
|
});
|
|
|
|
$otherAccordions.removeClass('open');
|
|
}
|
|
|
|
function toggleAccordion() {
|
|
var isAccordionGroup = (opts.singleOpen) ? $accordion.parents(opts.groupElement).length > 0 : false;
|
|
|
|
calculateHeight($content);
|
|
|
|
if(isAccordionGroup) {
|
|
closeSiblingAccordions($accordion);
|
|
}
|
|
|
|
if($accordion.hasClass('open')) {
|
|
closeAccordion($accordion, $content);
|
|
} else {
|
|
openAccordion($accordion, $content);
|
|
}
|
|
}
|
|
|
|
function addEventListeners() {
|
|
$controls.on('click', toggleAccordion);
|
|
|
|
$controls.on('accordion.toggle', function() {
|
|
if(opts.singleOpen && $controls.length > 1) {
|
|
return false;
|
|
}
|
|
|
|
toggleAccordion();
|
|
});
|
|
|
|
$(window).on('resize', debounce(function() {
|
|
refreshHeight($accordion);
|
|
}));
|
|
}
|
|
|
|
function setup() {
|
|
$content.each(function() {
|
|
var $curr = $(this);
|
|
|
|
if($curr.css('max-height') != 0) {
|
|
if(!$curr.closest('[data-accordion]').hasClass('open')) {
|
|
$curr.css({ 'max-height': 0, 'overflow': 'hidden' });
|
|
} else {
|
|
toggleTransition($curr);
|
|
calculateHeight($curr);
|
|
|
|
$curr.css('max-height', $curr.data('oHeight'));
|
|
}
|
|
}
|
|
});
|
|
|
|
|
|
if(!$accordion.attr('data-accordion')) {
|
|
$accordion.attr('data-accordion', '');
|
|
$accordion.find(opts.controlElement).attr('data-control', '');
|
|
$accordion.find(opts.contentElement).attr('data-content', '');
|
|
}
|
|
}
|
|
|
|
setup();
|
|
addEventListeners();
|
|
};
|
|
|
|
$.fn[pluginName] = function ( options ) {
|
|
return this.each(function () {
|
|
if (!$.data(this, 'plugin_' + pluginName)) {
|
|
$.data(this, 'plugin_' + pluginName,
|
|
new Accordion( this, options ));
|
|
}
|
|
});
|
|
}
|
|
|
|
})( jQuery, window, document );
|
|
|
|
$(document).ready(function() {
|
|
$('#multiple [data-accordion]').accordion({
|
|
singleOpen: false
|
|
});
|
|
});
|
|
|
|
</script>
|
|
|
|
|
|
<script src="/dist/assets/js/bootstrap-3.0.3.min.js"></script>
|
|
<script src="/dist/assets/js/archive.js"></script>
|
|
<script type="text/javascript">
|
|
!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="4.0.0";
|
|
analytics.load("IWj9D0UpZHZdZUZX9jl98PcpBFWBnBMy");
|
|
analytics.page();
|
|
}}();
|
|
</script>
|
|
|