I can see having something akin to the Postgresql release notes: http://www.postgresql.org/docs/8.4/static/release-8-4.html
This contains Overview, Migration, and Change details. We might also consider using the Jira release notes functionality as a starting point for those types of docs. On Mon, Jul 20, 2009 at 11:57 AM, Chris Chabot <[email protected]> wrote: > As we get into the habit of releases, having a wiki / site page somewhere > with "What's new in this release" might be a good idea, that seems the best > place to me to mention what incompatible changes happened. > > Considering there's a nice batch changes including "hey here's a bunch of > OS template xml files you could customize for your site", "you could also > support cache invalidation now" and lots of other such goodies, I actually > think having such a page per release would be a very good idea :) > > > On Mon, Jul 20, 2009 at 7:33 PM, Adam Winer <[email protected]> wrote: > >> Do we have a good way to do that? How 'bout a Wiki page of "recent >> incompatible changes that won't be caught by compiling"? Or an SVN >> .txt file of the same (so developers can do svn diff >> -r<OldVersion>:<NewVersion> etc/incompatibilities.txt). >> >> On Mon, Jul 20, 2009 at 9:53 AM, <[email protected]> wrote: >> > lgtm -- one thing I would do is to insure that we communicate this >> > change to implementers to avoid upgrade breakage. >> > >> > >> > >> > >> > http://codereview.appspot.com/95071 >> > >> > >
