Open Stack

Hi,

When I mentioned the stable branches my intention was only to highlight that when the doc lives together with the code, we have the benefit of capturing the state for the OpenStack releases as opposed to the API versions. By this sense, if we would have an API freeze, which would let us auto-generating and polishing up the docs, then we could have a stable version before cutting the stable branch. This could be handled like the code and have backported fixes, if something is still not covering the truth, but that should not happen too often if at all.

Best Regards,
Ildiko

-----Original Message-----
From: Jeremy Stanley [mailto:fungi at yuggoth.org] 
Sent: May 08, 2015 15:43
To: openstack-docs at lists.openstack.org
Subject: Re: [OpenStack-docs] Autogenerate the API Reference

On 2015-05-08 08:06:23 -0500 (-0500), Anne Gentle wrote:
> Right, but the counterpoint is that docs are supposed to document 
> final state and truth, and by scraping during a non-final dev time 
> period, the docs won't themselves be stable. So that's where the 
> difficulty lies. :)

Much like we have a string freeze for the benefit of translators and a requirements freeze for the benefit of package maintainers, perhaps we need an API freeze for the benefit of documentation authors (or in this case those wrangling the scrapers at least).
--
Jeremy Stanley

_______________________________________________
OpenStack-docs mailing list
OpenStack-docs at lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs