Hi Mark, Actually, if JIRA went down we'd still have a static copy of that History page available in the PDF/HTML we will be generating off of the Wiki content.
So, we'd have this same History/Changes information in several places: (1) The Wiki Documentation (dynamically generated): https://wiki.duraspace.org/display/DSDOC/History (2) The PDF & HTML copy of #1, generated for each release. This would be a 'snapshot' of that dynamic History page at the point when the PDF/HTML was created. This PDF/HTML would be available for download off dspace.org, and would likely also be stored in the SVN tag, e.g. http://scm.dspace.org/svn/repo/dspace/tags/dspace-1.7.0-rc1/dspace/docs/ We could still continue to create a CHANGES file via Maven. But, in reality, this Maven-built CHANGES file would just contain the same contents as the PDF & HTML copy created via the Wiki. Since it's not a ton of work to generate via Maven, maybe that's OK to keep this information in multiple places. Alternatively, we could also just state in the CHANGES file that the changelog is available both on the Wiki and in the PDF/HTML copy in SVN. Just another idea to throw out there. - Tim On 11/19/2010 1:36 PM, Mark Diggory wrote: > My only concern with (2) is that the list is generated dynamically and > if the service goes away, so does the list. > > Maven does support generating CHANGES files from JIRA on release, I > would advice we make updating the CHANGES file part of the release > process and implement the maven plugin to create it. > > Mark > > On Fri, Nov 19, 2010 at 11:17 AM, Sands Alden Fish<[email protected]> wrote: >> +1 on #2. It'd be nice to have some connection remain between the code you >> check out and the related documentation. I suppose you could also add in a >> list of the major feature additions for the current release there, but I >> imagine you could just learn that from getting to the wiki/JIRA. >> >> -- >> sands fish >> Senior Software Engineer >> MIT Libraries >> Technology Research& Development >> [email protected] >> E25-131 >> >> >> >> >> On Nov 18, 2010, at 11:31 AM, Tim Donohue [email protected] wrote: >> >> All, >> >> As we now are tracking all issues via JIRA and are going to be releasing >> our Documentation via Confluence (which integrates well with JIRA), I'm >> beginning to wonder whether we need to continue to maintain a CHANGES >> file in SVN: >> >> http://scm.dspace.org/svn/repo/dspace/trunk/dspace/CHANGES >> >> In preparation for 1.7.0 release, I've recently updated our new >> "History" page in our Wiki Docs to automatically query for all 1.7.0 >> fixed issues in JIRA. This essentially provides a very similar list to >> what we have been maintaining in the CHANGES file. But, now it is >> automated, based on JIRA issues which are closed/resolved for 1.7.0: >> >> https://wiki.duraspace.org/display/DSDOC/History >> >> So, I thought I'd ask to see if anyone feels strongly about continuing >> to maintain the CHANGES file. There are a few options going forward: >> (1) Continue to maintain CHANGES file in parallel to this new History page. >> (2) Keep the CHANGES file in SVN, but replace all its contents with just >> a link to 'History' page in the Wiki Documentation. >> (3) Remove the CHANGES file from SVN entirely, as the changes/history >> are now tracked automatically in the Wiki docs. >> >> I am beginning to lean more and more towards #2. But, if others feel >> strongly about continuing to maintain the CHANGES file, we can do so. >> >> What do you think? >> >> - Tim >> >> ------------------------------------------------------------------------------ >> Beautiful is writing same markup. Internet Explorer 9 supports >> standards for HTML5, CSS3, SVG 1.1, ECMAScript5, and DOM L2& L3. >> Spend less time writing and rewriting code and more time creating great >> experiences on the web. Be a part of the beta today >> http://p.sf.net/sfu/msIE9-sfdev2dev >> _______________________________________________ >> Dspace-devel mailing list >> [email protected] >> https://lists.sourceforge.net/lists/listinfo/dspace-devel >> >> >> ------------------------------------------------------------------------------ >> Beautiful is writing same markup. Internet Explorer 9 supports >> standards for HTML5, CSS3, SVG 1.1, ECMAScript5, and DOM L2& L3. >> Spend less time writing and rewriting code and more time creating great >> experiences on the web. Be a part of the beta today >> http://p.sf.net/sfu/msIE9-sfdev2dev >> _______________________________________________ >> Dspace-devel mailing list >> [email protected] >> https://lists.sourceforge.net/lists/listinfo/dspace-devel >> >> > > > ------------------------------------------------------------------------------ Beautiful is writing same markup. Internet Explorer 9 supports standards for HTML5, CSS3, SVG 1.1, ECMAScript5, and DOM L2 & L3. Spend less time writing and rewriting code and more time creating great experiences on the web. Be a part of the beta today http://p.sf.net/sfu/msIE9-sfdev2dev _______________________________________________ Dspace-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/dspace-devel
