You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@syncope.apache.org by il...@apache.org on 2013/01/22 10:26:35 UTC
svn commit: r1436815 - in /syncope/trunk: ./ src/site/site.xml
src/site/xdoc/architecture.xml src/site/xdoc/contributing.xml
src/site/xdoc/index.xml src/site/xdoc/professional-services.xml
src/site/xdoc/release-process.xml
Author: ilgrosso
Date: Tue Jan 22 09:26:34 2013
New Revision: 1436815
URL: http://svn.apache.org/viewvc?rev=1436815&view=rev
Log:
[SYNCOPE-283] Merge from 1_0_X
Modified:
syncope/trunk/ (props changed)
syncope/trunk/src/site/site.xml
syncope/trunk/src/site/xdoc/architecture.xml
syncope/trunk/src/site/xdoc/contributing.xml
syncope/trunk/src/site/xdoc/index.xml
syncope/trunk/src/site/xdoc/professional-services.xml
syncope/trunk/src/site/xdoc/release-process.xml
Propchange: syncope/trunk/
------------------------------------------------------------------------------
Merged /syncope/branches/1_0_X:r1435070-1436812
Modified: syncope/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/syncope/trunk/src/site/site.xml?rev=1436815&r1=1436814&r2=1436815&view=diff
==============================================================================
--- syncope/trunk/src/site/site.xml (original)
+++ syncope/trunk/src/site/site.xml Tue Jan 22 09:26:34 2013
@@ -46,7 +46,7 @@ under the License.
</twitter>
<ohloh>
<projectId>syncope</projectId>
- <widget>factoids</widget>
+ <widget>thin-badge</widget>
</ohloh>
</fluidoSkin>
</custom>
Modified: syncope/trunk/src/site/xdoc/architecture.xml
URL: http://svn.apache.org/viewvc/syncope/trunk/src/site/xdoc/architecture.xml?rev=1436815&r1=1436814&r2=1436815&view=diff
==============================================================================
--- syncope/trunk/src/site/xdoc/architecture.xml (original)
+++ syncope/trunk/src/site/xdoc/architecture.xml Tue Jan 22 09:26:34 2013
@@ -36,7 +36,8 @@ under the License.
<section name="Introduction">
<p>
- From an high-level point of view, the component architecture of Apache Syncope can be summarized by following figure.
+ From a high-level point of view, the component architecture of Apache Syncope can be summarized by the following
+ figure:
<div style="width:100%; text-align:center; margin:20px;">
<img src="images/apache-syncope-architecture.png" alt="Apache Syncope Architecture" width="600px"/>
</div>
@@ -48,67 +49,84 @@ under the License.
<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.
+ 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, and 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.
+ Handles RESTful calls, processes data alongside the defined workflow and propagates to and synchronizes from
+ configured external resources (if needed).
</p>
</subsection>
<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.
+ RESTful controllers take care of communication with outside world.
+ Implemented by leveraging Spring's REST and MVC features, these controllers exchange data in both XML and JSON
+ formats.
</p>
</subsection>
<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.
+ The 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="http://www.activiti.org" target="_blank">Activiti BPM</a>, reference Open Source implementation that supports the definition of an XML descriptor in which user lifecycle is defined.
+ The default implementation is based on
+ <a href="http://www.activiti.org" target="_blank">Activiti BPM</a>, the reference Open Source implementation
+ that supports the definition of an XML descriptor in which the 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 management.
+ The default implementation also provides notification, approval, and end-user request management.
</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.
+ All data in Apache Syncope (users, roles, attributes, resources, ...) is managed at a high level using a
+ standard JPA 2.0 approach and persisted to an underlying database.
</p>
<p>
- <a href="http://openjpa.apache.org">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="http://openjpa.apache.org">Apache OpenJPA</a>, the chosen JPA implementation, allows Apache Syncope
+ to be successfully deployable to most DBMSs without any modification of the source code; for more information,
+ see these
<a href="http://openjpa.apache.org/builds/latest/docs/docbook/manual/ref_guide_dbsetup_dbsupport.html">available options</a>.
<br/>
- Currently, Apache Syncope officially supports MySQL, PostgreSQL and Oracle DB.
+ Currently, Apache Syncope officially supports MySQL, PostgreSQL, Oracle DB and MS SQL Server.
</p>
</subsection>
<subsection name="Connectors layer">
<p>
- Connector layer is implemented with
- <a href="http://connid.googlecode.com" 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.
+ The Connector layer is implemented with
+ <a href="http://tirasa.github.com/ConnId/" 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 lists.
- Additional connectors â like as SOAP, CSV and Active Directory â are also provided.
+ Connid is the continuation of Identity connectors, a project that used to be part of market leader Sun IdM
+ and has since been released by Sun as an Open Source project.
+ This makes the connectors layer particularly reliable since most connectors have already been implemented in
+ the framework and widely tested.
+ The new ConnId project provides all that is required nowadays for a modern Open Source project, including an
+ Apache Maven driven build, artifacts and mailing lists.
+ Additional connectors â such as for 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)
+ <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)
+ <em>synchronization</em> from external resources (when user data is pulled from external resources into
+ Syncope)
</li>
</ul>
@@ -121,7 +139,7 @@ under the License.
<p>The web management interface for configuring and administering Syncope core, implemented with
<a href="http://wicket.apache,org">Apache Wicket</a>
</p>
- <p>Like as other external applications, the console communicates with the core by REST calls.</p>
+ <p>As with other external applications, the console communicates with the core using REST calls.</p>
</section>
</body>
</document>
Modified: syncope/trunk/src/site/xdoc/contributing.xml
URL: http://svn.apache.org/viewvc/syncope/trunk/src/site/xdoc/contributing.xml?rev=1436815&r1=1436814&r2=1436815&view=diff
==============================================================================
--- syncope/trunk/src/site/xdoc/contributing.xml (original)
+++ syncope/trunk/src/site/xdoc/contributing.xml Tue Jan 22 09:26:34 2013
@@ -36,18 +36,18 @@ under the License.
<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>If you have found an issue or you want to propose a new feature, post a message to the
+ <a href="mail-lists.html">Syncope User's list</a> to discuss it.
</li>
<li>Search existing
- <a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa" rel="nofollow">issues</a> to see whether
- someone had already encountered the same issue.
+ <a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa" 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
+ <li>If this issue was never encountered before, create a new
<a href="http://issues.apache.org/jira/browse/SYNCOPE">JIRA</a> issue.
</li>
- <li>Develop a test case to demonstrate the issue.</li>
- <li>Attach the new test to JIRA issue.</li>
+ <li>Develop / describe a test case to demonstrate the issue.</li>
+ <li>Attach the new test to the 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="https://commons.apache.org/patches.html">guidelines</a> about how to correctly generate a patch.
</li>
@@ -57,12 +57,12 @@ under the License.
<subsection name="Documentation">
<p>The website is managed via the
<a href="http://maven.apache.org/plugins/maven-site-plugin/">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.
+ content is similar to contributing source code: Create a new issue on JIRA and attach an SVN patch to it.
</p>
<p>The project
- <a href="http://cwiki.apache.org/confluence/display/SYNCOPE">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.
+ <a href="http://cwiki.apache.org/confluence/display/SYNCOPE">Wiki</a> is also available 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.
</p>
</subsection>
@@ -73,8 +73,8 @@ under the License.
<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>.
+ Information on accessing the project source code is
+ <a href="source-repository.html">here</a>.
</li>
<li>
Bugs and other issues can be posted on
@@ -98,11 +98,11 @@ under the License.
<a href="http://www.apache.org/licenses/#clas">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.
+ contributions to the project. After that, you may be invited to become a committer.
</p>
<ul>
<li>
- You'll need to fill out some legal paperwork and go through a process to get an apache committer account: See
+ 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="http://apache.org/dev/new-committers-guide.html"> New Committers Guide</a>,
<a rel="nofollow" href="http://apache.org/dev/contributors.html"> Contributors</a>, and
<a rel="nofollow" href="http://apache.org/dev/committers.html"> Committers</a> for more details.
@@ -110,19 +110,19 @@ under the License.
<li>
After you've received an email from
<a href="mailto:root@apache.org">root@apache.org</a> with your committer account information, change your
- initial password at
+ initial password using the
<a href="https://id.apache.org">Apache Account Utility</a>. For more details see
<a rel="nofollow" href="http://apache.org/dev/version-control.html">Committer Subversion Access</a>.
</li>
<li>
- Check out the Syncope sources and test your svn account:
+ Test your SVN account by checking out the Syncope sources:
<a href="http://svn.apache.org/viewvc/syncope/">Subversion Repository</a>.
</li>
</ul>
- <p>All Contributors and Committers should</p>
+ <p>All Committers and Contributors should:</p>
<ul>
<li>Sign up for a
- <a rel="nofollow" href="https://cwiki.apache.org/confluence/signup.action">WiKi</a> account.
+ <a rel="nofollow" href="https://cwiki.apache.org/confluence/signup.action">Wiki</a> account.
</li>
<li>Sign up for an
<a rel="nofollow" href="http://issues.apache.org/jira/">ASF JIRA</a> account.
Modified: syncope/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/syncope/trunk/src/site/xdoc/index.xml?rev=1436815&r1=1436814&r2=1436815&view=diff
==============================================================================
--- syncope/trunk/src/site/xdoc/index.xml (original)
+++ syncope/trunk/src/site/xdoc/index.xml Tue Jan 22 09:26:34 2013
@@ -41,7 +41,7 @@ under the License.
<p>
<span style="font-weight: bold">Identity management</span> (or IdM) represents the joint result of business process and IT to manage user data on systems
and applications. IdM involves considering user attributes, roles, resources and entitlements in trying to give a
- decent answer to the question bumping at every time in IT administratorsâ mind:
+ decent answer to the question bumping up every time in an IT administrator's mind:
</p>
<p style="text-align:center;">
Modified: syncope/trunk/src/site/xdoc/professional-services.xml
URL: http://svn.apache.org/viewvc/syncope/trunk/src/site/xdoc/professional-services.xml?rev=1436815&r1=1436814&r2=1436815&view=diff
==============================================================================
--- syncope/trunk/src/site/xdoc/professional-services.xml (original)
+++ syncope/trunk/src/site/xdoc/professional-services.xml Tue Jan 22 09:26:34 2013
@@ -28,7 +28,7 @@ under the License.
<body>
<section name="Professional Services">
- These companies provide professional services around Apache Syncope (sorted by alphabetical order):
+ The following companies provide professional services around Apache Syncope (in alphabetical order):
<ul>
<li><a href="http://syncope.tirasa.net">Tirasa</a></li>
</ul>
Modified: syncope/trunk/src/site/xdoc/release-process.xml
URL: http://svn.apache.org/viewvc/syncope/trunk/src/site/xdoc/release-process.xml?rev=1436815&r1=1436814&r2=1436815&view=diff
==============================================================================
--- syncope/trunk/src/site/xdoc/release-process.xml (original)
+++ syncope/trunk/src/site/xdoc/release-process.xml Tue Jan 22 09:26:34 2013
@@ -34,7 +34,7 @@ under the License.
</div>
<section name="Introduction">
- <p>The Syncope team is using the
+ <p>The Syncope team uses the
<a href="http://repository.apache.org">Apache Nexus repository</a> for releasing SNAPSHOT and release artifacts.
More details on releasing artifacts and using Nexus can be found on the Maven website at
<a href="http://maven.apache.org/developers/release/apache-release.html">http://maven.apache.org/developers/release/apache-release.html</a>.
@@ -51,12 +51,11 @@ under the License.
</subsection>
<subsection name="Apache Maven">
- <p>Install Apache Maven 3.0.3 or higher; we strongly
- encourage our committers to install
+ <p>Install Apache Maven 3.0.3 or higher; we strongly encourage our committers to install
<a href="http://maven.apache.org/download.html">Apache Maven 3.0.4</a>.
</p>
- <p>As of Maven 2.1.0 you can now encrypt your servers passwords. We highly recommend that you follow this
+ <p>Maven allows you to encrypt your servers' passwords. We highly recommend that you follow this
<a href="http://maven.apache.org/guides/mini/guide-encryption.html">guide</a> to set your master password and
use it to encrypt your ASF password in the next section.
</p>
@@ -197,12 +196,12 @@ pass <tt>-Dweblogic.home=...</tt> to Mav
</li>
<li>
Update the <a href="downloads.html">downloads</a> site page by adding the new release artifacts with base
- URL <source>http://www.apache.org/dyn/closer.cgi/syncope/<version>/</source>
- and by moving current release artifacts to 'Older Releases' section, also changing base URL to
+ URL <source>http://www.apache.org/dyn/closer.cgi/syncope/<version>/</source>,
+ moving current release artifacts to 'Older Releases' section and changing base URL to
<source>http://archive.apache.org/dist/syncope/</source>
</li>
<li>
- Commit any changes back to svn:
+ Commit any changes back to SVN:
<source>svn commit -m "updating files for release"</source>
</li>
<li>
@@ -229,7 +228,7 @@ pass <tt>-Dweblogic.home=...</tt> to Mav
<source>mvn -P apache-release release:branch -DbranchName=1_0_X</source>
</li>
<li>
- Checkout a clean copy of the trunk/branch to release using command line svn:
+ Checkout a clean copy of the trunk/branch to release using command line SVN:
<source>svn checkout https://svn.apache.org/repos/asf/syncope/trunk/ release</source>
</li>
</ol>