[PATCH 1/2] doc: Add CHANGELOG and UPGRADING docs

[Brian Norris]

Hi Stephen,

You asked for review, and there are a few pieces I'm qualified to
comment on :)

On Fri, Oct 16, 2015 at 11:00:22PM +0100, Stephen Finucane wrote:
> The CHANGELOG document should describe the high level changes of the
> project. This will provide a human-readable way for people to evaluate
> the changes in each release. This file is based on the templates and
> general changelog "ethos" provided by 'Keep a CHANGELOG':
> 
>     http://keepachangelog.com/
> 
> The UPGRADING document provide instruction for system admininstrators
> managing patchwork deployments. At the moment, this document is a
> rename and minor reformatting of the existing 'docs/NEWS' document, but
> going forward documentation will be added for each new release.
> 
> Signed-off-by: Stephen Finucane <stephen.finucane at intel.com>
> ---
>  CHANGELOG.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++
>  UPGRADING.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  docs/NEWS    | 67 ------------------------------------------------------
>  3 files changed, 131 insertions(+), 67 deletions(-)
>  create mode 100644 CHANGELOG.md
>  create mode 100644 UPGRADING.md
>  delete mode 100644 docs/NEWS
> 
> diff --git a/CHANGELOG.md b/CHANGELOG.md
> new file mode 100644
> index 0000000..f28a7b5
> --- /dev/null
> +++ b/CHANGELOG.md
> @@ -0,0 +1,57 @@
> +# Change Log
> +
> +All notable changes to this project will be documented in this file. Please
> +refer to the release notes for more detailed information, e.g. how to upgrade.
> +
> +This project adheres to [Semantic Versioning](http://semver.org/).
> +
> +## [Unreleased]
> +
> +...
> +
> +## [1.0.0] - 2015-10-16
> +
> +### Added
> +
> +- Patch tag infrastructure feature. This provide a quick summary of patch
> +  'tags' (e.g. `Acked-by`, `Reviewed-by`, ...) found in a patch and its replies
> +- Support for Django 1.7 and Django 1.8
> +- Support for Django Migrations. This will be the chosen method of making
> +  database changes going forward. See below for more information
> +- Support for tox
> +- Django management commands, which replace the existing patchwork cron scripts
> +
> +### Changed
> +
> +- Static files are now gather and served using the `django.contrib.staticfiles`
> +  module, per Django best practices
> +- Restructured directory per modern Django standards. The `apps` directory no
> +  longer exists and patchwork source has instead been moved to the top level
> +  directory
> +- Rewrote documentation to reflect changes in development and deployment best
> +  practices over the past few years
> +- Reworked `requirements.txt` and `settings.py` files
> +
> +### Removed
> +
> +- Support for Django 1.5
> +- Defunct Python 2.5 code
> +- Numerous dead files/code
> +- `bin/patchwork-cron` script, in favor of `cron` management command
> +
> +### Deprecated
> +
> +- Django 1.6 support will be removed in the next release
> +- Django 1.7 supports Django Migrations and Django 1.8 requires them. This
> +  negates the need for handwritten SQL migration scripts. Future releases will
> +  no longer include these scripts and they will eventually be removed
> +
> +## [0.9.0] - 2015-03-22
> +
> +**NOTE:** 1.0.0 was the first release of patchwork adopting semantic versioning.
> +For information on *"0.9.0"* and before, please refer to Git logs.
> +
> +[Unreleased]: https://github.com/getpatchwork/patchwork/compare/v1.0.0...HEAD
> +[1.0.0]: https://github.com/getpatchwork/patchwork/compare/v0.9.0...v1.0.0
> +[0.9.0]: https://github.com/getpatchwork/patchwork/compare/c561ebe...v0.9.0

What markdown are you using? These URLs don't get matched up to their
headers with mine; you need to include an ID on the header label for my
copy, from [1]. e.g.:

## [0.9.0][0.9.0] - 2015-03-22

Also, there are no tags uploaded to github, so the URLs don't work.

> +

Brian

[1] http://daringfireball.net/projects/markdown/