Git plugin ?

classic Classic list List threaded Threaded
7 messages Options
Reply | Threaded
Open this post in threaded view
|

Git plugin ?

Yves Moisan
Hi All,

I am new to XWiki and I was wondering if some users use XWiki as a
documentation engine for software projects in general.  The case I have
in mind is that we want to provide our software documentation to our
customers as XWiki pages.  I'm quite fond of Sphinx
(http://sphinx-doc.org/) and I very much like the idea of being able to
set up a bunch of files (in the case os Sphinx reStructuredText text
files) and have them versioned in the revision control system we use for
our code.  I thought I could set up a similar file structure with XWiki
2.1 text files and have them versioned as a function of language and
(our) software version.

So the question : does anyone know of a Git plugin akin to the existing
SVN Application
(http://extensions.xwiki.org/xwiki/bin/view/Extension/SVN+Application)
?  I tried setting up the SVN plugin yesterday by testing on a local SVN
and I didn't succeed.  I figured the reason is that we have Enterprise
XWiki 5.2 and the plugin mentions it's been tested with version 6.0.1
but before I try harder I'd prefer if there would be a Git plugin since
we're transitioning over to Git.

Also, I know the idea of keeping versions separate from XWiki's own
versioning story seems odd, but I still find a justification for a
revision control system level versioning.  The rationale behind the
development of the SVN Application rings a bell to me : "Allows
concurrent development on multiple servers and simplifies publishing
XWiki applications".

TIA,

Yves Moisan

P.S. I scanned the mailing list archives up to Dec 2012 and din't find
anything.
_______________________________________________
users mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/users
Reply | Threaded
Open this post in threaded view
|

Re: Git plugin ?

jerem
Hi,

Not exactly what you want, but did you have a look at the Github App [1] ?
It seems similar to the SVN App.

BR,
Jeremie

[1] -
http://extensions.xwiki.org/xwiki/bin/view/Extension/XWiki+Application+-+GitHub+App

2014-10-22 21:32 GMT+02:00 Yves Moisan <[hidden email]>:

> Hi All,
>
> I am new to XWiki and I was wondering if some users use XWiki as a
> documentation engine for software projects in general.  The case I have in
> mind is that we want to provide our software documentation to our customers
> as XWiki pages.  I'm quite fond of Sphinx (http://sphinx-doc.org/) and I
> very much like the idea of being able to set up a bunch of files (in the
> case os Sphinx reStructuredText text files) and have them versioned in the
> revision control system we use for our code.  I thought I could set up a
> similar file structure with XWiki 2.1 text files and have them versioned as
> a function of language and (our) software version.
>
> So the question : does anyone know of a Git plugin akin to the existing
> SVN Application (http://extensions.xwiki.org/xwiki/bin/view/Extension/SVN+
> Application) ?  I tried setting up the SVN plugin yesterday by testing on
> a local SVN and I didn't succeed.  I figured the reason is that we have
> Enterprise XWiki 5.2 and the plugin mentions it's been tested with version
> 6.0.1 but before I try harder I'd prefer if there would be a Git plugin
> since we're transitioning over to Git.
>
> Also, I know the idea of keeping versions separate from XWiki's own
> versioning story seems odd, but I still find a justification for a revision
> control system level versioning.  The rationale behind the development of
> the SVN Application rings a bell to me : "Allows concurrent development on
> multiple servers and simplifies publishing XWiki applications".
>
> TIA,
>
> Yves Moisan
>
> P.S. I scanned the mailing list archives up to Dec 2012 and din't find
> anything.
> _______________________________________________
> users mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/users
>
_______________________________________________
users mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/users
Reply | Threaded
Open this post in threaded view
|

Re: Git plugin ?

Yves Moisan
Hi Jérémie,

Yes I saw that extension.  I was hoping to find an equivalent for the
more general case of a git repo, but if that doesn't exist we'll see if
we want the feature bad enough to dig into the extension code and see
how we can tweak it to an arbitrary git repo.

Thanx!

Yves

Le 2014-10-23 03:41, Jeremie BOUSQUET a écrit :

> Hi,
>
> Not exactly what you want, but did you have a look at the Github App [1] ?
> It seems similar to the SVN App.
>
> BR,
> Jeremie
>
> [1] -
> http://extensions.xwiki.org/xwiki/bin/view/Extension/XWiki+Application+-+GitHub+App

_______________________________________________
users mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/users
Reply | Threaded
Open this post in threaded view
|

Re: Git plugin ?

Paul Libbrecht-2
Yves,

this is related strongly to the layout of source code for XWiki pages.
It has been discussed over and over but has not come to a final agreement.
I still feel it is not sane to edit the XML files of the xar exports. But that is what most people still do, in that they export it (without looking) into the source trees, and import it.

I still find we need to devise some best practice there.

paul


On 23 oct. 2014, at 14:07, Yves Moisan <[hidden email]> wrote:

> Hi Jérémie,
>
> Yes I saw that extension.  I was hoping to find an equivalent for the more general case of a git repo, but if that doesn't exist we'll see if we want the feature bad enough to dig into the extension code and see how we can tweak it to an arbitrary git repo.
>
> Thanx!
>
> Yves
>
> Le 2014-10-23 03:41, Jeremie BOUSQUET a écrit :
>> Hi,
>>
>> Not exactly what you want, but did you have a look at the Github App [1] ?
>> It seems similar to the SVN App.
>>
>> BR,
>> Jeremie
>>
>> [1] -
>> http://extensions.xwiki.org/xwiki/bin/view/Extension/XWiki+Application+-+GitHub+App
>
> _______________________________________________
> users mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/users

_______________________________________________
users mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/users
Reply | Threaded
Open this post in threaded view
|

Re: Git plugin ?

Yves Moisan
Hi Paul,

I thought the markup files (XWiki pages == markup files ?) alone were
versioned -- at least that's how I figured the SVN Application plugin
worked.  I was thinking something along the lines of what ReadTheDocs
offers for GitHub users, that is automatic build of the documentation
upon a change in markup )in taht case markdown or reStructuredText),
only in the case of XWiki I thought just updating the source underneath
would automagically render in HTML upon page refresh, sort of.

