<div dir="ltr"><br><div class="gmail_extra"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
2) Driver docs may not be backported to stable branches. This is a<br>
stable maintenance policy, not an Ironic policy. This problem is<br>
somewhat unique to Ironic as most major projects have deployer docs in<br>
the Ops guide repo, rather than in the code repo. I'm going to chat with<br>
some docs/stable maintenance people in Tokyo about this, however I also<br>
encourage you to do the same.<br><span class=""><br></span></blockquote><div><br></div><div>I think the issue of updating documentation on stable branches goes beyond driver docs. I question whether we should be bundling the release-related documentation with the code if it is near impossible to update that documentation after a branch is created. For example, we have links to release-related documentation, but they aren't correct. We released 4.2.1 (on stable/liberty branch), and the release notes there [0] don't show release information for 4.2.1. You have to go to master [1] to see it :-(</div><div><br></div><div>How do the other projects do it (correctly), or is ironic the only one so far that has in-tree documentation? It seems that after a stable branch is cut for (some) projects, the docs team has 1 month or so beyond that to get the documentation out. It would be great if the docs we currently maintain in-tree could follow a similar schedule. (And how does the doc team deal with updates to documentation for prior releases?)</div><div><br></div><div>--ruby</div><div><br></div><div>[0] <a href="http://docs.openstack.org/developer/ironic/4.2.1/releasenotes/index.html">http://docs.openstack.org/developer/ironic/4.2.1/releasenotes/index.html</a></div><div>[1] <a href="http://docs.openstack.org/developer/ironic/releasenotes/index.html">http://docs.openstack.org/developer/ironic/releasenotes/index.html</a></div></div></div></div>