<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Fri, May 2, 2014 at 2:21 AM, Andreas Jaeger <span dir="ltr"><<a href="mailto:aj@suse.com" target="_blank">aj@suse.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="HOEnZb"><div class="h5">On 05/02/2014 09:07 AM, Tom Fifield wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Hi,<br>
<br>
Related to our critical Bug #1191447: Clearly mark outdated doc pages,<br>
I have proposed a new blueprint for Juno<br>
<br>
"Add release version to config reference options"<br>
<br>
<a href="https://blueprints.launchpad.net/openstack-manuals/+spec/add-release-version-to-config-reference-options" target="_blank">https://blueprints.launchpad.<u></u>net/openstack-manuals/+spec/<u></u>add-release-version-to-config-<u></u>reference-options</a><br>
<br>
<br>
The continuously published configuration reference contains tables with<br>
information about all configuration options in OpenStack.<br>
<br>
Currently, these tables are updated from master, and always have the<br>
latest information in them.<br>
<br>
However, there continues to be users of older releases who still need<br>
reference information for their configuration options.<br>
<br>
The toolchain used to generate the tables is able to operate on any git<br>
repository checkout, meaning it can also generate historical tables.<br>
<br>
This blueprint proposes to automatically provide some form of release<br>
information with the configuration option by comparing the options<br>
generated from two different repositories.<br>
<br>
For example<br>
* an option that appears in a Havana repository, but does not appear in<br>
an Icehouse repository was deprecated in Havana.<br>
* an option that does not exist in Grizzly, but appears in Havana is a<br>
new option to Havana<br>
<br>
These sort of cases should then be communicated to the reader. A<br>
selection between three potential forms for this information are envisaged:<br>
1. tables are updated with an additional column that provides release<br>
information (eg "available from Icehouse onwards", "deprecated in Essex")<br>
2. a table of "new and removed" options between Icehouse and Juno is<br>
added as an appendix<br>
3. the configuration reference is branched for the Juno release, with<br>
different versions of the tables in each<br>
</blockquote>
<br></div></div>
We do branch the configuration reference already, so the current version should be Icehouse only - since we haven't branched - and there's a Havana version out as well.<br>
<br>
I like your idea with "new in Icehouse" etc., still I fear the basic problem is that users look at the wrong guide. What triggered your suggestion?<br>
<br>
Do we need to say more prominently "Configuration reference for ICEHOUSE" ?<span class="HOEnZb"><font color="#888888"><br>
<br></font></span></blockquote><div><br></div><div>Yep, as Andreas said, we do this already but just haven't yet for Icehouse.</div><div><br></div><div>Let us know the root cause of the request.</div><div><br></div><div>
Thanks,</div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><span class="HOEnZb"><font color="#888888">
Andreas<br>
-- <br>
Andreas Jaeger aj@{<a href="http://suse.com" target="_blank">suse.com</a>,<a href="http://opensuse.org" target="_blank">opensuse.org</a>} Twitter/Identica: jaegerandi<br>
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br>
GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)<br>
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126</font></span><div class="HOEnZb"><div class="h5"><br>
<br>
______________________________<u></u>_________________<br>
Openstack-docs mailing list<br>
<a href="mailto:Openstack-docs@lists.openstack.org" target="_blank">Openstack-docs@lists.<u></u>openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/<u></u>cgi-bin/mailman/listinfo/<u></u>openstack-docs</a><br>
</div></div></blockquote></div><br></div></div>