[xwiki-dev] [Idea] SVN bridge

[Vincent Massol]

> -----Original Message-----
> From: jeremi23 at gmail.com [mailto:jeremi23 at gmail.com] On Behalf Of
> jeremi joslin
> Sent: lundi 13 novembre 2006 11:19
> To: xwiki-dev at objectweb.org
> Subject: Re: [xwiki-dev] [Idea] SVN bridge
> 
> Hi ,
> why do you need this? Why not just doing a backup?

Use cases:

* Ability to version xwiki contents in the svn next to the code. Capability to tag/branch both at the same time
* Ability to work in my favorite IDE and do a refactoring on code and automatically modify documentation referencing the modified code (class names, method names, etc)
* Ability for contributors to submit patches WITH documentation!
* Ability to have tracability from requirements (JIRA issues) to documentation. This is what we currently have with the code when we commit and enter a JIRA issue # reference in the commit. It would be nice not to consider documentation as a separate entity that is not controlled. This reminds me of tests. Not long ago people were considering tests as something separate to the activity of coding... Well with a wiki as a documentation tool the same is happening now and that's not good...

Basically it's about combining the best of the 2 worlds:
* SVN for versioning and having doc and code in sync
* Wiki for easy edition/creation/contribution

The backup solution doesn't solve these needs. And moreover SVN or SCM in general are not for backups... It's better to use a simple filesystem/tap/whatever for backups. This is what I currently do for cargo: code and doc are manually synchronized when we do releases. At that point in time we do an export of the doc and put it in the download area next to the code distribution. But funnily it's preventing documentation contributions as users cannot submit patches for documentation along with their code patches. And documentation updates always lag behind code update (they're not done at the same time). 
 
> One think we were thinking is adding to the export plugin the ability
> to export the pages to an svn.
>
> For implementing this, give a look ate the store package. As far as I
> remember we can chain the storage objects. For example, the first store
> is the cache and the second is hibernate. I think it's possible to
> insert the svn here.

Ok I'll have a look.

Thanks
-Vincent

 
> On 11/13/06, Vincent Massol <vincent at massol.net> wrote:
> > Hi,
> >
> > Here's something I would be keen to implement: a XWiki/SVN bridge.
> > Imagine the following:
> >
> > * You edit a page on the wiki and when you click on save, xwiki saves
> > the content to SVN in addition to saving it to the xwiki database
> > * On the user profile page, we add 2 new fields: svn username and svn
> > password. This is used when doing the save/commit.
> > * We put a "svn update" button in the available actions for each
> page.
> > We could also do that at the level of the space/wiki
> > * If SVN says there's a conflict then we tell the user, do a merge
> and
> > put the resulting merge inside the edit window and ask the user to
> sort it out.
> > The user has to click on save again to save it.
> > * We create a scheduling job (we are using the quartz scheduler,
> > right?) to update the space/wiki every few hours (say 2 hours) by
> > loading the content from svn for each page and saving it as the new
> > content. Question: is this going to work? Is it possible that some
> > pages would need to be updated in the correct order for it work, in
> > which case the only solution would be a bulk update?
> >
> > Technical details:
> > * We use JavaSVN
> > * We use the low level API of JavaSVN (the one that doesn't use a
> > workspace).
> >
> > WDYT?
> >
> > Could someone point to me where is the xwiki code where we would need
> > to insert the SVN commit code so that I can have a look at it?
> >
> > Thanks
> > -Vincent
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> ______________________________________________________________________
> > _____ Découvrez une nouvelle façon d'obtenir des réponses à toutes
> vos
> > questions !
> > Profitez des connaissances, des opinions et des expériences des
> > internautes sur Yahoo! Questions/Réponses http://fr.answers.yahoo.com
> >
> >
> >
> >
> > --
> > You receive this message as a subscriber of the xwiki-
> dev at objectweb.org mailing list.
> > To unsubscribe: mailto:xwiki-dev-unsubscribe at objectweb.org
> > For general help: mailto:sympa at objectweb.org?subject=help
> > ObjectWeb mailing lists service home page:
> > http://www.objectweb.org/wws
> >
> >
> >
> 
> 
> --
> jeremi






___________________________________________________________________________
Découvrez une nouvelle façon d'obtenir des réponses à toutes vos questions !
Profitez des connaissances, des opinions et des expériences des internautes sur Yahoo! Questions/Réponses
http://fr.answers.yahoo.com