<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Feb 26, 2016 at 11:17 AM, Sean McGinnis <span dir="ltr"><<a href="mailto:sean.mcginnis@gmx.com" target="_blank">sean.mcginnis@gmx.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 Fri, Feb 26, 2016 at 09:03:49AM -0600, Brant Knudson wrote:<br>
> On Fri, Feb 26, 2016 at 6:34 AM, Doug Hellmann <<a href="mailto:doug@doughellmann.com">doug@doughellmann.com</a>><br>
> wrote:<br>
><br>
> > I've had a few conversations recently about "appropriate" content for<br>
> > release notes, so I thought it was worth starting a separate thread here<br>
> > to clarify.<br>
> ><br>
> > We have 3 potential audiences for release notes:<br>
> ><br>
> > 1. Developers consuming libraries or other code directly.<br>
> > 2. Deployers and operators.<br>
> > 3. End-users.<br>
> ><br>
> > We implemented reno for this cycle to replace the old wiki-based<br>
> > system for writing release notes for deployers, operators, and<br>
> > end-users. We have in-tree developer documentation for Developers. The<br>
> > two sets of documentation are meant for different purposes, so we need<br>
> > to think about what information we publish in each.<br>
> ><br>
> > As you are writing release notes using reno to be published under<br>
> > <a href="http://docs.openstack.org/releasenotes" rel="noreferrer" target="_blank">docs.openstack.org/releasenotes</a>, please keep in mind the audience<br>
> > is *not* someone who is necessarily going to be looking at code or<br>
> > writing apps based on libraries we produce. Highlight information<br>
> > that deployers and operators will need, like changes to configuration<br>
> > options or service behaviors. Describe REST API changes that an<br>
> > end-user may need to know about.<br>
> ><br>
> ><br>
> python-keystoneclient doesn't provide config options, so there should never<br>
> be release notes for it. Probably best to disable releasenote generation<br>
> for most of the python-*client libraries.<br>
<br>
</div></div>I actually see value in having the release notes for the client<br>
libraries. Not always, but occasionally functionality gets merged in the<br>
service but not added to the client in time. Having release notes for<br>
exposing new functionality can make it easier to scan through notes to<br>
find the supported version you need.<br>
<br>
I can see valid arguments on either side of the argument though.<br></blockquote><div><br></div><div>I could be wrong but I don't think the recommendation was to not have release notes for libraries. I think the intent is to not make part of the service release notes some internal API changes.</div><div><br></div><div>Ultimatedly, I think the general recommendation is "Know your audience". Avoiding getting to much into the technical details of a change is normally better. People interested in the internal details of a change will likely find that information elsewhere. For everyone else, there are release notes that should be informative enough and contain relevant information for their deployments, upgrades, security, etc.</div><div><br></div><div>Flavio</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
><br>
> -- Brant<br>
<div class="HOEnZb"><div class="h5"><br>
> __________________________________________________________________________<br>
> OpenStack Development Mailing List (not for usage questions)<br>
> Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.openstack.org?subject:unsubscribe</a><br>
> <a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br>
<br>
__________________________________________________________________________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.openstack.org?subject:unsubscribe</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
</div></div></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><span style="font-size:12.8px">@flaper87</span><br></div><div>Flavio Percoco</div><div><br></div></div></div></div></div>
</div></div>