<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Sep 5, 2014 at 5:27 AM, Steven Hardy <span dir="ltr"><<a href="mailto:shardy@redhat.com" target="_blank">shardy@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><span class="">On Fri, Sep 05, 2014 at 03:56:34PM +1000, Angus Salkeld wrote:<br>
>    On Fri, Sep 5, 2014 at 3:29 PM, Gauvain Pocentek<br>
>    <<a href="mailto:gauvain.pocentek@objectif-libre.com">gauvain.pocentek@objectif-libre.com</a>> wrote:<br>
><br>
>      Hi,<br>
><br>
>      A bit of background: I'm working on the publication of the HOT resources<br>
>      reference on <a href="http://docs.openstack.org" target="_blank">docs.openstack.org</a>. This book is mostly autogenerated from<br>
>      the heat source code, using the sphinx XML output. To avoid publishing<br>
>      several references (one per released version, as is done for the<br>
>      OpenStack config-reference), I'd like to add information about the<br>
>      support status of each resource (when they appeared, when they've been<br>
>      deprecated, and so on).<br>
><br>
>      So the plan is to use the SupportStatus class and its `version`<br>
>      attribute (see <a href="https://review.openstack.org/#/c/116443/" target="_blank">https://review.openstack.org/#/c/116443/</a> ). And the<br>
>      question is, what information should the version attribute hold?<br>
>      Possibilities include the release code name (Icehouse, Juno), or the<br>
>      release version (2014.1, 2014.2). But this wouldn't be useful for users<br>
>      of clouds continuously deployed.<br>
><br>
>      From my documenter point of view, using the code name seems the right<br>
>      option, because it fits with the rest of the documentation.<br>
><br>
>      What do you think would be the best choice from the heat devs POV?<br>
><br>
>    IMHO it should match the releases and tags<br>
>    (<a href="https://github.com/openstack/heat/releases" target="_blank">https://github.com/openstack/heat/releases</a>).<br>
<br>
</span>+1 this makes sense to me.  Couldn't we have the best of both worlds by<br>
having some logic in the docs generation code which maps the milestone to<br>
the release series, so we can say e.g<br>
<br>
"Supported since 2014.2.b3 (Juno)"<br></blockquote><div><br></div><div><br></div><div>I agree with the matching of releases, but let's set expectations for how often it'll be generated. That is to say, each tag is a bit much to ask. I think that even each milestone is asking a bit much. How about each release and include the final rc tag (2014.2?)</div><div><br></div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
This would provide sufficient detail to be useful to both folks consuming<br>
the stable releases and those trunk-chasing via CD?<br>
<br>
Steve<br>
<div class="HOEnZb"><div class="h5"><br>
_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
</div></div></blockquote></div><br></div></div>