Wiki source code of XWiki Contrib
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}}{{toc start="2" depth="3"/}}{{/box}} | ||
| 2 | |||
| 3 | The **XWiki Contrib Project** provides hosting for projects related to XWiki. These projects are not part of the official XWiki distributions and are not maintained by the XWiki development team. | ||
| 4 | |||
| 5 | == Hosting tools == | ||
| 6 | |||
| 7 | The project hosting forge can provide contributors with some or all of the following tools : | ||
| 8 | * A **SVN directory**, under http://svn.xwiki.org/svnroot/xwiki/contrib/ | ||
| 9 | * A **JIRA project** for tracking bugs and feature requests, at http://jira.xwiki.org/ and under the "XWiki Contributed projects" category. Note that there will be a generic JIRA project to be used by all projects till they achieve a first release or till they grow to a size significant enough to warrant a dedicated JIRA project | ||
| 10 | * A generic **maven groupId** : ##org.xwiki.contrib## | ||
| 11 | * **Project pages** on xwiki.org sites to describe and document the project. ((( | ||
| 12 | {{info}}Our long term objective is to make all projects documentation accessible from http://code.xwiki.org, though the content from code.xwiki.org should be aggregated from the various XWiki sites : platform.xwiki.org for the XWiki platform's modules, contrib.xwiki.org for contributed projects, etc. | ||
| 13 | |||
| 14 | For the time being and until we perform that restructuration of code.xwiki.org, projects from the XWiki Contrib project can be documented in two places : | ||
| 15 | * On a page on code.xwiki.org, **only if** the project has been already made available for download here (i.e., has been released at least once). | ||
| 16 | * On a dedicated space on contrib.xwiki.org for other projects.{{/info}} | ||
| 17 | ))) | ||
| 18 | |||
| 19 | == Requesting a project == | ||
| 20 | |||
| 21 | The contrib project is open for anyone with a project that request it. Simply send us an email at **##devs AT xwiki.org##** using "**[Contrib]**" at the beginning of your email's subject. Let us know the name and a short description of your project. If your project has already been made available for download on code.xwiki.org, please precise it and point us to its page (If it is not, then no need to hurry, you will make it available once it's ready). Finally, let us know which of the listed tools you need. For SVN access, you will need to register a user on http://www.xwiki.org with a UNIX-like user name, and let us know about it. Such a username is composed of the first letter of your first name immediately followed by your last name, the whole with no capital letter (for example **jdoe** if your name is John Doe). We will get back to you shortly with all the information you need. | ||
| 22 | |||
| 23 | == SVN organization == | ||
| 24 | |||
| 25 | The **contrib** SVN directory (in XWiki's SVN repository) is organized with the following structure : | ||
| 26 | |||
| 27 | ## {{{ http://svn.xwiki.org/svnroot/xwiki/contrib/ | ||
| 28 | |__people/ | ||
| 29 | |__projects/ | ||
| 30 | |__retired/ | ||
| 31 | |__sandbox/ }}} ## | ||
| 32 | |||
| 33 | Each of the sub-directory has the following meaning : | ||
| 34 | |||
| 35 | * **people** is a directory for "personal tests" projects. The idea is behind is to give whoever requests it a personal space where he can experiment with XWiki code, and that space is private (i.e. an implied rule is that people are not supposed to commit code in others projects, thus making it different from sandbox projects). Each sub-folder of people/ is composed of the username of the person that requests his project, for example "jvelociter". | ||
| 36 | * **projects** hosts the actual contrib projects, that are active (meaning that they still do make sense as projects in | ||
| 37 | the XWiki ecosystem, they are not abandoned, etc.) | ||
| 38 | * **retired** is the "place where dead project go ;(" A dead project can be a project that get superseded by a newer one, or a project that is not actively maintained for a long period of time. | ||
| 39 | * **sandbox** is the place for experimental projects that have not been released. |
