syncope-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1412197 - in /incubator/syncope/branches/1_0_X/parent/src/site: site.xml xdoc/contributing.xml
Date Wed, 21 Nov 2012 17:15:27 GMT
Author: ilgrosso
Date: Wed Nov 21 17:15:26 2012
New Revision: 1412197

Adding an info page about contributing

      - copied, changed from r1411315, incubator/syncope/branches/1_0_X/parent/src/site/xdoc/architecture.xml

Modified: incubator/syncope/branches/1_0_X/parent/src/site/site.xml
--- incubator/syncope/branches/1_0_X/parent/src/site/site.xml (original)
+++ incubator/syncope/branches/1_0_X/parent/src/site/site.xml Wed Nov 21 17:15:26 2012
@@ -42,7 +42,13 @@ under the License.
+  <custom>
+    <fluidoSkin>
+      <leftColumnClass>span2</leftColumnClass>
+      <bodyColumnClass>span10</bodyColumnClass>
+    </fluidoSkin>
+  </custom>
       <item name="Apache" href=""/>
@@ -73,6 +79,7 @@ under the License.
       <item name="Source Repository" href="source-repository.html"/>
       <item name="Continuous Integration" href="integration.html"/>
       <item name="Issue Tracking" href="issue-tracking.html"/>
+      <item name="How to contribute?" href="contributing.html"/>
       <item name="Release Process" href="release-process.html"/>

