Open Stack

On Fri, Sep 05, 2014 at 03:56:34PM +1000, Angus Salkeld wrote:
>    On Fri, Sep 5, 2014 at 3:29 PM, Gauvain Pocentek
>    <gauvain.pocentek at objectif-libre.com> wrote:
> 
>      Hi,
> 
>      A bit of background: I'm working on the publication of the HOT resources
>      reference on docs.openstack.org. This book is mostly autogenerated from
>      the heat source code, using the sphinx XML output. To avoid publishing
>      several references (one per released version, as is done for the
>      OpenStack config-reference), I'd like to add information about the
>      support status of each resource (when they appeared, when they've been
>      deprecated, and so on).
> 
>      So the plan is to use the SupportStatus class and its `version`
>      attribute (see https://review.openstack.org/#/c/116443/ ). And the
>      question is, what information should the version attribute hold?
>      Possibilities include the release code name (Icehouse, Juno), or the
>      release version (2014.1, 2014.2). But this wouldn't be useful for users
>      of clouds continuously deployed.
> 
>      From my documenter point of view, using the code name seems the right
>      option, because it fits with the rest of the documentation.
> 
>      What do you think would be the best choice from the heat devs POV?
> 
>    IMHO it should match the releases and tags
>    (https://github.com/openstack/heat/releases).

+1 this makes sense to me.  Couldn't we have the best of both worlds by
having some logic in the docs generation code which maps the milestone to
the release series, so we can say e.g

"Supported since 2014.2.b3 (Juno)"

This would provide sufficient detail to be useful to both folks consuming
the stable releases and those trunk-chasing via CD?

Steve