I realize I need to understand a bit more on how XWiki works.

Thanx for your input,

Yves

> Yves,
>
> this is related strongly to the layout of source code for XWiki pages.
> It has been discussed over and over but has not come to a final agreement.
> I still feel it is not sane to edit the XML files of the xar exports. But that is what most people still do, in that they export it (without looking) into the source trees, and import it.
>
> I still find we need to devise some best practice there.
>
> paul

_______________________________________________
users mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/users
Reply | Threaded
Open this post in threaded view
|

Re: Git plugin ?

jerem
In fact, when you export an xwiki page (to export a .xar file, or to put
this page under source control, etc), it is represented as an .xml file.
This file contains the markup (in any syntax chosen for the page), and some
other information, like author, dates, other xwiki stuff possibly
(xobjects, xclass etc) that may not interest you at first.
Concept is that you can then re-import this xml file in any xwiki instance,
and it will create the exact same page you exported. Usually we put a
number of those files in a .xar file, allowing to import or export a bunch
of pages at once.

What propose the SVN and the Github apps, are ways to synchronize your wiki
pages, from your running xwiki instance on one side, and a github or svn
repo on the other side (under the form of those .xml files).
As far as I know, this synchronization is not automatic:
- when you click "commit", it will push changes from the running xwiki
instance to source control - if you set a CI server watching modifications
of source control, you can rebuild upon a change in markup in a page
- when you click "update", it will pull changes from source control into
running xwiki instance - if you refresh a page for which .xml was changed
and pulled, html of course is refreshed.

I don't know much more as I never used those apps, so please extension
creators correct me if I'm wrong :)

About editing directly those exported .xml files : it is possible but not
recommended as format is not so readable, some parts are binary, and others
are xml-encoded (so if you forget to xml-encode your modifications, you
generate pages impossible to import back in xwiki).

Hope this helps,
Jeremie



2014-10-23 15:21 GMT+02:00 Yves Moisan <[hidden email]>:

> Hi Paul,
>
> I thought the markup files (XWiki pages == markup files ?) alone were
> versioned -- at least that's how I figured the SVN Application plugin
> worked.  I was thinking something along the lines of what ReadTheDocs
> offers for GitHub users, that is automatic build of the documentation upon
> a change in markup )in taht case markdown or reStructuredText), only in the
> case of XWiki I thought just updating the source underneath would
> automagically render in HTML upon page refresh, sort of.
>
> I realize I need to understand a bit more on how XWiki works.
>
> Thanx for your input,
>
> Yves
>
>  Yves,
>>
>> this is related strongly to the layout of source code for XWiki pages.
>> It has been discussed over and over but has not come to a final agreement.
>> I still feel it is not sane to edit the XML files of the xar exports. But
>> that is what most people still do, in that they export it (without looking)
>> into the source trees, and import it.
>>
>> I still find we need to devise some best practice there.
>>
>> paul
>>
>
> _______________________________________________
> users mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/users
>
_______________________________________________
users mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/users
Reply | Threaded
Open this post in threaded view
|

Re: Git plugin ?

Yves Moisan
Thanx Jérémie.  I appreciate your taking the time to explain the
mechanisms involved.  We do indeed have a CI server (Jenkins) that we
could use.  I understand the xml comprises the markup and the page
metadata (author, history, etc.) and that is what is versioned or
versionable.

Cheers,

Yves

> In fact, when you export an xwiki page (to export a .xar file, or to put
> this page under source control, etc), it is represented as an .xml file.
> This file contains the markup (in any syntax chosen for the page), and some
> other information, like author, dates, other xwiki stuff possibly
> (xobjects, xclass etc) that may not interest you at first.
> Concept is that you can then re-import this xml file in any xwiki instance,
> and it will create the exact same page you exported. Usually we put a
> number of those files in a .xar file, allowing to import or export a bunch
> of pages at once.
>
> What propose the SVN and the Github apps, are ways to synchronize your wiki
> pages, from your running xwiki instance on one side, and a github or svn
> repo on the other side (under the form of those .xml files).
> As far as I know, this synchronization is not automatic:
> - when you click "commit", it will push changes from the running xwiki
> instance to source control - if you set a CI server watching modifications
> of source control, you can rebuild upon a change in markup in a page
> - when you click "update", it will pull changes from source control into
> running xwiki instance - if you refresh a page for which .xml was changed
> and pulled, html of course is refreshed.
>
> I don't know much more as I never used those apps, so please extension
> creators correct me if I'm wrong :)
>
> About editing directly those exported .xml files : it is possible but not
> recommended as format is not so readable, some parts are binary, and others
> are xml-encoded (so if you forget to xml-encode your modifications, you
> generate pages impossible to import back in xwiki).
>
> Hope this helps,
> Jeremie
>

_______________________________________________
users mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/users