Sakai Training Environment

Purpose

Part of the Sakai 2.2 release was the re-organization of the source tree. Besides doing away with the "legacy" classification of many of the framework services, it allows tools and services to be easily grouped into new distributions using the subversion externals feature.

The Sakai Training Environment was created to be a minimal, but fairly complete Sakai development environment to support hands-on, code development workshops. It is the successor to the Sakai Kernel Bundle that has been used successfully in several workshops during 2005 and 2006.

Composition

The Sakai Training environment is intended to be a solid development framework that allows non-toy Sakai tools to be built. Since the emphasis is on development, all of the high level tools and the Charon portal are not included in this distribution. Some of the support tools like login and admin are included to make some tasks simpler.

The Sakai Training distribution (https://source.sakaiproject.org/svn/sakai/branches/sakai_training/) currently consists of the following modules:

Module Name	Action	Notes
access	Remove	RDF access tool
alias/alias-api	Keep	Resource aliases
alias/alias-impl	Keep	Resource aliases
alias/alias-tool	Remove	Alias admin tool
authz/authz-api	Keep	Security and AuthzGroups
authz/authz-impl	Keep	Security and AuthzGroups
auth/authz-tool	Remove	AuthzGroups admin tool
component	Keep	Component manager
content/content-api	Keep	Content Hosting
content/content-impl	Keep	Content Hosting
content/content-tool	Remove	Resource tool
courier	Remove	Courier and presence
course-management	Keep	Course mgmt
db	Keep	Database and Hibernate
email	Keep	Email notification - entity dependency
entity	Keep	Entity bus
event	Keep	Events and notification - db dependency
jsf	Keep	JavaServer Faces
login	Keep	Login helper
master	Keep	Master Maven files
memory/memory-api	Keep	Memory Management
memory/memory-impl	Keep	Memory Management
memory/memory-tool	Remove	Memory Management admin tool
metaobj	Remove	Structured content support
portal/portal-charon	Remove	Full sakai portal
portal/portal-mercury	Keep	Developer portal
portal/portal-impl	Keep	???
portal/portal-util	Keep	Portal utilities
reference/docs	Keep	Documentation
reference/library	Keep	Library of resources
reference/license	Remove	Full Sakai licenses
reference/demo	Remove	Demo tools.
site/site-api	Keep	Site service
site/site-impl	Keep	Site service
site/site-tool	Remove	Site admin tool
test-harness	Remove	Unit testing support
tool	Keep	Tool manager
user/user-api	Keep	User Directory Service
user/user-impl	Keep	User Directory Service
user/user-tool	Remove	User admin tool
user/user-tool-admin-prefs	Remove	User admin preferences tool
user/user-tool-prefs	Remove	User tool preferences tool
user/user-util	Keep	User Directory Service
util	Keep	Various utilities
velocity	Remove	Velocity template support

and the following files:

.externals
ECLv1.txt
maven.xml
project.xml

Subversion Procedure

The following steps should taken to update the sakai_training environment:

cd sakai_training
edit .externals (make any needed changes)
svn propset -F .externals svn:externals . (updates property settings)
svn ci -m "message here" .externals
svn ci -m "message here" .

To add a new module to an externals based distribution:

cd sakai_training
edit .externals (add new module reference)
svn propset -F .externals svn:externals . (updates property settings)
svn ci -m "message here" .externals
cd ..
svn co https://source.sakaiproject.org/svn/sakai/branches/sakai_training