[PATCH 1/2] docs: Prepare for 2.1.0-rc1

[Stephen Finucane]

On Fri, 2018-04-06 at 03:03 +1000, Daniel Axtens wrote:
> Explain why we want an extra special ozlabs edition. (I can't find
> any good fabrics starting with E and I also want to emphasise that
> this is a special case.)

Fine with the name but I don't see why we should think of this as a
special case: we've enough meaningful changes in here to cut a valid
MINOR release. There are other things we'd like to slot in but that
will always be the case.

As an aside, how about 'Elastic'? Not _really_ a fabric but it's good
enough, IMO.

More comments below.

Stephen

> Signed-off-by: Daniel Axtens <dja at axtens.net>
> ---
>  docs/conf.py                                   |  4 ++--
>  docs/index.rst                                 |  1 +
>  docs/releases/extra-special-ozlabs-edition.rst | 33 ++++++++++++++++++++++++++
>  docs/releases/index.rst                        |  1 +
>  4 files changed, 37 insertions(+), 2 deletions(-)
>  create mode 100644 docs/releases/extra-special-ozlabs-edition.rst
> 
> diff --git a/docs/conf.py b/docs/conf.py
> index f692cf917ea0..a7bb714f2e6f 100644
> --- a/docs/conf.py
> +++ b/docs/conf.py
> @@ -48,9 +48,9 @@ author = u'Stephen Finucane'
>  # TODO(stephenfin): Eventually this should read the version programmatically
>  #
>  # The short X.Y version.
> -version = u'2.0-alpha'
> +version = u'2.1'
>  # The full version, including alpha/beta/rc tags.
> -release = u'2.0-alpha'
> +release = u'2.1-rc1'
>  
>  # The language for content autogenerated by Sphinx. Refer to documentation
>  # for a list of supported languages.
> diff --git a/docs/index.rst b/docs/index.rst
> index 2c2b92d435c8..0e996f194e5b 100644
> --- a/docs/index.rst
> +++ b/docs/index.rst
> @@ -68,6 +68,7 @@ of community projects.
>     :caption: Release Notes
>  
>     releases/unreleased
> +   releases/extra-special-ozlabs-edition
>     releases/dazzle
>     releases/cashmere
>     releases/burlap
> diff --git a/docs/releases/extra-special-ozlabs-edition.rst b/docs/releases/extra-special-ozlabs-edition.rst
> new file mode 100644
> index 000000000000..868e80810e03
> --- /dev/null
> +++ b/docs/releases/extra-special-ozlabs-edition.rst
> @@ -0,0 +1,33 @@
> +v2.1 Series ("Extra Special OzLabs Edition")
> +============================================
> +
> +This is a bit of a special case for the `OzLabs Patchwork instance`__.

I don't think this is necessary, per above.

> +
> +The key part of this release is a major performance fix -
> +denormalising the project field into patch model so that counting a
> +project's patches doesn't require a JOIN. This requires a migration
> +and so isn't suitable for a stable backport. Event listing in the API
> +has also been sped up by refactoring the queries.
> +
> +This release also includes the feature development that had accured in
> +the mean time, as laid out below, and numerous bug fixes.

This information should be included in a prelude section of a release
note. See 'releasenotes/notes/prelude-2_0-3d2364d246835503.yaml' for an
example (tip - generate it with 'reno new prelude-2_1' or similar).

> +Known Issues
> +------------
> +
> + - Series parsing in the presence of parallel mail processing is still
> +   unreliable.
> +
> + - Several more minor issues can be browsed on our `issue tracker`__.

Ditto. These should be included a release note in the 'issues' section.

> +
> +Release Notes
> +-------------
> +   
> +.. todo: change to stable branch when split off.
> +.. I think it might get confused with things in the stable releases?
> +.. release-notes::
> +   :branch: master
> +   :earliest-version: v2.0.0

Personally I don't think any of this needs to go in here until we're
ready to cut the final release. That should simplify this whole thing
too. Just drop this whole thing and add the prelude release note
instead.

> +
> +__ https://patchwork.ozlabs.org
> +__ https://github.com/getpatchwork/patchwork/issues
> diff --git a/docs/releases/index.rst b/docs/releases/index.rst
> index 8ddaafb2c938..94eeb01b8fce 100644
> --- a/docs/releases/index.rst
> +++ b/docs/releases/index.rst
> @@ -8,6 +8,7 @@ on the release process, refer to :doc:`/development/releasing`.
>     :maxdepth: 2
>  
>     /releases/unreleased
> +   /releases/extra-special-ozlabs-edition
>     /releases/dazzle
>     /releases/cashmere
>     /releases/burlap