From ed959f2144ed4719113cc4a570cd58ac0cca25da Mon Sep 17 00:00:00 2001
From: Ben Firshman <ben@firshman.co.uk>
Date: Tue, 18 Oct 2016 18:50:21 +0200
Subject: [PATCH] Move contributing docs to CONTRIBUTING.md

CONTRIBUTING.md is the place that GitHub expects it to be.

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
---
 CONTRIBUTING.md      | 34 ++++++++++++++++++++++++++++++++++
 docs/contributing.md | 36 ------------------------------------
 2 files changed, 34 insertions(+), 36 deletions(-)
 delete mode 100644 docs/contributing.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1bd8d426..dbc1c02a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,8 @@
 # Contributing guidelines
 
+See the [Docker contributing guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md).
+The following is specific to docker-py.
+
 Thank you for your interest in the project. We look forward to your
 contribution. In order to make the process as fast and streamlined as possible,
 here is a set of guidelines we recommend you follow.
@@ -100,3 +103,34 @@ here are the steps to get you started.
 5. Run `python setup.py develop` to install the dev version of the project
   and required dependencies. We recommend you do so inside a
   [virtual environment](http://docs.python-guide.org/en/latest/dev/virtualenvs)
+
+## Running the tests & Code Quality
+
+To get the source source code and run the unit tests, run:
+```
+$ git clone git://github.com/docker/docker-py.git
+$ cd docker-py
+$ pip install tox
+$ tox
+```
+
+## Building the docs
+
+```
+$ make docs
+$ open _build/index.html
+```
+
+## Release Checklist
+
+Before a new release, please go through the following checklist:
+
+* Bump version in docker/version.py
+* Add a release note in docs/change_log.md
+* Git tag the version
+* Upload to pypi
+
+## Vulnerability Reporting
+For any security issues, please do NOT file an issue or pull request on github!
+Please contact [security@docker.com](mailto:security@docker.com) or read [the
+Docker security page](https://www.docker.com/resources/security/).
diff --git a/docs/contributing.md b/docs/contributing.md
deleted file mode 100644
index e7764583..00000000
--- a/docs/contributing.md
+++ /dev/null
@@ -1,36 +0,0 @@
-# Contributing
-See the [Docker contributing guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md).
-The following is specific to docker-py.
-
-## Running the tests & Code Quality
-
-
-To get the source source code and run the unit tests, run:
-```
-$ git clone git://github.com/docker/docker-py.git
-$ cd docker-py
-$ pip install tox
-$ tox
-```
-
-## Building the docs
-Docs are built with [MkDocs](http://www.mkdocs.org/). For development, you can
-run the following in the project directory:
-```
-$ pip install -r docs-requirements.txt
-$ mkdocs serve
-```
-
-## Release Checklist
-
-Before a new release, please go through the following checklist:
-
-* Bump version in docker/version.py
-* Add a release note in docs/change_log.md
-* Git tag the version
-* Upload to pypi
-
-## Vulnerability Reporting
-For any security issues, please do NOT file an issue or pull request on github!
-Please contact [security@docker.com](mailto:security@docker.com) or read [the
-Docker security page](https://www.docker.com/resources/security/).