Copied: incubator/syncope/branches/1_0_X/parent/src/site/xdoc/contributing.xml (from r1411315,
--- incubator/syncope/branches/1_0_X/parent/src/site/xdoc/architecture.xml (original)
+++ incubator/syncope/branches/1_0_X/parent/src/site/xdoc/contributing.xml Wed Nov 21 17:15:26
@@ -22,106 +22,112 @@ under the License.
-    <title>Architecture</title>
+    <title>How to contribute?</title>
     <author email="">Apache Syncope Documentation Team</author>
-    <div class="toc_container">
-      <macro name="toc">
-        <param name="class" value="toc"/>
-      </macro>
-    </div>
-    <section name="Introduction">
+    <section name="How to contribute?">
-        From an high-level point of view, the component architecture of Apache Syncope can
be summarized by following figure.
-        <div style="width:100%; text-align:center; margin:20px;">
-          <img src="images/apache-syncope-architecture.png" alt="Apache Syncope Architecture"
-        </div>
-        Apache Syncope is composed by two main subsystems: 
-        <a href="#The_core">core</a> and 
-        <a href="#The_console">console</a>.
+        The Apache Syncope™ project is actively seeking new contributors to work on
all aspects of the project. 
+        We need and appreciate all contributions, including documentation help, source code
development and feedback.
-    </section>
-    <section name="The core">
-      <p>
-        The web application that implements IdM features; it offers a RESTful interface for
caller applications, implements the provisioning core by mean of its workflow engine and its
propagation layer, manages data persistence.
-      </p>
-      <subsection name="Apache Syncope core logic">
-        <p>
-          This central component orchestrates the whole data flow throughout the system.
-          Gets involved upon RESTful calls, processes data alongside the defined workflow,
propagates to and synchronize from configured external resources, if needed.
-        </p>
+      <subsection name="Code">
+        <ul>
+          <li>When you have found an issue or you want to propose a new feature, post
a message to Syncope User's list to 
+            discuss it.
+          </li>
+          <li>Search existing 
+            <a href="" rel="nofollow">issues</a>
to see whether 
+            someone had already encountered the same issue.
+          </li>
+          <li>If this issue is never encountered before, create a 
+            <a href="">JIRA</a> issue.
+          </li>
+          <li>Develop a test case to demonstrate the issue.</li>
+          <li>Attach the new test to JIRA issue.</li>
+          <li>If you have also developed a fix for the raised issue, attach a patch
to it. Here are some useful 
+            <a href="">guidelines</a>
about how to correctly generate a patch.
+          </li>
+        </ul>
-      <subsection name="RESTful controllers">
-        <p>
-          RESTful controllers take care of the communication with outside world.
-          Implemented by leveraging Spring's REST and MVC features, these controllers exchange
data in both XML and JSON formats.
+      <subsection name="Documentation">
+        <p>The website is managed via the 
+          <a href="">maven-site-plugin</a>,
hence contributing site 
+          content is very close to contributing source code: create a new issue on JIRA and
attach there a SVN patch.
+        </p>
+        <p>The project 
+          <a href="">wiki</a>
is also there to gather any other kind of
+          documentation or contribution you would like to contribute, and does not require
any SVN, Maven or other 
+          technical skills.
-      <subsection name="Workflow engine">
-        <p>
-          Workflow engine is a pluggable aspect of Apache Syncope: this lets every deployment
choose among one of provided engine implementations or define new, custom ones.
-        </p>
-        <p>
-          Default implementation is based on 
-          <a href="" target="_blank">Activiti BPM</a>,
reference Open Source implementation that supports the definition of an XML descriptor in
which user lifecycle is defined.
-          This aspect makes the whole system very flexible to adapt to different situations.
-          <br/>
-          Default implementation also provides notification, approval, and end-user request
-        </p>
-      </subsection>
-      <subsection name="JPA persistence layer">
-        <p>
-          All the data in Apache Syncope (users, roles, attributes, resources, ...) is managed
at an high level with a standard JPA 2.0 approach and persisted to underlying database.
-        </p>
-        <p>
-          <a href="">Apache OpenJPA</a>, the chosen
JPA implementation, makes Apache Syncope to be successfully deployable on most DBMS without
any modification on the source code; in order to have an idea of this possibility, take a
look at 
-          <a href="">available
-          <br/>
-          Currently, Apache Syncope officially supports MySQL, PostgreSQL and Oracle DB.
-        </p>
-      </subsection>
-      <subsection name="Connectors layer">
-        <p>
-          Connector layer is implemented with 
-          <a href="" target="_blank">ConnId</a>;
ConnId is designed to separate the implementation of an application from the dependencies
of the system that the application is attempting to connect to.
-        </p>
-        <p>
-          Connid is the continuation of Identity connectors, a project that used to be part
of the market leader Sun IdM and have been released by Sun as an Open Source project.
-          This makes the connectors layer particularly reliable since most connectors are
already implemented in the framework and widely tested. Lately, the original project has been
forked into the new ConnId project, whose main purpose is to provide all that is required
nowadays for a modern Open Source project: Apache Maven driven build, artifacts and mailing
-          Additional connectors – like as SOAP, CSV  and Active Directory – are
also provided.
-        </p>
-        <p>
-          Apache Syncope supports either
-          <ul>
-            <li>
-              <em>propagation</em> towards external resources (when user data
is copied from Syncope to external resources)
-            </li>
-            <li>
-              <em>synchronization</em> from external resources (when user data
is pulled from external resources into Syncope)
-            </li>
-          </ul>
-          Propagation and synchronization operations – a.k.a tasks – are saved
for reporting and later re-execution.
-        </p>
+      <subsection name="Quick references">
+        <ul>
+          <li>
+            Discussion occurs on the 
+            <a href="mail-lists.html">mailing lists</a>
+          </li>
+          <li>
+            Information on access to the project source code is 
+            <a href="source-repository.html">available</a>.
+          </li>
+          <li>
+            Bugs and other issues can be posted on 
+            <a href="">JIRA</a>
+          </li>
+        </ul>
-    <section name="The console">
-      <p>The web management interface for configuring and administering Syncope core,
implemented with 
-        <a href="http://wicket.apache,org">Apache Wicket</a>
+    <section name="How do I become a contributor or a committer?">
+      <p>Everyone can contribute to Syncope as a contributor; contributors who build
up a history of successful 
+        contributions over time are invited to become committers. The difference is that
committers have direct write 
+        access to the project SVN repositories, while contributors post their contributions
to JIRA issues where they're
+        first reviewed, and then committed by a committer to the project's SVN repository.
+        <a href=""></a>
for a good
+        overview of working as a contributor.
+      </p>
+      <p>We ask contributors of significant amounts of code to fill out and send into
Apache, an 
+        <a href="">Individual Contributors License
Agreement (ICLA)</a> 
+        (and perhaps also a 
+        <a href="">Corporate Contributors License
Agreement (CCLA)</a>).
+      </p>
+      <p>If you're interested in committing to the project, you need to establish a
history over time of successful 
+        contributions to the project. After that, you can be invited to become a committer.
-      <p>Like as other external applications, the console communicates with the core
by REST calls.</p>
+      <ul>
+        <li>
+          You'll need to fill out some legal paperwork and go through a process to get an
apache committer account: See 
+          <a rel="nofollow" href="">
New Committers Guide</a>, 
+          <a rel="nofollow" href=""> Contributors</a>,
+          <a rel="nofollow" href=""> Committers</a>
for more details.
+        </li>
+        <li>
+          After you've received an email from 
+          <a href=""></a> with your committer
account information, change your 
+          initial password at 
+          <a href="">Apache Account Utility</a>. For more
details see 
+          <a rel="nofollow" href="">Committer
Subversion Access</a>.
+        </li>
+        <li>
+          Check out the Syncope sources and test your svn account: 
+          <a href="">Subversion Repository</a>.
+        </li>
+      </ul>
+      <p>All Contributors and Committers should</p>
+      <ul>
+        <li>Sign up for a 
+          <a rel="nofollow" href="">WiKi</a>
+        </li>
+        <li>Sign up for an 
+          <a rel="nofollow" href="">ASF JIRA</a>
+        </li>
+      </ul>

View raw message