Hi all, A few points come to mind:
- What is the benefit of working this new way? - According to the Fedora wiki page you quote, it states that it is a list of documentation issues that need to be taken care of *prior* to the release, not after the release. - I feel quite strongly that working asynchronously would not work. If we're honest, are we really going to come back and fix the documentation, or will we start working on the next release which is much more exciting? - Surely it is better to release complete documentation with the release? If we don't offer full docuentation with a release, users won't be able to make use of the new features. - Releasing complete docs for 1.6 doesn't seem like it will be a problem, so is there actually a problem with the way we are currently working? - A lot of effort (by the fabulous Jeffrey) has been put in to getting the documentation up to scratch for 1.6. A lot of time has gone into issues such as making sure the generated PDF looks good. It feels like a big waste of time to jump to a new documentation method before the current one has seen the light of day. - How do we manage versioning? Would the document end up with hundreds of "in version x you do this, in version y you do that"? Cheers, Stuart ________________________________________ From: Mark Diggory [mdigg...@atmire.com] Sent: Tuesday, 5 January 2010 9:13 p.m. To: DSpace Developers Subject: Re: [Dspace-devel] DSpace Manual In Confluence Note, the Fedora team is utilizing this approach, plus utilizing JIRA to manage a review process for the documentation after the release (asynchronously) as I've suggested would be a better approach to managing the DSpace documentation. http://fedora-commons.org/confluence/display/FCREPO/Fedora+3.3+-+Documentation+Plan Once completely ported to confluence, the docBook content in the SVN would be dropped. Instead at release time, a generated PDF of the current documentation with a reference URL to the WIKI at its beginning would reference the appropriate location to retrieve the most upto date documentation from in the dspace site or WIKI. I've done something similar to their Documentation Plan and embedded the JIRA issues associated with the Documentation into the Home page http://fedora-commons.org/confluence/display/DSTEST Mark On Sun, Jan 3, 2010 at 7:54 PM, Mark Diggory <mdigg...@atmire.com> wrote: > I've also started adding a overview page that will be capable of > supporting downloads of pdf versions as well as details about the > latest releases and recent changes to the documentation. Likewise, > I've added the xslt/maven scripting that generates this to the svn > repository. > > http://fedora-commons.org/confluence/display/DSTEST/Home > > Mark > > On Tue, Dec 29, 2009 at 11:36 AM, Mark Diggory <mdigg...@atmire.com> wrote: >> Dear DSpace Developers (and more specifically Mr. Trimble), >> >> I've completed an experimental conversion of the DSpace Manual to Confluence >> located here. >> >> http://fedora-commons.org/confluence/display/DSTEST/DSpace+System+Documentation >> >> If you create an account we can manage access to edit it directly. But what >> would be good is to verify that all content is getting ported appropriately >> through the conversion, so getting multiple eyes reviewing the documentation >> against the original in: >> >> http://scm.dspace.org/svn/repo/dspace/trunk/dspace/docs >> >> would be beneficial. >> >> Cheers, >> Mark >> >> -- >> Mark R. Diggory >> Head of U.S. Operations - @mire >> >> http://www.atmire.com - Institutional Repository Solutions >> http://www.togather.eu - Before getting together, get t...@ther >> > > > > -- > Mark R. Diggory > Head of U.S. Operations - @mire > > http://www.atmire.com - Institutional Repository Solutions > http://www.togather.eu - Before getting together, get t...@ther > -- Mark R. Diggory Head of U.S. Operations - @mire http://www.atmire.com - Institutional Repository Solutions http://www.togather.eu - Before getting together, get t...@ther ------------------------------------------------------------------------------ This SF.Net email is sponsored by the Verizon Developer Community Take advantage of Verizon's best-in-class app development support A streamlined, 14 day to market process makes app distribution fast and easy Join now and get one step closer to millions of Verizon customers http://p.sf.net/sfu/verizon-dev2dev _______________________________________________ Dspace-devel mailing list Dspace-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/dspace-devel ------------------------------------------------------------------------------ This SF.Net email is sponsored by the Verizon Developer Community Take advantage of Verizon's best-in-class app development support A streamlined, 14 day to market process makes app distribution fast and easy Join now and get one step closer to millions of Verizon customers http://p.sf.net/sfu/verizon-dev2dev _______________________________________________ Dspace-devel mailing list Dspace-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/dspace-devel
