All,

I feel like we're jumping the gun here.  I wouldn't recommend rushing to 
move to Confluence-based documentation/manual for 1.6 release, as we are 
already so late in the game (and I'd hate to delay anything further). 
Plus, Jeff has got a good process going for DocBook right now, and I 
really don't want to pull the rug out on that process at the last moment.

That all being said, Mark D, I appreciate your proof of concept work 
that we can get the Documentation into Confluence relatively easily.

As a bit of background on all this Confluence talk to the Developers out 
there.  DuraSpace is currently investigating migrating the DSpace Wiki 
from MediaWiki over to Confluence  (expect to see more announcements 
about this shortly).  There are a variety of benefits we see in moving 
to Confluence:
* Able to edit using a basic Word-like interface (WYSIWYG interface)
* Able to export pages to Word/PDF
* Support for simple diagrams
* Capable of supporting the DSpace manual natively to ease editing and 
contributing
* Better integration into existing DuraSpace.org infrastructure

You'll notice one of those listed is to potentially pull in the DSpace 
Manual to Confluence to ease editing/contributing.  I think it's great 
that Mark D has been able to prove we can get the Documentation into 
Confluence without too much hassle.  But, I feel we need to have more 
discussion (likely after 1.6) around how we'd all like to manage the 
Documentation in the longer term.

Let me know if there are any comments/questions/input on any of this. 
We can also discuss this more in our Developers Meeting on Weds (though, 
again, it'd be best to concentrate on getting 1.6 finished up before we 
dig too deep into DocBook vs. Confluence for the longer term).

- Tim

On 1/5/2010 2:13 AM, Mark Diggory wrote:
> 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
>>
>
>
>

------------------------------------------------------------------------------
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

Reply via email to