FYI we currently have 12 issues closed for 4.1M2 but which don't have Document and Release Notes fields set: http://jira.xwiki.org/secure/IssueNavigator.jspa?mode=hide&requestId=11594
Please fix ASAP. Also, I've set up a jira subscription filter so that xwiki committers will receive every Monday a mail containing this filter as a reminder to fix Documentation/Release notes for closed issues with no documentation/release notes. Reminder: * If an issue doesn't require documentation please use "N/A" or a description as to why it doesn't require doc * If an issue doesn't require documentation in the release notes please use "N/A" or a description as to why it doesn't require to be in the release notes Thanks! Our RM will thank us and the RM job will be nicer! -Vincent On May 19, 2012, at 12:17 PM, Vincent Massol wrote: > > On May 18, 2012, at 5:34 PM, Vincent Massol wrote: > >> >> On May 18, 2012, at 5:31 PM, Vincent Massol wrote: >> >>> So here are the results of this vote: 4 +1, 1 0, no -1 >>> >>> The vote is passed. >>> >>> In order to remind committers to do this systematically I've configured >>> JIRA by adding 2 custom fields to both the default scree and the close >>> screen: >>> * Documentation (text field) - Should contain the link to the doc on >>> xwiki.org. IMPORTANT: If you think there's no need to have any doc for it >>> on xwiki.org, use "N/A" as the value. >>> * Added to Release Notes (radio button) - Set the status >> >> Hmm I'm wondering if we shouldn't use a text field for this too with a field >> name of "Documented in Release Notes". >> This would allow two things: >> 1) Put the link to the release notes (easier to navigate) >> 2) Ability to add some contents as to why it shouldn't go in the RN for >> example. >> >> WDYT? > > I've gone ahead. See: > * http://jira.xwiki.org/browse/XWIKI-7832 > * http://jira.xwiki.org/browse/XWIKI-7839 > > It's cool :) > > Thanks > -Vincent > >> Thanks >> -Vincent >> >>> The idea is that when closing issues we do both, i.e. add documentation on >>> xwiki.org and add it to the release notes for the version in development. >>> Of course this should be done discriminatorily (use your judgment to >>> decide). >>> >>> It's also everyone's duty to remind others when they notice that someone >>> has forgotten to do so. >>> >>> Last, when doing Releases the RM should use a JIRA report listing all fixed >>> issues having those fields not set. >>> >>> Example of using those fields: >>> http://jira.xwiki.org/browse/XWIKI-7832 >>> >>> I'll document this on xwiki.org in the coming hours/days. >>> >>> Thanks >>> -Vincent >>> >>> On Sep 28, 2011, at 7:28 AM, Vincent Massol 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 >>>> >>>> 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
