On 05/18/2012 03:45 AM, Marius Dumitru Florea wrote: > On Wed, Sep 28, 2011 at 8:28 AM, Vincent Massol <[email protected]> wrote: >> Hi devs, >> >> Sergiu has started a script to fully automate a release (more to come - >> Sergiu will document what it does soon). The only part not automated are the >> Release Notes. >> >> IMO we can "automate" it by a process which I propose to be: >> >> * An issue can only be closed if it's documented on xwiki.org and on the >> release notes page for the upcoming release. >> * We collectively enforce this by reopening issues if someone doesn't do the >> first point, asking him/her to do it > > I'm not convinced this is enough. If each of us documents everything > we work on on the release notes we'll probably end up with a huge page > with mixed technical and non-technical content marking it harder for > different types of users to find the relevant information. I think we > still need a "filter" (the release manager IMO) to decide what's worth > mentioning (leave it or not in the release notes) and in which > quantity (maybe a single phrase is enough and not 3 paragraphs). > > +0, I'm entirely for documenting my own work on the release notes but > I don't believe this will "automatically" create the release notes.
This is a very good point, I agree that the developer's notes need to be proof read by someone (the RM?) and unimportant changes which "seemed important at the time" should be paired out. It might be nice to foster a competitive spirit to see whose features make the final cut of the release notes since I, as much as anyone, need to work on making my patches more relevant to the user. Caleb > > Thanks, > Marius > >> >> This will have some nice effects: >> * xwiki.org will be more up to date than it is now >> * it's up to the developer to document what they do (I don't think it's good >> to push this to someone else) which is good since they have the most >> knowledge (side note: it doesn't mean we don't need a technical writer to >> improve on the documentation done by developers but it would be about style >> and not about content) >> * the release notes will be ready for the release, as we progress and the >> burden of writing the release notes will not fall on the shoulders of the >> Release Manager (there's no reason it should) >> * the whole release process will almost be a joy to do >> * with a fully automated release process it means we'll be able to perform a >> lot more bugfix releases which is good for our users >> >> Here's my +1 >> >> Thanks >> -Vincent >> >> >> _______________________________________________ >> devs mailing list >> [email protected] >> http://lists.xwiki.org/mailman/listinfo/devs > _______________________________________________ > devs mailing list > [email protected] > http://lists.xwiki.org/mailman/listinfo/devs > _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
