diff --git a/ChangeLog.md b/docs/change_log.md similarity index 99% rename from ChangeLog.md rename to docs/change_log.md index e58f28ea..f42f6e00 100644 --- a/ChangeLog.md +++ b/docs/change_log.md @@ -1,5 +1,10 @@ -ChangeLog -========= +Change Log +========== + +0.5.4 +----- + +* Added MkDocs documentation. 0.5.3 ----- diff --git a/docs/contributing.md b/docs/contributing.md index ebffeb1f..e79b95ad 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -26,7 +26,7 @@ $ mkdocs serve Before a new release, please go through the following checklist: * Bump version in docker/version.py -* Add a release note in docs/release_notes.md +* Add a release note in docs/change_log.md * Git tag the version * Upload to pypi diff --git a/docs/release_notes.md b/docs/release_notes.md deleted file mode 100644 index f28ad149..00000000 --- a/docs/release_notes.md +++ /dev/null @@ -1,5 +0,0 @@ -# Release Notes - -## v0.5.4 - -* This is the initial release of docker-py with MkDocs documentation. diff --git a/mkdocs.yml b/mkdocs.yml index 910c2521..460c1046 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,5 +10,5 @@ pages: - [port-bindings.md, Port Bindings] - [volumes.md, Using Volumes] - [tls.md, Using TLS] -- [release_notes.md, Release Notes] +- [change_log.md, Change Log] - [contributing.md, Contributing]